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>GeneratedPodManager | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<title>GeneratedPodManager | 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="../modules/pods_generatedpodmanager.html">pods/GeneratedPodManager</a>
@@ -103,7 +103,6 @@
<section class="tsd-index-section tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="pods_generatedpodmanager.generatedpodmanager.html#idgenerator" class="tsd-kind-icon">id<wbr>Generator</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="pods_generatedpodmanager.generatedpodmanager.html#logger" class="tsd-kind-icon">logger</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="pods_generatedpodmanager.generatedpodmanager.html#resourcesgenerator" class="tsd-kind-icon">resources<wbr>Generator</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="pods_generatedpodmanager.generatedpodmanager.html#store" class="tsd-kind-icon">store</a></li>
@@ -124,13 +123,13 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Generated<wbr>Pod<wbr>Manager<span class="tsd-signature-symbol">(</span>store<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a>, idGenerator<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_generate_identifiergenerator.identifiergenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierGenerator</a>, resourcesGenerator<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="pods_generatedpodmanager.generatedpodmanager.html" class="tsd-signature-type" data-tsd-kind="Class">GeneratedPodManager</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Generated<wbr>Pod<wbr>Manager<span class="tsd-signature-symbol">(</span>store<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a>, resourcesGenerator<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="pods_generatedpodmanager.generatedpodmanager.html" class="tsd-signature-type" data-tsd-kind="Class">GeneratedPodManager</a></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/pods/GeneratedPodManager.ts#L20">src/pods/GeneratedPodManager.ts:20</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/pods/GeneratedPodManager.ts#L18">src/pods/GeneratedPodManager.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -138,9 +137,6 @@
<li>
<h5>store: <a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a></h5>
</li>
<li>
<h5>idGenerator: <a href="../interfaces/pods_generate_identifiergenerator.identifiergenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierGenerator</a></h5>
</li>
<li>
<h5>resourcesGenerator: <a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a></h5>
</li>
@@ -152,23 +148,13 @@
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="idgenerator" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> id<wbr>Generator</h3>
<div class="tsd-signature tsd-kind-icon">id<wbr>Generator<span class="tsd-signature-symbol">:</span> <a href="../interfaces/pods_generate_identifiergenerator.identifiergenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierGenerator</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/pods/GeneratedPodManager.ts#L19">src/pods/GeneratedPodManager.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a name="logger" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3>
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="logging_logger.logger.html" class="tsd-signature-type" data-tsd-kind="Class">Logger</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/0a68fbf/src/pods/GeneratedPodManager.ts#L16">src/pods/GeneratedPodManager.ts:16</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/pods/GeneratedPodManager.ts#L15">src/pods/GeneratedPodManager.ts:15</a></li>
</ul>
</aside>
</section>
@@ -178,7 +164,7 @@
<div class="tsd-signature tsd-kind-icon">resources<wbr>Generator<span class="tsd-signature-symbol">:</span> <a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/pods/GeneratedPodManager.ts#L20">src/pods/GeneratedPodManager.ts:20</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/pods/GeneratedPodManager.ts#L18">src/pods/GeneratedPodManager.ts:18</a></li>
</ul>
</aside>
</section>
@@ -188,7 +174,7 @@
<div class="tsd-signature tsd-kind-icon">store<span class="tsd-signature-symbol">:</span> <a href="../interfaces/storage_resourcestore.resourcestore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/pods/GeneratedPodManager.ts#L18">src/pods/GeneratedPodManager.ts:18</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/pods/GeneratedPodManager.ts#L17">src/pods/GeneratedPodManager.ts:17</a></li>
</ul>
</aside>
</section>
@@ -199,30 +185,32 @@
<a name="createpod" class="tsd-anchor"></a>
<h3>create<wbr>Pod</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">create<wbr>Pod<span class="tsd-signature-symbol">(</span>settings<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_settings_podsettings.podsettings.html" class="tsd-signature-type" data-tsd-kind="Interface">PodSettings</a><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_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">create<wbr>Pod<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, settings<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_settings_podsettings.podsettings.html" class="tsd-signature-type" data-tsd-kind="Interface">PodSettings</a><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>Implementation of PodManager.createPod</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/pods/GeneratedPodManager.ts#L33">src/pods/GeneratedPodManager.ts:33</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/pods/GeneratedPodManager.ts#L29">src/pods/GeneratedPodManager.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates a new pod, pre-populating it with the resources created by the data generator.
Pod identifiers are created based on the identifier generator.
Will throw an error if the given identifier already has a resource.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>identifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
</li>
<li>
<h5>settings: <a href="../interfaces/pods_settings_podsettings.podsettings.html" class="tsd-signature-type" data-tsd-kind="Interface">PodSettings</a></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_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">&gt;</span></h4>
<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>
</li>
</ul>
</section>
@@ -232,7 +220,7 @@
<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="../modules/pods_generatedpodmanager.html">pods/<wbr>Generated<wbr>Pod<wbr>Manager</a>
@@ -249,9 +237,6 @@
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="pods_generatedpodmanager.generatedpodmanager.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="pods_generatedpodmanager.generatedpodmanager.html#idgenerator" class="tsd-kind-icon">id<wbr>Generator</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="pods_generatedpodmanager.generatedpodmanager.html#logger" class="tsd-kind-icon">logger</a>
</li>