This commit is contained in:
RubenVerborgh
2021-05-04 14:35:57 +00:00
parent 9f1be64682
commit e1e35a84d0
676 changed files with 23412 additions and 73346 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>util/PathUtil | Community Solid Server - v0.8.1</title>
<meta name="description" content="Documentation for Community Solid Server - v0.8.1">
<title>util/PathUtil | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.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.8.1</a>
<a href="../index.html" class="title">Community Solid Server - v0.9.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.8.1</a>
<a href="../modules.html">Community Solid Server - v0.9.0</a>
</li>
<li>
<a href="util_pathutil.html">util/PathUtil</a>
@@ -79,10 +79,12 @@
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#ensuretrailingslash" class="tsd-kind-icon">ensure<wbr>Trailing<wbr>Slash</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#extractscheme" class="tsd-kind-icon">extract<wbr>Scheme</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#getextension" class="tsd-kind-icon">get<wbr>Extension</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#getmoduleroot" class="tsd-kind-icon">get<wbr>Module<wbr>Root</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#iscontaineridentifier" class="tsd-kind-icon">is<wbr>Container<wbr>Identifier</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#iscontainerpath" class="tsd-kind-icon">is<wbr>Container<wbr>Path</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#joinfilepath" class="tsd-kind-icon">join<wbr>File<wbr>Path</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#normalizefilepath" class="tsd-kind-icon">normalize<wbr>File<wbr>Path</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#resolveassetpath" class="tsd-kind-icon">resolve<wbr>Asset<wbr>Path</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#tocanonicaluripath" class="tsd-kind-icon">to<wbr>Canonical<wbr>Uri<wbr>Path</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#trimtrailingslashes" class="tsd-kind-icon">trim<wbr>Trailing<wbr>Slashes</a></li>
</ul>
@@ -102,7 +104,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -136,7 +138,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L164">src/util/PathUtil.ts:164</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L164">src/util/PathUtil.ts:164</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -176,7 +178,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L113">src/util/PathUtil.ts:113</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L113">src/util/PathUtil.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -204,7 +206,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L120">src/util/PathUtil.ts:120</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L120">src/util/PathUtil.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -232,7 +234,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -266,7 +268,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L147">src/util/PathUtil.ts:147</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L147">src/util/PathUtil.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -306,7 +308,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L87">src/util/PathUtil.ts:87</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L87">src/util/PathUtil.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -328,6 +330,28 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="getmoduleroot" class="tsd-anchor"></a>
<h3>get<wbr>Module<wbr>Root</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">get<wbr>Module<wbr>Root<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/0a68fbf/src/util/PathUtil.ts#L172">src/util/PathUtil.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the folder corresponding to the root of the Community Solid Server module</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="iscontaineridentifier" class="tsd-anchor"></a>
<h3>is<wbr>Container<wbr>Identifier</h3>
@@ -338,7 +362,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L138">src/util/PathUtil.ts:138</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L138">src/util/PathUtil.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -369,7 +393,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L128">src/util/PathUtil.ts:128</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L128">src/util/PathUtil.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -400,7 +424,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -438,7 +462,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -460,6 +484,36 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="resolveassetpath" class="tsd-anchor"></a>
<h3>resolve<wbr>Asset<wbr>Path</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">resolve<wbr>Asset<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">string</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/0a68fbf/src/util/PathUtil.ts#L181">src/util/PathUtil.ts:181</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts file path inputs into absolute paths.
Works similar to <code>absoluteFilePath</code> but paths that start with &#39;$PACKAGE_ROOT/&#39;
will be relative to the module directory instead of the cwd.</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">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="tocanonicaluripath" class="tsd-anchor"></a>
<h3>to<wbr>Canonical<wbr>Uri<wbr>Path</h3>
@@ -470,7 +524,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L105">src/util/PathUtil.ts:105</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L105">src/util/PathUtil.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -499,7 +553,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/54ff231/src/util/PathUtil.ts#L78">src/util/PathUtil.ts:78</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/util/PathUtil.ts#L78">src/util/PathUtil.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -557,6 +611,9 @@
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_pathutil.html#getextension" class="tsd-kind-icon">get<wbr>Extension</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_pathutil.html#getmoduleroot" class="tsd-kind-icon">get<wbr>Module<wbr>Root</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_pathutil.html#iscontaineridentifier" class="tsd-kind-icon">is<wbr>Container<wbr>Identifier</a>
</li>
@@ -569,6 +626,9 @@
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_pathutil.html#normalizefilepath" class="tsd-kind-icon">normalize<wbr>File<wbr>Path</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_pathutil.html#resolveassetpath" class="tsd-kind-icon">resolve<wbr>Asset<wbr>Path</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_pathutil.html#tocanonicaluripath" class="tsd-kind-icon">to<wbr>Canonical<wbr>Uri<wbr>Path</a>
</li>