This commit is contained in:
RubenVerborgh
2021-07-30 15:22:58 +00:00
parent 9ba53b9d07
commit 7efe96d24f
518 changed files with 5397 additions and 4076 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 - v1.0.0-beta.1</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.1">
<title>SubdomainExtensionBasedMapper | Community Solid Server - v1.0.0-beta.2</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
<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.1</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.2</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.1</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.2</a>
</li>
<li>
<a href="../modules/storage_mapping_subdomainextensionbasedmapper.html">storage/mapping/SubdomainExtensionBasedMapper</a>
@@ -148,14 +148,14 @@
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Subdomain<wbr>Extension<wbr>Based<wbr>Mapper<span class="tsd-signature-symbol">(</span>base<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, rootFilepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, baseSubdomain<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, overrideTypes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>acl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>meta<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><a href="storage_mapping_subdomainextensionbasedmapper.subdomainextensionbasedmapper.html" class="tsd-signature-type" data-tsd-kind="Class">SubdomainExtensionBasedMapper</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Subdomain<wbr>Extension<wbr>Based<wbr>Mapper<span class="tsd-signature-symbol">(</span>base<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, rootFilepath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, baseSubdomain<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, customTypes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="storage_mapping_subdomainextensionbasedmapper.subdomainextensionbasedmapper.html" class="tsd-signature-type" data-tsd-kind="Class">SubdomainExtensionBasedMapper</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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/0be8222/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/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L35">src/storage/mapping/SubdomainExtensionBasedMapper.ts:35</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -170,15 +170,7 @@
<h5>baseSubdomain: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;www&#x27;</span></h5>
</li>
<li>
<h5>overrideTypes: <span class="tsd-signature-symbol">{ </span>acl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>meta<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></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>acl<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>meta<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> customTypes: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="storage_mapping_subdomainextensionbasedmapper.subdomainextensionbasedmapper.html" class="tsd-signature-type" data-tsd-kind="Class">SubdomainExtensionBasedMapper</a></h4>
@@ -194,7 +186,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/0be8222/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/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L35">src/storage/mapping/SubdomainExtensionBasedMapper.ts:35</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
@@ -216,7 +208,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/0be8222/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/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L24">src/storage/mapping/BaseFileIdentifierMapper.ts:24</a></li>
</ul>
</aside>
</section>
@@ -226,7 +218,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/0be8222/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/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L33">src/storage/mapping/SubdomainExtensionBasedMapper.ts:33</a></li>
</ul>
</aside>
</section>
@@ -237,7 +229,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/0be8222/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/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L23">src/storage/mapping/BaseFileIdentifierMapper.ts:23</a></li>
</ul>
</aside>
</section>
@@ -247,7 +239,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/0be8222/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/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L34">src/storage/mapping/SubdomainExtensionBasedMapper.ts:34</a></li>
</ul>
</aside>
</section>
@@ -258,7 +250,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/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L25">src/storage/mapping/BaseFileIdentifierMapper.ts:25</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L25">src/storage/mapping/BaseFileIdentifierMapper.ts:25</a></li>
</ul>
</aside>
</section>
@@ -276,7 +268,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/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L172">src/storage/mapping/BaseFileIdentifierMapper.ts:172</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L172">src/storage/mapping/BaseFileIdentifierMapper.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -309,7 +301,7 @@
<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/0be8222/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/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L45">src/storage/mapping/SubdomainExtensionBasedMapper.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -339,7 +331,7 @@
<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/0be8222/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/fdd1a37/src/storage/mapping/ExtensionBasedMapper.ts#L81">src/storage/mapping/ExtensionBasedMapper.ts:81</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -369,7 +361,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/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L100">src/storage/mapping/BaseFileIdentifierMapper.ts:100</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L100">src/storage/mapping/BaseFileIdentifierMapper.ts:100</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -408,7 +400,7 @@
<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/0be8222/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/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L49">src/storage/mapping/SubdomainExtensionBasedMapper.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -438,7 +430,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/0be8222/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/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L78">src/storage/mapping/SubdomainExtensionBasedMapper.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -472,7 +464,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html">ExtensionBasedMapper</a>.<a href="storage_mapping_extensionbasedmapper.extensionbasedmapper.html#ismetadatapath">isMetadataPath</a></p>
<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>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L217">src/storage/mapping/BaseFileIdentifierMapper.ts:217</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -501,7 +493,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/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L111">src/storage/mapping/BaseFileIdentifierMapper.ts:111</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L111">src/storage/mapping/BaseFileIdentifierMapper.ts:111</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -540,7 +532,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/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L70">src/storage/mapping/BaseFileIdentifierMapper.ts:70</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L70">src/storage/mapping/BaseFileIdentifierMapper.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -580,7 +572,7 @@
<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/0be8222/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/fdd1a37/src/storage/mapping/ExtensionBasedMapper.ts#L40">src/storage/mapping/ExtensionBasedMapper.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -619,7 +611,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/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L42">src/storage/mapping/BaseFileIdentifierMapper.ts:42</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L42">src/storage/mapping/BaseFileIdentifierMapper.ts:42</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -665,7 +657,7 @@
<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/SubdomainExtensionBasedMapper.ts#L61">src/storage/mapping/SubdomainExtensionBasedMapper.ts:61</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/SubdomainExtensionBasedMapper.ts#L60">src/storage/mapping/SubdomainExtensionBasedMapper.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -699,7 +691,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/0be8222/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/fdd1a37/src/storage/mapping/ExtensionBasedMapper.ts#L92">src/storage/mapping/ExtensionBasedMapper.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -729,7 +721,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/0be8222/src/storage/mapping/BaseFileIdentifierMapper.ts#L202">src/storage/mapping/BaseFileIdentifierMapper.ts:202</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/storage/mapping/BaseFileIdentifierMapper.ts#L202">src/storage/mapping/BaseFileIdentifierMapper.ts:202</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">