This commit is contained in:
RubenVerborgh
2021-06-29 16:54:45 +00:00
parent e1e35a84d0
commit 8591fda008
525 changed files with 12756 additions and 8659 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>util/ResourceUtil | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<title>util/ResourceUtil | Community Solid Server - v1.0.0-beta.0</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.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.9.0</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.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.9.0</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.0</a>
</li>
<li>
<a href="util_resourceutil.html">util/ResourceUtil</a>
@@ -72,9 +72,8 @@
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_resourceutil.html#addresourcemetadata" class="tsd-kind-icon">add<wbr>Resource<wbr>Metadata</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_resourceutil.html#clonerepresentation" class="tsd-kind-icon">clone<wbr>Representation</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_resourceutil.html#generatecontainmentquads" class="tsd-kind-icon">generate<wbr>Containment<wbr>Quads</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_resourceutil.html#generateresourcequads" class="tsd-kind-icon">generate<wbr>Resource<wbr>Quads</a></li>
</ul>
</section>
</div>
@@ -82,6 +81,44 @@
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="addresourcemetadata" class="tsd-anchor"></a>
<h3>add<wbr>Resource<wbr>Metadata</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">add<wbr>Resource<wbr>Metadata<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="../classes/ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a>, isContainer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/d01382d/src/util/ResourceUtil.ts#L16">src/util/ResourceUtil.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Helper function to generate type quads for a Container or Resource.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>metadata: <a href="../classes/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 add to.</p>
</div>
</li>
<li>
<h5>isContainer: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>If the identifier corresponds to a container.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
<p>The generated quads.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="clonerepresentation" class="tsd-anchor"></a>
<h3>clone<wbr>Representation</h3>
@@ -92,7 +129,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/ResourceUtil.ts#L49">src/util/ResourceUtil.ts:49</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/util/ResourceUtil.ts#L31">src/util/ResourceUtil.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -115,89 +152,13 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="generatecontainmentquads" class="tsd-anchor"></a>
<h3>generate<wbr>Containment<wbr>Quads</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">generate<wbr>Containment<wbr>Quads<span class="tsd-signature-symbol">(</span>containerURI<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NamedNode</span>, childURIs<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><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Quad</span><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/0a68fbf/src/util/ResourceUtil.ts#L37">src/util/ResourceUtil.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Helper function to generate the quads describing that the resource URIs are children of the container URI.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>containerURI: <span class="tsd-signature-type">NamedNode</span></h5>
<div class="tsd-comment tsd-typography">
<p>The URI of the container.</p>
</div>
</li>
<li>
<h5>childURIs: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>The URI of the child resources.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">[]</span></h4>
<p>The generated quads.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="generateresourcequads" class="tsd-anchor"></a>
<h3>generate<wbr>Resource<wbr>Quads</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">generate<wbr>Resource<wbr>Quads<span class="tsd-signature-symbol">(</span>subject<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NamedNode</span>, isContainer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Quad</span><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/0a68fbf/src/util/ResourceUtil.ts#L19">src/util/ResourceUtil.ts:19</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Helper function to generate type quads for a Container or Resource.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>subject: <span class="tsd-signature-type">NamedNode</span></h5>
<div class="tsd-comment tsd-typography">
<p>Subject for the new quads.</p>
</div>
</li>
<li>
<h5>isContainer: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>If the identifier corresponds to a container.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Quad</span><span class="tsd-signature-symbol">[]</span></h4>
<p>The generated quads.</p>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="util_resourceutil.html">util/<wbr>Resource<wbr>Util</a>
@@ -206,15 +167,12 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_resourceutil.html#addresourcemetadata" class="tsd-kind-icon">add<wbr>Resource<wbr>Metadata</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_resourceutil.html#clonerepresentation" class="tsd-kind-icon">clone<wbr>Representation</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_resourceutil.html#generatecontainmentquads" class="tsd-kind-icon">generate<wbr>Containment<wbr>Quads</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_resourceutil.html#generateresourcequads" class="tsd-kind-icon">generate<wbr>Resource<wbr>Quads</a>
</li>
</ul>
</nav>
</div>