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

deploy: 0be82228bb

Browse Source
This commit is contained in:
RubenVerborgh
2021-07-23 22:06:41 +00:00
parent 8591fda008
commit 9ba53b9d07
531 changed files with 10005 additions and 9931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

78
docs/classes/storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html
View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>BaseFileIdentifierMapper | Community Solid Server - v1.0.0-beta.0</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.0">
<title>BaseFileIdentifierMapper | Community Solid Server - v1.0.0-beta.1</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.0</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.1</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.0</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.1</a>
</li>
<li>
<a href="../modules/storage_mapping_basefileidentifiermapper.html">storage/mapping/BaseFileIdentifierMapper</a>
@@ -124,6 +124,7 @@
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getcontenttypefromurl" class="tsd-kind-icon">get<wbr>Content<wbr>Type<wbr>From<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getdocumenturl" class="tsd-kind-icon">get<wbr>Document<wbr>Url</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getrelativepath" class="tsd-kind-icon">get<wbr>Relative<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#ismetadatapath" class="tsd-kind-icon">is<wbr>Metadata<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapfilepathtourl" class="tsd-kind-icon">map<wbr>File<wbr>Path<wbr>ToUrl</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapurltocontainerpath" class="tsd-kind-icon">map<wbr>Url<wbr>ToContainer<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapurltodocumentpath" class="tsd-kind-icon">map<wbr>Url<wbr>ToDocument<wbr>Path</a></li>
@@ -146,7 +147,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L24">src/storage/mapping/BaseFileIdentifierMapper.ts:24</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L25">src/storage/mapping/BaseFileIdentifierMapper.ts:25</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -171,7 +172,7 @@
<div class="tsd-signature tsd-kind-icon">base<wbr>RequestURI<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L23">src/storage/mapping/BaseFileIdentifierMapper.ts:23</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L24">src/storage/mapping/BaseFileIdentifierMapper.ts:24</a></li>
</ul>
</aside>
</section>
@@ -181,7 +182,7 @@
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="logging_logger.logger.html" class="tsd-signature-type" data-tsd-kind="Class">Logger</a><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L22">src/storage/mapping/BaseFileIdentifierMapper.ts:22</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L23">src/storage/mapping/BaseFileIdentifierMapper.ts:23</a></li>
</ul>
</aside>
</section>
@@ -191,7 +192,7 @@
<div class="tsd-signature tsd-kind-icon">root<wbr>Filepath<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L24">src/storage/mapping/BaseFileIdentifierMapper.ts:24</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L25">src/storage/mapping/BaseFileIdentifierMapper.ts:25</a></li>
</ul>
</aside>
</section>
@@ -208,7 +209,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L156">src/storage/mapping/BaseFileIdentifierMapper.ts:156</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L172">src/storage/mapping/BaseFileIdentifierMapper.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -240,7 +241,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L125">src/storage/mapping/BaseFileIdentifierMapper.ts:125</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L141">src/storage/mapping/BaseFileIdentifierMapper.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -272,7 +273,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L146">src/storage/mapping/BaseFileIdentifierMapper.ts:146</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L162">src/storage/mapping/BaseFileIdentifierMapper.ts:162</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -304,7 +305,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L88">src/storage/mapping/BaseFileIdentifierMapper.ts:88</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L100">src/storage/mapping/BaseFileIdentifierMapper.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -342,7 +343,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L135">src/storage/mapping/BaseFileIdentifierMapper.ts:135</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L151">src/storage/mapping/BaseFileIdentifierMapper.ts:151</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -374,7 +375,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L169">src/storage/mapping/BaseFileIdentifierMapper.ts:169</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L185">src/storage/mapping/BaseFileIdentifierMapper.ts:185</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -402,6 +403,34 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="ismetadatapath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> is<wbr>Metadata<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">is<wbr>Metadata<wbr>Path<span class="tsd-signature-symbol">(</span>path<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L217">src/storage/mapping/BaseFileIdentifierMapper.ts:217</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Checks if the given path is a metadata path.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="mapfilepathtourl" class="tsd-anchor"></a>
<h3>map<wbr>File<wbr>Path<wbr>ToUrl</h3>
@@ -413,7 +442,7 @@
<aside class="tsd-sources">
<p>Implementation of FileIdentifierMapper.mapFilePathToUrl</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L99">src/storage/mapping/BaseFileIdentifierMapper.ts:99</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L111">src/storage/mapping/BaseFileIdentifierMapper.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -451,7 +480,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L58">src/storage/mapping/BaseFileIdentifierMapper.ts:58</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L70">src/storage/mapping/BaseFileIdentifierMapper.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -490,7 +519,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L74">src/storage/mapping/BaseFileIdentifierMapper.ts:74</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L86">src/storage/mapping/BaseFileIdentifierMapper.ts:86</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -531,14 +560,14 @@
<a name="mapurltofilepath" class="tsd-anchor"></a>
<h3>map<wbr>Url<wbr>ToFile<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">map<wbr>Url<wbr>ToFile<wbr>Path<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, contentType<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">map<wbr>Url<wbr>ToFile<wbr>Path<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, isMetadata<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, contentType<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of FileIdentifierMapper.mapUrlToFilePath</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L40">src/storage/mapping/BaseFileIdentifierMapper.ts:40</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L42">src/storage/mapping/BaseFileIdentifierMapper.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -556,6 +585,12 @@
<p>The input identifier.</p>
</div>
</li>
<li>
<h5>isMetadata: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<p>If we need the data or metadata file path.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> contentType: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
@@ -578,7 +613,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L186">src/storage/mapping/BaseFileIdentifierMapper.ts:186</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L202">src/storage/mapping/BaseFileIdentifierMapper.ts:202</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -661,6 +696,9 @@
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#getrelativepath" class="tsd-kind-icon">get<wbr>Relative<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#ismetadatapath" class="tsd-kind-icon">is<wbr>Metadata<wbr>Path</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="storage_mapping_basefileidentifiermapper.basefileidentifiermapper.html#mapfilepathtourl" class="tsd-kind-icon">map<wbr>File<wbr>Path<wbr>ToUrl</a>
</li>