This commit is contained in:
RubenVerborgh
2021-01-13 09:45:11 +00:00
parent fb9f2ac7c0
commit 7b5f76302d
495 changed files with 9371 additions and 4804 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AcceptPreferenceParser | Community Solid Server - v0.4.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.4.0">
<title>AcceptPreferenceParser | Community Solid Server - v0.4.1</title>
<meta name="description" content="Documentation for Community Solid Server - v0.4.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Community Solid Server - v0.4.0</a>
<a href="../index.html" class="title">Community Solid Server - v0.4.1</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v0.4.0</a>
<a href="../modules.html">Community Solid Server - v0.4.1</a>
</li>
<li>
<a href="../modules/ldp_http_acceptpreferenceparser.html">ldp/http/AcceptPreferenceParser</a>
@@ -134,14 +134,14 @@
<a name="canhandle" class="tsd-anchor"></a>
<h3>can<wbr>Handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">can<wbr>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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a><span class="tsd-signature-symbol"> }</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<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#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/867af28/src/util/AsyncHandler.ts#L13">src/util/AsyncHandler.ts:13</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/util/AsyncHandler.ts#L13">src/util/AsyncHandler.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -153,14 +153,19 @@
<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>input: <span class="tsd-signature-symbol">{ </span>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that would be handled potentially.</p>
<p>Input data that could potentially be handled.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a></h5>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A promise resolving if this input can be handled, rejecting with an Error if not.</p>
<p>A promise resolving if the input can be handled, rejecting with an Error if not.</p>
</li>
</ul>
</section>
@@ -168,20 +173,25 @@
<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>__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>
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a><span class="tsd-signature-symbol"> }</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/867af28/src/ldp/http/AcceptPreferenceParser.ts#L30">src/ldp/http/AcceptPreferenceParser.ts:30</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/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>__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>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a></h5>
</li>
</ul>
</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>
@@ -192,14 +202,14 @@
<a name="handlesafe" class="tsd-anchor"></a>
<h3>handle<wbr>Safe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>data<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<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a><span class="tsd-signature-symbol"> }</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>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/867af28/src/util/AsyncHandler.ts#L33">src/util/AsyncHandler.ts:33</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/util/AsyncHandler.ts#L35">src/util/AsyncHandler.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -212,14 +222,20 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <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>input: <span class="tsd-signature-symbol">{ </span>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>The data to handle.</p>
<p>Input data that will be handled if it can be handled.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>request<span class="tsd-signature-symbol">: </span><a href="../modules/server_httprequest.html#httprequest" class="tsd-signature-type" data-tsd-kind="Type alias">HttpRequest</a></h5>
</li>
</ul>
</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>
<p>The result of the handle function of the handler.</p>
<p>A promise resolving if the input can be handled, rejecting with an Error if not.
Return value depends on the given type.</p>
</li>
</ul>
</section>