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
CommunitySolidServer/7.x/docs/interfaces/ResourceStore.html

45 lines
40 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ResourceStore | Community Solid Server - v7.1.2</title><meta name="description" content="Documentation for Community Solid Server"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><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 - v7.1.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Community Solid Server</a></li><li><a href="ResourceStore.html">ResourceStore</a></li></ul><h1>Interface ResourceStore</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A ResourceStore represents a collection of resources.
It has been designed such that each of its methods
can be implemented in an atomic way: for each CRUD operation, only one
dedicated method needs to be called. A fifth method enables the optimization
of partial updates with PATCH. It is up to the implementer of the interface to
(not) make an implementation atomic.</p>
<p>ResourceStores are also responsible for taking auxiliary resources into account
should those be relevant to the store.</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">ResourceStore</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="ResourceStore.html#addResource">addResource</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">container</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">representation</span><span class="tsd-signature-symbol">: </span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ResourceStore.html#deleteResource">deleteResource</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ResourceStore.html#getRepresentation">getRepresentation</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">preferences</span><span class="tsd-signature-symbol">: </span><a href="RepresentationPreferences.html" class="tsd-signature-type tsd-kind-interface">RepresentationPreferences</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ResourceStore.html#hasResource">hasResource</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ResourceStore.html#modifyResource">modifyResource</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">patch</span><span class="tsd-signature-symbol">: </span><a href="Patch.html" class="tsd-signature-type tsd-kind-interface">Patch</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="ResourceStore.html#setRepresentation">setRepresentation</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">representation</span><span class="tsd-signature-symbol">: </span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a href="../hierarchy.html#ResourceStore">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="ResourceSet.html" class="tsd-signature-type tsd-kind-interface">ResourceSet</a><ul class="tsd-hierarchy"><li><span class="target">ResourceStore</span><ul class="tsd-hierarchy"><li><a href="AtomicResourceStore.html" class="tsd-signature-type tsd-kind-interface">AtomicResourceStore</a></li></ul></li></ul></li></ul></section><section class="tsd-panel"><h4>Implemented by</h4><ul class="tsd-hierarchy"><li><a href="../classes/BaseResourceStore.html" class="tsd-signature-type tsd-kind-class">BaseResourceStore</a></li><li><a href="../classes/DataAccessorBasedStore.html" class="tsd-signature-type tsd-kind-class">DataAccessorBasedStore</a></li><li><a href="../classes/MonitoringStore.html" class="tsd-signature-type tsd-kind-class">MonitoringStore</a></li><li><a href="../classes/PassthroughStore.html" class="tsd-signature-type tsd-kind-class">PassthroughStore</a></li><li><a href="../classes/RoutingResourceStore.html" class="tsd-signature-type tsd-kind-class">RoutingResourceStore</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/221dcc41cd4a2f10482d77ac1fe18716695db16c/src/storage/ResourceStore.ts#L28">src/storage/ResourceStore.ts:28</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ResourceStore.html#addResource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Resource</span></a>
<a href="ResourceStore.html#deleteResource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Resource</span></a>
<a href="ResourceStore.html#getRepresentation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Representation</span></a>
<a href="ResourceStore.html#hasResource" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Resource</span></a>
<a href="ResourceStore.html#modifyResource" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modify<wbr/>Resource</span></a>
<a href="ResourceStore.html#setRepresentation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Representation</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="addResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Resource</span><a href="#addResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">add<wbr/>Resource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">container</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">representation</span><span class="tsd-signature-symbol">: </span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Creates a new resource in the container.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="addResource.__type.__type-1"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">container</span>, <span class="tsd-kind-parameter">representation</span>, <span class="tsd-kind-parameter">conditions</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">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">container</span>: <a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Container in which to create a resource.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">representation</span>: <a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a></span><div class="tsd-comment tsd-typography"><p>Representation of the new resource</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/221dcc41cd4a2f10482d77ac1fe18716695db16c/src/storage/ResourceStore.ts#L69">src/storage/ResourceStore.ts:69</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="deleteResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Resource</span><a href="#deleteResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">delete<wbr/>Resource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Deletes a resource.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="deleteResource.__type-2.__type-3"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">conditions</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">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to delete.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/221dcc41cd4a2f10482d77ac1fe18716695db16c/src/storage/ResourceStore.ts#L83">src/storage/ResourceStore.ts:83</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="getRepresentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Representation</span><a href="#getRepresentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">get<wbr/>Representation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">preferences</span><span class="tsd-signature-symbol">: </span><a href="RepresentationPreferences.html" class="tsd-signature-type tsd-kind-interface">RepresentationPreferences</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Retrieves a representation of a resource.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="getRepresentation.__type-4.__type-5"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">preferences</span>, <span class="tsd-kind-parameter">conditions</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">&lt;</span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of the resource to read.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">preferences</span>: <a href="RepresentationPreferences.html" class="tsd-signature-type tsd-kind-interface">RepresentationPreferences</a></span><div class="tsd-comment tsd-typography"><p>Preferences indicating desired representations.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A representation corresponding to the identifier.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/221dcc41cd4a2f10482d77ac1fe18716695db16c/src/storage/ResourceStore.ts#L38">src/storage/ResourceStore.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hasResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>Resource</span><a href="#hasResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">has<wbr/>Resource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Checks whether a resource exists in this ResourceSet.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="hasResource.__type-6.__type-7"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</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">boolean</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to check.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><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">boolean</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise resolving if the resource already exists.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="ResourceSet.html">ResourceSet</a>.<a href="ResourceSet.html#hasResource">hasResource</a></p><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/221dcc41cd4a2f10482d77ac1fe18716695db16c/src/storage/ResourceSet.ts#L14">src/storage/ResourceSet.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="modifyResource" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>modify<wbr/>Resource</span><a href="#modifyResource" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">modify<wbr/>Resource</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">patch</span><span class="tsd-signature-symbol">: </span><a href="Patch.html" class="tsd-signature-type tsd-kind-interface">Patch</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Sets or updates the representation of a resource,
creating a new resource and intermediary containers as needed.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="modifyResource.__type-8.__type-9"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">patch</span>, <span class="tsd-kind-parameter">conditions</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">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to update.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">patch</span>: <a href="Patch.html" class="tsd-signature-type tsd-kind-interface">Patch</a></span><div class="tsd-comment tsd-typography"><p>Description of which parts to update.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/221dcc41cd4a2f10482d77ac1fe18716695db16c/src/storage/ResourceStore.ts#L98">src/storage/ResourceStore.ts:98</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setRepresentation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Representation</span><a href="#setRepresentation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Representation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span><span class="tsd-signature-symbol">: </span><a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a>, <span class="tsd-kind-parameter">representation</span><span class="tsd-signature-symbol">: </span><a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a>, <span class="tsd-kind-parameter">conditions</span><span class="tsd-signature-symbol">?: </span><a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><div class="tsd-comment tsd-typography"><p>Sets or replaces the representation of a resource,
creating a new resource and intermediary containers as needed.</p>
</div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="setRepresentation.__type-10.__type-11"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">identifier</span>, <span class="tsd-kind-parameter">representation</span>, <span class="tsd-kind-parameter">conditions</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">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">identifier</span>: <a href="ResourceIdentifier.html" class="tsd-signature-type tsd-kind-interface">ResourceIdentifier</a></span><div class="tsd-comment tsd-typography"><p>Identifier of resource to update.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">representation</span>: <a href="Representation.html" class="tsd-signature-type tsd-kind-interface">Representation</a></span><div class="tsd-comment tsd-typography"><p>New representation of the resource.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">conditions</span>: <a href="Conditions.html" class="tsd-signature-type tsd-kind-interface">Conditions</a></span><div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/ChangeMap.html" class="tsd-signature-type tsd-kind-type-alias">ChangeMap</a><span class="tsd-signature-symbol">&gt;</span></h4><p>A <a href="../types/ChangeMap.html" class="tsd-kind-type-alias">ChangeMap</a>.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/221dcc41cd4a2f10482d77ac1fe18716695db16c/src/storage/ResourceStore.ts#L54">src/storage/ResourceStore.ts:54</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#addResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>add<wbr/>Resource</span></a><a href="#deleteResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>delete<wbr/>Resource</span></a><a href="#getRepresentation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Representation</span></a><a href="#hasResource" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>Resource</span></a><a href="#modifyResource" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>modify<wbr/>Resource</span></a><a href="#setRepresentation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Representation</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Community Solid Server - v7.1.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink