Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: c469df2ebb

Browse Source
This commit is contained in:
RubenVerborgh
2021-01-15 14:44:45 +00:00
parent 7b5f76302d
commit 0b926a3457
496 changed files with 4141 additions and 4155 deletions
Download Patch File Download Diff File Expand all files Collapse all files

96
docs/classes/index.dataaccessorbasedstore.html
View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>DataAccessorBasedStore | Community Solid Server - v0.4.1</title>
<meta name="description" content="Documentation for Community Solid Server - v0.4.1">
<title>DataAccessorBasedStore | Community Solid Server - v0.5.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.5.0">
<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.1</a>
<a href="../index.html" class="title">Community Solid Server - v0.5.0</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.1</a>
<a href="../modules.html">Community Solid Server - v0.5.0</a>
</li>
<li>
<a href="../modules/index.html">index</a>
@@ -137,7 +137,6 @@
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="index.dataaccessorbasedstore.html#getsafenormalizedmetadata" class="tsd-kind-icon">get<wbr>Safe<wbr>Normalized<wbr>Metadata</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="index.dataaccessorbasedstore.html#handlecontainerdata" class="tsd-kind-icon">handle<wbr>Container<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="index.dataaccessorbasedstore.html#hascontainertype" class="tsd-kind-icon">has<wbr>Container<wbr>Type</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="index.dataaccessorbasedstore.html#isexistingcontainer" class="tsd-kind-icon">is<wbr>Existing<wbr>Container</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="index.dataaccessorbasedstore.html#isnewcontainer" class="tsd-kind-icon">is<wbr>New<wbr>Container</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="index.dataaccessorbasedstore.html#isrootstorage" class="tsd-kind-icon">is<wbr>Root<wbr>Storage</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="index.dataaccessorbasedstore.html#modifyresource" class="tsd-kind-icon">modify<wbr>Resource</a></li>
@@ -161,7 +160,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L54">src/storage/DataAccessorBasedStore.ts:54</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L54">src/storage/DataAccessorBasedStore.ts:54</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -186,7 +185,7 @@
<div class="tsd-signature tsd-kind-icon">accessor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/storage_accessors_dataaccessor.dataaccessor.html" class="tsd-signature-type" data-tsd-kind="Interface">DataAccessor</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L53">src/storage/DataAccessorBasedStore.ts:53</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L53">src/storage/DataAccessorBasedStore.ts:53</a></li>
</ul>
</aside>
</section>
@@ -196,7 +195,7 @@
<div class="tsd-signature tsd-kind-icon">identifier<wbr>Strategy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/util_identifiers_identifierstrategy.identifierstrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierStrategy</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L54">src/storage/DataAccessorBasedStore.ts:54</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L54">src/storage/DataAccessorBasedStore.ts:54</a></li>
</ul>
</aside>
</section>
@@ -213,7 +212,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L80">src/storage/DataAccessorBasedStore.ts:80</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L83">src/storage/DataAccessorBasedStore.ts:83</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -239,7 +238,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L356">src/storage/DataAccessorBasedStore.ts:356</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L373">src/storage/DataAccessorBasedStore.ts:373</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -271,7 +270,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L287">src/storage/DataAccessorBasedStore.ts:287</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L319">src/storage/DataAccessorBasedStore.ts:319</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -315,13 +314,18 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L274">src/storage/DataAccessorBasedStore.ts:274</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L306">src/storage/DataAccessorBasedStore.ts:306</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generates a new URI for a resource in the given container, potentially using the given slug.</p>
</div>
<p>Solid, §5.3: &quot;Servers MUST allow creating new resources with a POST request to URI path ending <code>/</code>.
Servers MUST create a resource with URI path ending <code>/{id}</code> in container <code>/</code>.
Servers MUST create a container with URI path ending <code>/{id}/</code> in container <code>/</code> for requests
including the HTTP Link header with rel=&quot;type&quot; targeting a valid LDP container type.&quot;
<a href="https://solid.github.io/specification/protocol#writing-resources">https://solid.github.io/specification/protocol#writing-resources</a></p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
@@ -358,7 +362,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L138">src/storage/DataAccessorBasedStore.ts:138</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L152">src/storage/DataAccessorBasedStore.ts:152</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -381,16 +385,17 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L172">src/storage/DataAccessorBasedStore.ts:172</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L192">src/storage/DataAccessorBasedStore.ts:192</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the metadata matching the identifier, ignoring the presence of a trailing slash or not.
This is used to support the following part of the spec:
&quot;If two URIs differ only in the trailing slash, and the server has associated a resource with one of them,
then the other URI MUST NOT correspond to another resource.&quot;</p>
<p>Returns the metadata matching the identifier, ignoring the presence of a trailing slash or not.</p>
</div>
<p>Solid, §3.1: &quot;If two URIs differ only in the trailing slash,
and the server has associated a resource with one of them,
then the other URI MUST NOT correspond to another resource.&quot;
<a href="https://solid.github.io/specification/protocol#uri-slash-semantics">https://solid.github.io/specification/protocol#uri-slash-semantics</a></p>
<p>First the identifier gets requested and if no result is found
the identifier with differing trailing slash is requested.</p>
</div>
@@ -417,7 +422,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L61">src/storage/DataAccessorBasedStore.ts:61</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L61">src/storage/DataAccessorBasedStore.ts:61</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -440,7 +445,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L190">src/storage/DataAccessorBasedStore.ts:190</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L212">src/storage/DataAccessorBasedStore.ts:212</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -468,7 +473,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L237">src/storage/DataAccessorBasedStore.ts:237</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L262">src/storage/DataAccessorBasedStore.ts:262</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -500,7 +505,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L340">src/storage/DataAccessorBasedStore.ts:340</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L357">src/storage/DataAccessorBasedStore.ts:357</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -518,38 +523,6 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="isexistingcontainer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>Existing<wbr>Container</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">is<wbr>Existing<wbr>Container<span class="tsd-signature-symbol">(</span>metadata<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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/409782c/src/storage/DataAccessorBasedStore.ts#L329">src/storage/DataAccessorBasedStore.ts:329</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if the given metadata represents a container, purely based on metadata type triples.
Since type metadata always gets generated when writing resources this should never fail on stored resources.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>metadata: <a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5>
<div class="tsd-comment tsd-typography">
<p>Metadata to check.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="isnewcontainer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>New<wbr>Container</h3>
@@ -560,7 +533,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L314">src/storage/DataAccessorBasedStore.ts:314</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L346">src/storage/DataAccessorBasedStore.ts:346</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -598,7 +571,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L347">src/storage/DataAccessorBasedStore.ts:347</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L364">src/storage/DataAccessorBasedStore.ts:364</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -626,7 +599,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L134">src/storage/DataAccessorBasedStore.ts:134</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L148">src/storage/DataAccessorBasedStore.ts:148</a></li>
</ul>
</aside>
<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>
@@ -643,7 +616,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L107">src/storage/DataAccessorBasedStore.ts:107</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L118">src/storage/DataAccessorBasedStore.ts:118</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -669,7 +642,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L156">src/storage/DataAccessorBasedStore.ts:156</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L174">src/storage/DataAccessorBasedStore.ts:174</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -697,7 +670,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/409782c/src/storage/DataAccessorBasedStore.ts#L209">src/storage/DataAccessorBasedStore.ts:209</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/storage/DataAccessorBasedStore.ts#L231">src/storage/DataAccessorBasedStore.ts:231</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -796,9 +769,6 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="index.dataaccessorbasedstore.html#hascontainertype" class="tsd-kind-icon">has<wbr>Container<wbr>Type</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="index.dataaccessorbasedstore.html#isexistingcontainer" class="tsd-kind-icon">is<wbr>Existing<wbr>Container</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="index.dataaccessorbasedstore.html#isnewcontainer" class="tsd-kind-icon">is<wbr>New<wbr>Container</a>
</li>