This commit is contained in:
RubenVerborgh
2021-01-05 10:10:37 +00:00
parent d307fb5e6d
commit 3b61263474
346 changed files with 2090 additions and 2166 deletions

View File

@@ -71,7 +71,7 @@
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Extracts preferences from the accept-* headers from an incoming <a href="../modules/server_httprequest.html#httprequest">HttpRequest</a>.
<p>Extracts preferences from the Accept-* headers from an incoming <a href="../modules/server_httprequest.html#httprequest">HttpRequest</a>.
Supports Accept, Accept-Charset, Accept-Encoding, Accept-Language and Accept-DateTime.</p>
</div>
</div>
@@ -105,7 +105,6 @@
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ldp_http_acceptpreferenceparser.acceptpreferenceparser.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="ldp_http_acceptpreferenceparser.acceptpreferenceparser.html#handle" class="tsd-kind-icon">handle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="ldp_http_acceptpreferenceparser.acceptpreferenceparser.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="ldp_http_acceptpreferenceparser.acceptpreferenceparser.html#parseheader" class="tsd-kind-icon">parse<wbr>Header</a></li>
</ul>
</section>
</div>
@@ -123,9 +122,6 @@
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="ldp_http_preferenceparser.preferenceparser.html">PreferenceParser</a>.<a href="ldp_http_preferenceparser.preferenceparser.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/15d1ae1/src/ldp/http/AcceptPreferenceParser.ts#L17">src/ldp/http/AcceptPreferenceParser.ts:17</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="ldp_http_acceptpreferenceparser.acceptpreferenceparser.html" class="tsd-signature-type" data-tsd-kind="Class">AcceptPreferenceParser</a></h4>
</li>
@@ -145,7 +141,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="ldp_http_preferenceparser.preferenceparser.html">PreferenceParser</a>.<a href="ldp_http_preferenceparser.preferenceparser.html#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/15d1ae1/src/util/AsyncHandler.ts#L13">src/util/AsyncHandler.ts:13</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ba5c620/src/util/AsyncHandler.ts#L13">src/util/AsyncHandler.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -172,20 +168,20 @@
<a name="handle" class="tsd-anchor"></a>
<h3>handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../modules/util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ldp_representation_representationpreferences.representationpreferences.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreferences</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../modules/util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ldp_representation_representationpreferences.representationpreferences.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreferences</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="ldp_http_preferenceparser.preferenceparser.html">PreferenceParser</a>.<a href="ldp_http_preferenceparser.preferenceparser.html#handle">handle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/15d1ae1/src/ldp/http/AcceptPreferenceParser.ts#L22">src/ldp/http/AcceptPreferenceParser.ts:22</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ba5c620/src/ldp/http/AcceptPreferenceParser.ts#L30">src/ldp/http/AcceptPreferenceParser.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <a href="../modules/util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">&gt;</span></h5>
<h5>__namedParameters: <a href="../modules/util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ldp_representation_representationpreferences.representationpreferences.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreferences</a><span class="tsd-signature-symbol">&gt;</span></h4>
@@ -203,7 +199,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="ldp_http_preferenceparser.preferenceparser.html">PreferenceParser</a>.<a href="ldp_http_preferenceparser.preferenceparser.html#handlesafe">handleSafe</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/15d1ae1/src/util/AsyncHandler.ts#L33">src/util/AsyncHandler.ts:33</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ba5c620/src/util/AsyncHandler.ts#L33">src/util/AsyncHandler.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -227,62 +223,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="parseheader" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> parse<wbr>Header</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">parse<wbr>Header<span class="tsd-signature-symbol">(</span>parseFunction<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/util_headerutil.acceptheader.html" class="tsd-signature-type" data-tsd-kind="Interface">AcceptHeader</a><span class="tsd-signature-symbol">[]</span>, input<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_representationpreference.representationpreference.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreference</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/15d1ae1/src/ldp/http/AcceptPreferenceParser.ts#L53">src/ldp/http/AcceptPreferenceParser.ts:53</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts a header string using the given parse function to <a href="../interfaces/ldp_representation_representationpreference.representationpreference.html">RepresentationPreference</a>[].</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parseFunction: <span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/util_headerutil.acceptheader.html" class="tsd-signature-type" data-tsd-kind="Interface">AcceptHeader</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>Function that converts header string to <a href="../interfaces/util_headerutil.acceptheader.html">AcceptHeader</a>.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/util_headerutil.acceptheader.html" class="tsd-signature-type" data-tsd-kind="Interface">AcceptHeader</a><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/util_headerutil.acceptheader.html" class="tsd-signature-type" data-tsd-kind="Interface">AcceptHeader</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> input: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Input header string.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ldp_representation_representationpreference.representationpreference.html" class="tsd-signature-type" data-tsd-kind="Interface">RepresentationPreference</a><span class="tsd-signature-symbol">[]</span></h4>
<p>A list of <a href="../interfaces/ldp_representation_representationpreference.representationpreference.html">RepresentationPreference</a>. Returns an empty list if input was not defined.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -315,9 +255,6 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="ldp_http_acceptpreferenceparser.acceptpreferenceparser.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="ldp_http_acceptpreferenceparser.acceptpreferenceparser.html#parseheader" class="tsd-kind-icon">parse<wbr>Header</a>
</li>
</ul>
</li>
</ul>
@@ -351,9 +288,6 @@
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
</div>
</div>
</footer>