mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
740 lines
116 KiB
HTML
740 lines
116 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataAccessorBasedStore | Community Solid Server - v5.1.0</title><meta name="description" content="Documentation for Community Solid Server - v5.1.0"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</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 search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></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 - v5.1.0</a></div>
|
|
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
|
|
<div class="container container-main">
|
|
<div class="col-8 col-content">
|
|
<div class="tsd-page-title">
|
|
<ul class="tsd-breadcrumb">
|
|
<li><a href="../modules.html">Community Solid Server - v5.1.0</a></li>
|
|
<li><a href="DataAccessorBasedStore.html">DataAccessorBasedStore</a></li></ul>
|
|
<h1>Class DataAccessorBasedStore</h1></div>
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography"><p>ResourceStore which uses a DataAccessor for backend access.</p>
|
|
<p>The DataAccessor interface provides elementary store operations such as read and write.
|
|
This DataAccessorBasedStore uses those elementary store operations
|
|
to implement the more high-level ResourceStore contact, abstracting all common functionality
|
|
such that new stores can be added by implementing the more simple DataAccessor contract.
|
|
DataAccessorBasedStore thereby provides behaviours for reuse across different stores, such as:</p>
|
|
<ul>
|
|
<li>Converting container metadata to data</li>
|
|
<li>Converting slug to URI</li>
|
|
<li>Checking if addResource target is a container</li>
|
|
<li>Checking if no containment triples are written to a container</li>
|
|
<li>etc.</li>
|
|
</ul>
|
|
<p>Currently "metadata" is seen as something that is not directly accessible.
|
|
That means that a consumer can't write directly to the metadata of a resource, only indirectly through headers.
|
|
(Except for containers where data and metadata overlap).</p>
|
|
<p>The one thing this store does not take care of (yet?) are containment triples for containers</p>
|
|
<p>Work has been done to minimize the number of required calls to the DataAccessor,
|
|
but the main disadvantage is that sometimes multiple calls are required where a specific store might only need one.</p>
|
|
</div></section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h4>Hierarchy</h4>
|
|
<ul class="tsd-hierarchy">
|
|
<li><span class="target">DataAccessorBasedStore</span></li></ul></section>
|
|
<section class="tsd-panel">
|
|
<h4>Implements</h4>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../interfaces/ResourceStore.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceStore</a></li></ul></section><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L74">src/storage/DataAccessorBasedStore.ts:74</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-index-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"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary>
|
|
<div class="tsd-accordion-details">
|
|
<section class="tsd-index-section">
|
|
<h3 class="tsd-index-heading">Constructors</h3>
|
|
<div class="tsd-index-list"><a href="DataAccessorBasedStore.html#constructor" class="tsd-index-link tsd-kind-constructor tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-512-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-512-text"></path></svg><span>constructor</span></a>
|
|
</div></section>
|
|
<section class="tsd-index-section">
|
|
<h3 class="tsd-index-heading">Properties</h3>
|
|
<div class="tsd-index-list"><a href="DataAccessorBasedStore.html#accessor" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>accessor</span></a>
|
|
<a href="DataAccessorBasedStore.html#auxiliaryStrategy" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>auxiliary<wbr/>Strategy</span></a>
|
|
<a href="DataAccessorBasedStore.html#identifierStrategy" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>identifier<wbr/>Strategy</span></a>
|
|
<a href="DataAccessorBasedStore.html#logger" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>logger</span></a>
|
|
<a href="DataAccessorBasedStore.html#metadataStrategy" class="tsd-index-link tsd-kind-property tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>metadata<wbr/>Strategy</span></a>
|
|
</div></section>
|
|
<section class="tsd-index-section">
|
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
<div class="tsd-index-list"><a href="DataAccessorBasedStore.html#addActivityMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-private"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>add<wbr/>Activity<wbr/>Metadata</span></a>
|
|
<a href="DataAccessorBasedStore.html#addResource" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>add<wbr/>Resource</span></a>
|
|
<a href="DataAccessorBasedStore.html#cleanSlug" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>clean<wbr/>Slug</span></a>
|
|
<a href="DataAccessorBasedStore.html#createRecursiveContainers" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Recursive<wbr/>Containers</span></a>
|
|
<a href="DataAccessorBasedStore.html#createSafeUri" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>create<wbr/>Safe<wbr/>Uri</span></a>
|
|
<a href="DataAccessorBasedStore.html#createURI" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>createURI</span></a>
|
|
<a href="DataAccessorBasedStore.html#deleteResource" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>delete<wbr/>Resource</span></a>
|
|
<a href="DataAccessorBasedStore.html#getNormalizedMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Normalized<wbr/>Metadata</span></a>
|
|
<a href="DataAccessorBasedStore.html#getRepresentation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Representation</span></a>
|
|
<a href="DataAccessorBasedStore.html#getSafeNormalizedMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>get<wbr/>Safe<wbr/>Normalized<wbr/>Metadata</span></a>
|
|
<a href="DataAccessorBasedStore.html#handleContainerData" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>handle<wbr/>Container<wbr/>Data</span></a>
|
|
<a href="DataAccessorBasedStore.html#hasContainerType" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>has<wbr/>Container<wbr/>Type</span></a>
|
|
<a href="DataAccessorBasedStore.html#hasProperChildren" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>has<wbr/>Proper<wbr/>Children</span></a>
|
|
<a href="DataAccessorBasedStore.html#hasResource" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>has<wbr/>Resource</span></a>
|
|
<a href="DataAccessorBasedStore.html#isContainerType" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Container<wbr/>Type</span></a>
|
|
<a href="DataAccessorBasedStore.html#isRootStorage" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>is<wbr/>Root<wbr/>Storage</span></a>
|
|
<a href="DataAccessorBasedStore.html#modifyResource" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>modify<wbr/>Resource</span></a>
|
|
<a href="DataAccessorBasedStore.html#removeResponseMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>remove<wbr/>Response<wbr/>Metadata</span></a>
|
|
<a href="DataAccessorBasedStore.html#safelyDeleteAuxiliaryResources" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>safely<wbr/>Delete<wbr/>Auxiliary<wbr/>Resources</span></a>
|
|
<a href="DataAccessorBasedStore.html#setRepresentation" class="tsd-index-link tsd-kind-method tsd-parent-kind-class"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>set<wbr/>Representation</span></a>
|
|
<a href="DataAccessorBasedStore.html#updateContainerModifiedDate" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>update<wbr/>Container<wbr/>Modified<wbr/>Date</span></a>
|
|
<a href="DataAccessorBasedStore.html#validateConditions" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate<wbr/>Conditions</span></a>
|
|
<a href="DataAccessorBasedStore.html#validateIdentifier" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate<wbr/>Identifier</span></a>
|
|
<a href="DataAccessorBasedStore.html#validateSlug" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>validate<wbr/>Slug</span></a>
|
|
<a href="DataAccessorBasedStore.html#writeData" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>write<wbr/>Data</span></a>
|
|
<a href="DataAccessorBasedStore.html#writeMetadata" class="tsd-index-link tsd-kind-method tsd-parent-kind-class tsd-is-protected"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg><span>write<wbr/>Metadata</span></a>
|
|
</div></section></div></details></section></section>
|
|
<section class="tsd-panel-group tsd-member-group">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-anchor-link" id="constructor.new_DataAccessorBasedStore">new <wbr/>Data<wbr/>Accessor<wbr/>Based<wbr/>Store<span class="tsd-signature-symbol">(</span>accessor<span class="tsd-signature-symbol">: </span><a href="../interfaces/DataAccessor.html" class="tsd-signature-type" data-tsd-kind="Interface">DataAccessor</a>, identifierStrategy<span class="tsd-signature-symbol">: </span><a href="../interfaces/IdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierStrategy</a>, auxiliaryStrategy<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a>, metadataStrategy<span class="tsd-signature-symbol">: </span><a href="../interfaces/AuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="DataAccessorBasedStore.html" class="tsd-signature-type" data-tsd-kind="Class">DataAccessorBasedStore</a><a href="#constructor.new_DataAccessorBasedStore" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>accessor: <a href="../interfaces/DataAccessor.html" class="tsd-signature-type" data-tsd-kind="Interface">DataAccessor</a></h5></li>
|
|
<li>
|
|
<h5>identifierStrategy: <a href="../interfaces/IdentifierStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">IdentifierStrategy</a></h5></li>
|
|
<li>
|
|
<h5>auxiliaryStrategy: <a href="../interfaces/AuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a></h5></li>
|
|
<li>
|
|
<h5>metadataStrategy: <a href="../interfaces/AuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <a href="DataAccessorBasedStore.html" class="tsd-signature-type" data-tsd-kind="Class">DataAccessorBasedStore</a></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L82">src/storage/DataAccessorBasedStore.ts:82</a></li></ul></aside></li></ul></section></section>
|
|
<section class="tsd-panel-group tsd-member-group">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="accessor" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>accessor</span><a href="#accessor" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">accessor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/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/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L77">src/storage/DataAccessorBasedStore.ts:77</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="auxiliaryStrategy" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>auxiliary<wbr/>Strategy</span><a href="#auxiliaryStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">auxiliary<wbr/>Strategy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/AuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a></div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L79">src/storage/DataAccessorBasedStore.ts:79</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="identifierStrategy" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>identifier<wbr/>Strategy</span><a href="#identifierStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">identifier<wbr/>Strategy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/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/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L78">src/storage/DataAccessorBasedStore.ts:78</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a id="logger" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>logger</span><a href="#logger" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">logger<span class="tsd-signature-symbol">:</span> <a href="../interfaces/Logger.html" class="tsd-signature-type" data-tsd-kind="Interface">Logger</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L75">src/storage/DataAccessorBasedStore.ts:75</a></li></ul></aside></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="metadataStrategy" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>metadata<wbr/>Strategy</span><a href="#metadataStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<div class="tsd-signature">metadata<wbr/>Strategy<span class="tsd-signature-symbol">:</span> <a href="../interfaces/AuxiliaryStrategy.html" class="tsd-signature-type" data-tsd-kind="Interface">AuxiliaryStrategy</a></div><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L80">src/storage/DataAccessorBasedStore.ts:80</a></li></ul></aside></section></section>
|
|
<section class="tsd-panel-group tsd-member-group">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="addActivityMetadata" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>add<wbr/>Activity<wbr/>Metadata</span><a href="#addActivityMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-anchor-link" id="addActivityMetadata.addActivityMetadata-1">add<wbr/>Activity<wbr/>Metadata<span class="tsd-signature-symbol">(</span>map<span class="tsd-signature-symbol">: </span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a>, id<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, activity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NamedNode</span><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">void</span><a href="#addActivityMetadata.addActivityMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Generates activity metadata for a resource and adds it to the <a href="../types/ChangeMap.html">ChangeMap</a></p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>map: <a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>ChangeMap to update.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>id: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of the resource being changed.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>activity: <span class="tsd-signature-type">NamedNode</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Which activity is taking place.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L710">src/storage/DataAccessorBasedStore.ts:710</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-anchor-link" id="addResource.addResource-1">add<wbr/>Resource<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, representation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#addResource.addResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Creates a new resource in the container.</p>
|
|
|
|
<h3>Returns</h3><p>A <a href="../types/ChangeMap.html">ChangeMap</a>.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>container: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Container in which to create a resource.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>representation: <a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Representation of the new resource</p>
|
|
</div></li>
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> conditions: <a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<p>Implementation of ResourceStore.addResource</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L163">src/storage/DataAccessorBasedStore.ts:163</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="cleanSlug" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>clean<wbr/>Slug</span><a href="#cleanSlug" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="cleanSlug.cleanSlug-1">clean<wbr/>Slug<span class="tsd-signature-symbol">(</span>slug<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-type">string</span><a href="#cleanSlug.cleanSlug-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Clean http Slug to be compatible with the server. Makes sure there are no unwanted characters
|
|
e.g.: cleanslug('&%26') returns '%26%26'</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>slug: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>the slug to clean</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L577">src/storage/DataAccessorBasedStore.ts:577</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="createRecursiveContainers" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>Recursive<wbr/>Containers</span><a href="#createRecursiveContainers" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="createRecursiveContainers.createRecursiveContainers-1">create<wbr/>Recursive<wbr/>Containers<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#createRecursiveContainers.createRecursiveContainers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Create containers starting from the root until the given identifier corresponds to an existing container.
|
|
Will throw errors if the identifier of the last existing "container" corresponds to an existing document.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>container: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of the container which will need to exist.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L676">src/storage/DataAccessorBasedStore.ts:676</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="createSafeUri" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>create<wbr/>Safe<wbr/>Uri</span><a href="#createSafeUri" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="createSafeUri.createSafeUri-1">create<wbr/>Safe<wbr/>Uri<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, metadata<span class="tsd-signature-symbol">: </span><a href="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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">></span><a href="#createSafeUri.createSafeUri-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Generate a valid URI to store a new Resource in the given container.
|
|
URI will be based on the slug header if there is one and is guaranteed to not exist yet.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>container: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of the target container.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>metadata: <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Metadata of the new resource.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L591">src/storage/DataAccessorBasedStore.ts:591</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="createURI" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>createURI</span><a href="#createURI" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="createURI.createURI-1">createURI<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, isContainer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, slug<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><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><a href="#createURI.createURI-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Generates a new URI for a resource in the given container, potentially using the given slug.</p>
|
|
<p>Solid, §5.3: "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="type" targeting a valid LDP container type."
|
|
<a href="https://solid.github.io/specification/protocol#writing-resources">https://solid.github.io/specification/protocol#writing-resources</a></p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>container: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Parent container of the new URI.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>isContainer: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Does the new URI represent a container?</p>
|
|
</div></li>
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> slug: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Slug to use for the new URI.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L552">src/storage/DataAccessorBasedStore.ts:552</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-anchor-link" id="deleteResource.deleteResource-1">delete<wbr/>Resource<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#deleteResource.deleteResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Deletes a resource.</p>
|
|
|
|
<h3>Returns</h3><p>A <a href="../types/ChangeMap.html">ChangeMap</a>.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of resource to delete.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> conditions: <a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<p>Implementation of ResourceStore.deleteResource</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L277">src/storage/DataAccessorBasedStore.ts:277</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="getNormalizedMetadata" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Normalized<wbr/>Metadata</span><a href="#getNormalizedMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="getNormalizedMetadata.getNormalizedMetadata-1">get<wbr/>Normalized<wbr/>Metadata<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span><a href="#getNormalizedMetadata.getNormalizedMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Returns the metadata matching the identifier, ignoring the presence of a trailing slash or not.</p>
|
|
<p>Solid, §3.1: "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."
|
|
<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>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier that needs to be checked.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L370">src/storage/DataAccessorBasedStore.ts:370</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-anchor-link" id="getRepresentation.getRepresentation-1">get<wbr/>Representation<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span><a href="#getRepresentation.getRepresentation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Retrieves a representation of a resource.</p>
|
|
|
|
<h3>Returns</h3><p>A representation corresponding to the identifier.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of the resource to read.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<p>Implementation of ResourceStore.getRepresentation</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L106">src/storage/DataAccessorBasedStore.ts:106</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="getSafeNormalizedMetadata" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>get<wbr/>Safe<wbr/>Normalized<wbr/>Metadata</span><a href="#getSafeNormalizedMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="getSafeNormalizedMetadata.getSafeNormalizedMetadata-1">get<wbr/>Safe<wbr/>Normalized<wbr/>Metadata<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span><a href="#getSafeNormalizedMetadata.getSafeNormalizedMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Returns the result of <code>getNormalizedMetadata</code> or undefined if a 404 error is thrown.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L390">src/storage/DataAccessorBasedStore.ts:390</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="handleContainerData" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>handle<wbr/>Container<wbr/>Data</span><a href="#handleContainerData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="handleContainerData.handleContainerData-1">handle<wbr/>Container<wbr/>Data<span class="tsd-signature-symbol">(</span>representation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#handleContainerData.handleContainerData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Warns when the representation has data and removes the content-type from the metadata.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>representation: <a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Container representation.</p>
|
|
</div></li></ul></div>
|
|
<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><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L508">src/storage/DataAccessorBasedStore.ts:508</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="hasContainerType" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>has<wbr/>Container<wbr/>Type</span><a href="#hasContainerType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="hasContainerType.hasContainerType-1">has<wbr/>Container<wbr/>Type<span class="tsd-signature-symbol">(</span>rdfTypes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Term</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#hasContainerType.hasContainerType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Checks in a list of types if any of them match a Container type.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>rdfTypes: <span class="tsd-signature-type">Term</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L629">src/storage/DataAccessorBasedStore.ts:629</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="hasProperChildren" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>has<wbr/>Proper<wbr/>Children</span><a href="#hasProperChildren" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="hasProperChildren.hasProperChildren-1">has<wbr/>Proper<wbr/>Children<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#hasProperChildren.hasProperChildren-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Checks if the given container has any non-auxiliary resources.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>container: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L643">src/storage/DataAccessorBasedStore.ts:643</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-anchor-link" id="hasResource.hasResource-1">has<wbr/>Resource<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#hasResource.hasResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Check if a resource exists in this ResourceSet.</p>
|
|
|
|
<h3>Returns</h3><p>A promise resolving if the resource already exists.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of resource to check.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<p>Implementation of ResourceStore.hasResource</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L90">src/storage/DataAccessorBasedStore.ts:90</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="isContainerType" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>is<wbr/>Container<wbr/>Type</span><a href="#isContainerType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="isContainerType.isContainerType-1">is<wbr/>Container<wbr/>Type<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="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><a href="#isContainerType.isContainerType-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Checks if the given metadata represents a (potential) container,
|
|
based on the metadata.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>metadata: <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Metadata of the (new) resource.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L622">src/storage/DataAccessorBasedStore.ts:622</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="isRootStorage" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>is<wbr/>Root<wbr/>Storage</span><a href="#isRootStorage" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="isRootStorage.isRootStorage-1">is<wbr/>Root<wbr/>Storage<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="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><a href="#isRootStorage.isRootStorage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Verifies if this is the metadata of a root storage container.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>metadata: <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L636">src/storage/DataAccessorBasedStore.ts:636</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-anchor-link" id="modifyResource.modifyResource-1">modify<wbr/>Resource<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, patch<span class="tsd-signature-symbol">: </span><a href="../interfaces/Patch.html" class="tsd-signature-type" data-tsd-kind="Interface">Patch</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><a href="#modifyResource.modifyResource-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<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>
|
|
|
|
<h3>Returns</h3><p>A <a href="../types/ChangeMap.html">ChangeMap</a>.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of resource to update.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>patch: <a href="../interfaces/Patch.html" class="tsd-signature-type" data-tsd-kind="Interface">Patch</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Description of which parts to update.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> conditions: <a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<p>Implementation of ResourceStore.modifyResource</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L259">src/storage/DataAccessorBasedStore.ts:259</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="removeResponseMetadata" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>remove<wbr/>Response<wbr/>Metadata</span><a href="#removeResponseMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="removeResponseMetadata.removeResponseMetadata-1">remove<wbr/>Response<wbr/>Metadata<span class="tsd-signature-symbol">(</span>metadata<span class="tsd-signature-symbol">: </span><a href="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">void</span><a href="#removeResponseMetadata.removeResponseMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Removes all generated data from metadata to prevent it from being stored permanently.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>metadata: <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L523">src/storage/DataAccessorBasedStore.ts:523</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="safelyDeleteAuxiliaryResources" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>safely<wbr/>Delete<wbr/>Auxiliary<wbr/>Resources</span><a href="#safelyDeleteAuxiliaryResources" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="safelyDeleteAuxiliaryResources.safelyDeleteAuxiliaryResources-1">safely<wbr/>Delete<wbr/>Auxiliary<wbr/>Resources<span class="tsd-signature-symbol">(</span>identifiers<span class="tsd-signature-symbol">: </span><a href="../interfaces/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="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#safelyDeleteAuxiliaryResources.safelyDeleteAuxiliaryResources-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Deletes the given array of auxiliary identifiers.
|
|
Does not throw an error if something goes wrong.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifiers: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L656">src/storage/DataAccessorBasedStore.ts:656</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><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 class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-anchor-link" id="setRepresentation.setRepresentation-1">set<wbr/>Representation<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, representation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a>, conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</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"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#setRepresentation.setRepresentation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<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>
|
|
|
|
<h3>Returns</h3><p>A <a href="../types/ChangeMap.html">ChangeMap</a>.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of resource to update.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>representation: <a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>New representation of the resource.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> conditions: <a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Optional conditions under which to proceed.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<p>Implementation of ResourceStore.setRepresentation</p>
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L203">src/storage/DataAccessorBasedStore.ts:203</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="updateContainerModifiedDate" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>update<wbr/>Container<wbr/>Modified<wbr/>Date</span><a href="#updateContainerModifiedDate" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="updateContainerModifiedDate.updateContainerModifiedDate-1">update<wbr/>Container<wbr/>Modified<wbr/>Date<span class="tsd-signature-symbol">(</span>container<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#updateContainerModifiedDate.updateContainerModifiedDate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Updates the last modified date of the given container</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>container: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5></li></ul></div>
|
|
<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><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L532">src/storage/DataAccessorBasedStore.ts:532</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="validateConditions" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>validate<wbr/>Conditions</span><a href="#validateConditions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="validateConditions.validateConditions-1">validate<wbr/>Conditions<span class="tsd-signature-symbol">(</span>conditions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a>, metadata<span class="tsd-signature-symbol">?: </span><a href="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">void</span><a href="#validateConditions.validateConditions-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Verify if the given metadata matches the conditions.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> conditions: <a href="../interfaces/Conditions.html" class="tsd-signature-type" data-tsd-kind="Interface">Conditions</a></h5></li>
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> metadata: <a href="RepresentationMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L350">src/storage/DataAccessorBasedStore.ts:350</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="validateIdentifier" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>validate<wbr/>Identifier</span><a href="#validateIdentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="validateIdentifier.validateIdentifier-1">validate<wbr/>Identifier<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/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-type">void</span><a href="#validateIdentifier.validateIdentifier-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Verify if the given identifier matches the stored base.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L341">src/storage/DataAccessorBasedStore.ts:341</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="validateSlug" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>validate<wbr/>Slug</span><a href="#validateSlug" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="validateSlug.validateSlug-1">validate<wbr/>Slug<span class="tsd-signature-symbol">(</span>isContainer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, slug<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-type">void</span><a href="#validateSlug.validateSlug-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Validates if the slug and headers are valid.
|
|
Errors if slug exists, ends on slash, but ContainerType Link header is NOT present</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>isContainer: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Is the slug supposed to represent a container?</p>
|
|
</div></li>
|
|
<li>
|
|
<h5><code class="tsd-tag ts-flagOptional">Optional</code> slug: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Is the requested slug (if any).</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L566">src/storage/DataAccessorBasedStore.ts:566</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="writeData" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>write<wbr/>Data</span><a href="#writeData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="writeData.writeData-1">write<wbr/>Data<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, representation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a>, isContainer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, createContainers<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, exists<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#writeData.writeData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Write the given resource to the DataAccessor. Metadata will be updated with necessary triples.
|
|
In case of containers <code>handleContainerData</code> will be used to verify the data.</p>
|
|
|
|
<h3>Returns</h3><p>Identifiers of resources that were possibly modified.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of the resource.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>representation: <a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Corresponding Representation.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>isContainer: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Is the incoming resource a container?</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>createContainers: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Should parent containers (potentially) be created?</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>exists: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography"><p>If the resource already exists.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L451">src/storage/DataAccessorBasedStore.ts:451</a></li></ul></aside></li></ul></section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a id="writeMetadata" class="tsd-anchor"></a>
|
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>write<wbr/>Metadata</span><a href="#writeMetadata" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
|
<li class="tsd-signature tsd-anchor-link" id="writeMetadata.writeMetadata-1">write<wbr/>Metadata<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, representation<span class="tsd-signature-symbol">: </span><a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</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"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span><a href="#writeMetadata.writeMetadata-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography"><p>Write the given metadata resource to the DataAccessor.</p>
|
|
|
|
<h3>Returns</h3><p>Identifiers of resources that were possibly modified.</p>
|
|
</div>
|
|
<div class="tsd-parameters">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameter-list">
|
|
<li>
|
|
<h5>identifier: <a href="../interfaces/ResourceIdentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Identifier of the metadata.</p>
|
|
</div></li>
|
|
<li>
|
|
<h5>representation: <a href="../interfaces/Representation.html" class="tsd-signature-type" data-tsd-kind="Interface">Representation</a></h5>
|
|
<div class="tsd-comment tsd-typography"><p>Corresponding Representation.</p>
|
|
</div></li></ul></div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/ChangeMap.html" class="tsd-signature-type" data-tsd-kind="Type alias">ChangeMap</a><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/1a07de7/src/storage/DataAccessorBasedStore.ts#L408">src/storage/DataAccessorBasedStore.ts:408</a></li></ul></aside></li></ul></section></section></div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<div class="tsd-navigation settings">
|
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<div class="tsd-filter-visibility">
|
|
<h4 class="uppercase">Member Visibility</h4><form>
|
|
<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-private" name="private"/><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>Private</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></form></div>
|
|
<div class="tsd-theme-toggle">
|
|
<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
|
<nav class="tsd-navigation primary">
|
|
<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
|
|
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
|
|
<div class="tsd-accordion-details">
|
|
<ul>
|
|
<li><a href="../modules.html">Community <wbr/>Solid <wbr/>Server -<wbr/> v5.1.0</a>
|
|
<ul></ul></li></ul></div></details></nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul>
|
|
<li class="current tsd-kind-class"><a href="DataAccessorBasedStore.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg><span>Data<wbr/>Accessor<wbr/>Based<wbr/>Store</span></a>
|
|
<ul>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="DataAccessorBasedStore.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-512-path"></use><use href="#icon-512-text"></use></svg>constructor</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="DataAccessorBasedStore.html#accessor" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>accessor</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="DataAccessorBasedStore.html#auxiliaryStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>auxiliary<wbr/>Strategy</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="DataAccessorBasedStore.html#identifierStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>identifier<wbr/>Strategy</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#logger" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>logger</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="DataAccessorBasedStore.html#metadataStrategy" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>metadata<wbr/>Strategy</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="DataAccessorBasedStore.html#addActivityMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Activity<wbr/>Metadata</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DataAccessorBasedStore.html#addResource" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>add<wbr/>Resource</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#cleanSlug" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>clean<wbr/>Slug</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#createRecursiveContainers" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Recursive<wbr/>Containers</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#createSafeUri" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>create<wbr/>Safe<wbr/>Uri</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#createURI" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>createURI</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DataAccessorBasedStore.html#deleteResource" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>delete<wbr/>Resource</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#getNormalizedMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Normalized<wbr/>Metadata</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DataAccessorBasedStore.html#getRepresentation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Representation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#getSafeNormalizedMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>get<wbr/>Safe<wbr/>Normalized<wbr/>Metadata</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#handleContainerData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>handle<wbr/>Container<wbr/>Data</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#hasContainerType" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>has<wbr/>Container<wbr/>Type</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#hasProperChildren" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>has<wbr/>Proper<wbr/>Children</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DataAccessorBasedStore.html#hasResource" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>has<wbr/>Resource</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#isContainerType" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Container<wbr/>Type</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#isRootStorage" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>is<wbr/>Root<wbr/>Storage</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DataAccessorBasedStore.html#modifyResource" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>modify<wbr/>Resource</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#removeResponseMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>remove<wbr/>Response<wbr/>Metadata</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#safelyDeleteAuxiliaryResources" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>safely<wbr/>Delete<wbr/>Auxiliary<wbr/>Resources</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="DataAccessorBasedStore.html#setRepresentation" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>set<wbr/>Representation</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#updateContainerModifiedDate" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>update<wbr/>Container<wbr/>Modified<wbr/>Date</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#validateConditions" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate<wbr/>Conditions</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#validateIdentifier" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate<wbr/>Identifier</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#validateSlug" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>validate<wbr/>Slug</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#writeData" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>write<wbr/>Data</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="DataAccessorBasedStore.html#writeMetadata" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>write<wbr/>Metadata</a></li></ul></li></ul></nav></div></div>
|
|
<div class="overlay"></div><script src="../assets/main.js"></script></body></html> |