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

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SubdomainExtensionBasedMapper | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<title>SubdomainExtensionBasedMapper | Community Solid Server - v1.0.0-beta.0</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Community Solid Server - v0.9.0</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">Community Solid Server - v0.9.0</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.0</a>
</li>
<li>
<a href="../modules/storage_mapping_subdomainextensionbasedmapper.html">storage/mapping/SubdomainExtensionBasedMapper</a>
@@ -154,7 +154,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L36">src/storage/mapping/SubdomainExtensionBasedMapper.ts:36</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L36">src/storage/mapping/SubdomainExtensionBasedMapper.ts:36</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -193,7 +193,7 @@
<div class="tsd-signature tsd-kind-icon">base<wbr>Parts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>rest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>scheme<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L36">src/storage/mapping/SubdomainExtensionBasedMapper.ts:36</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L36">src/storage/mapping/SubdomainExtensionBasedMapper.ts:36</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -215,7 +215,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#baserequesturi">baseRequestURI</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L23">src/storage/mapping/BaseFileIdentifierMapper.ts:23</a></li>
</ul>
</aside>
</section>
@@ -225,7 +225,7 @@
<div class="tsd-signature tsd-kind-icon">base<wbr>Subdomain<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/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L34">src/storage/mapping/SubdomainExtensionBasedMapper.ts:34</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L34">src/storage/mapping/SubdomainExtensionBasedMapper.ts:34</a></li>
</ul>
</aside>
</section>
@@ -236,7 +236,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#logger">logger</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L22">src/storage/mapping/BaseFileIdentifierMapper.ts:22</a></li>
</ul>
</aside>
</section>
@@ -246,7 +246,7 @@
<div class="tsd-signature tsd-kind-icon">regex<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RegExp</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L35">src/storage/mapping/SubdomainExtensionBasedMapper.ts:35</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L35">src/storage/mapping/SubdomainExtensionBasedMapper.ts:35</a></li>
</ul>
</aside>
</section>
@@ -257,7 +257,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#rootfilepath">rootFilepath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L24">src/storage/mapping/BaseFileIdentifierMapper.ts:24</a></li>
</ul>
</aside>
</section>
@@ -275,7 +275,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#getabsolutepath">getAbsolutePath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L156">src/storage/mapping/BaseFileIdentifierMapper.ts:156</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -308,9 +308,14 @@
<aside class="tsd-sources">
<p>Overrides <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#getcontainerurl">getContainerUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L46">src/storage/mapping/SubdomainExtensionBasedMapper.ts:46</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L46">src/storage/mapping/SubdomainExtensionBasedMapper.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maps the given container path to a URL and determines its content type.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
@@ -318,6 +323,7 @@
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A ResourceLink with all the necessary metadata.</p>
</li>
</ul>
</section>
@@ -332,9 +338,14 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#getcontenttypefrompath">getContentTypeFromPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/ExtensionBasedMapper.ts#L59">src/storage/mapping/ExtensionBasedMapper.ts:59</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/ExtensionBasedMapper.ts#L59">src/storage/mapping/ExtensionBasedMapper.ts:59</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Determines the content type from the relative path.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
@@ -342,6 +353,7 @@
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>The content type of the document.</p>
</li>
</ul>
</section>
@@ -356,7 +368,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#getcontenttypefromurl">getContentTypeFromUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L88">src/storage/mapping/BaseFileIdentifierMapper.ts:88</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -395,9 +407,14 @@
<aside class="tsd-sources">
<p>Overrides <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#getdocumenturl">getDocumentUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L50">src/storage/mapping/SubdomainExtensionBasedMapper.ts:50</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L50">src/storage/mapping/SubdomainExtensionBasedMapper.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maps the given document path to a URL and determines its content type.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
@@ -405,6 +422,7 @@
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A ResourceLink with all the necessary metadata.</p>
</li>
</ul>
</section>
@@ -419,7 +437,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#getrelativepath">getRelativePath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L79">src/storage/mapping/SubdomainExtensionBasedMapper.ts:79</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L79">src/storage/mapping/SubdomainExtensionBasedMapper.ts:79</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -453,7 +471,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#mapfilepathtourl">mapFilePathToUrl</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L99">src/storage/mapping/BaseFileIdentifierMapper.ts:99</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -492,7 +510,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#mapurltocontainerpath">mapUrlToContainerPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L58">src/storage/mapping/BaseFileIdentifierMapper.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -532,9 +550,17 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#mapurltodocumentpath">mapUrlToDocumentPath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/ExtensionBasedMapper.ts#L18">src/storage/mapping/ExtensionBasedMapper.ts:18</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/ExtensionBasedMapper.ts#L18">src/storage/mapping/ExtensionBasedMapper.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Maps the given document identifier to a file path,
possibly making alterations to the direct translation
(for instance, based on its content type)).
Determines the content type if none was provided.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
@@ -548,6 +574,7 @@
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>A ResourceLink with all the necessary metadata.</p>
</li>
</ul>
</section>
@@ -562,7 +589,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#mapurltofilepath">mapUrlToFilePath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L40">src/storage/mapping/BaseFileIdentifierMapper.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -602,7 +629,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L61">src/storage/mapping/SubdomainExtensionBasedMapper.ts:61</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L61">src/storage/mapping/SubdomainExtensionBasedMapper.ts:61</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -636,7 +663,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#stripextension">stripExtension</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/ExtensionBasedMapper.ts#L68">src/storage/mapping/ExtensionBasedMapper.ts:68</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/ExtensionBasedMapper.ts#L68">src/storage/mapping/ExtensionBasedMapper.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -666,7 +693,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#validaterelativepath">validateRelativePath</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/storage/mapping/BaseFileIdentifierMapper.ts#L186">src/storage/mapping/BaseFileIdentifierMapper.ts:186</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -705,7 +732,7 @@
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/storage_mapping_subdomainextensionbasedmapper.html">storage/mapping/<wbr>Subdomain<wbr>Extension<wbr>Based<wbr>Mapper</a>