mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
deploy: 409782c205
This commit is contained in:
RubenVerborgh
@@ -3,8 +3,8 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>BasicMetadataExtractor | Community Solid Server - v0.4.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.4.0">
|
||||
<title>BasicMetadataExtractor | 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_metadata_basicmetadataextractor.html">ldp/http/metadata/BasicMetadataExtractor</a>
|
||||
@@ -128,7 +128,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ldp_http_metadata_metadataextractor.metadataextractor.html">MetadataExtractor</a>.<a href="ldp_http_metadata_metadataextractor.metadataextractor.html#constructor">constructor</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/867af28/src/ldp/http/metadata/BasicMetadataExtractor.ts#L10">src/ldp/http/metadata/BasicMetadataExtractor.ts:10</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/ldp/http/metadata/BasicMetadataExtractor.ts#L11">src/ldp/http/metadata/BasicMetadataExtractor.ts:11</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -150,7 +150,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">parsers<span class="tsd-signature-symbol">:</span> <a href="../interfaces/ldp_http_metadata_metadataparser.metadataparser.html" class="tsd-signature-type" data-tsd-kind="Interface">MetadataParser</a><span class="tsd-signature-symbol">[]</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/867af28/src/ldp/http/metadata/BasicMetadataExtractor.ts#L10">src/ldp/http/metadata/BasicMetadataExtractor.ts:10</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/ldp/http/metadata/BasicMetadataExtractor.ts#L11">src/ldp/http/metadata/BasicMetadataExtractor.ts:11</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -161,14 +161,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"><</span><span class="tsd-signature-type">IncomingMessage</span><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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ldp_http_metadata_metadataextractor.metadataextractor.html">MetadataExtractor</a>.<a href="ldp_http_metadata_metadataextractor.metadataextractor.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">
|
||||
@@ -180,14 +180,22 @@
|
||||
<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"><</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">></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>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</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>
|
||||
<li class="tsd-parameter">
|
||||
<h5>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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>
|
||||
@@ -195,20 +203,28 @@
|
||||
<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>request<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"><</span><span class="tsd-signature-type">IncomingMessage</span><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"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></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>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</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"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides <a href="ldp_http_metadata_metadataextractor.metadataextractor.html">MetadataExtractor</a>.<a href="ldp_http_metadata_metadataextractor.metadataextractor.html#handle">handle</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/867af28/src/ldp/http/metadata/BasicMetadataExtractor.ts#L17">src/ldp/http/metadata/BasicMetadataExtractor.ts:17</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/ldp/http/metadata/BasicMetadataExtractor.ts#L18">src/ldp/http/metadata/BasicMetadataExtractor.ts:18</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>request: <a href="../modules/util_guardedstream.html#guarded" class="tsd-signature-type" data-tsd-kind="Type alias">Guarded</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">></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>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</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>
|
||||
<li class="tsd-parameter">
|
||||
<h5>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span></h4>
|
||||
@@ -219,14 +235,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"><</span><span class="tsd-signature-type">IncomingMessage</span><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"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></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>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</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"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="ldp_http_metadata_metadataextractor.metadataextractor.html">MetadataExtractor</a>.<a href="ldp_http_metadata_metadataextractor.metadataextractor.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">
|
||||
@@ -239,14 +255,23 @@
|
||||
<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"><</span><span class="tsd-signature-type">IncomingMessage</span><span class="tsd-signature-symbol">></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>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</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>
|
||||
<li class="tsd-parameter">
|
||||
<h5>target<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></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>
|
||||
|
||||
Reference in New Issue
Block a user