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: ce27b55bb8

Browse Source
This commit is contained in:
RubenVerborgh
2021-08-04 15:27:33 +00:00
parent 7efe96d24f
commit 14b9e3ac63
521 changed files with 5584 additions and 6173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/modules/util_pathutil.html
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 - v1.0.0-beta.2</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
<title>util/PathUtil | Community Solid Server - v1.0.0</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.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 - v1.0.0-beta.2</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.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 - v1.0.0-beta.2</a>
<a href="../modules.html">Community Solid Server - v1.0.0</a>
</li>
<li>
<a href="util_pathutil.html">util/PathUtil</a>
@@ -69,6 +69,12 @@
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="util_pathutil.html#modulepathplaceholder" class="tsd-kind-icon">module<wbr>Path<wbr>Placeholder</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
@@ -92,6 +98,25 @@
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-module">
<a name="modulepathplaceholder" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> module<wbr>Path<wbr>Placeholder</h3>
<div class="tsd-signature tsd-kind-icon">module<wbr>Path<wbr>Placeholder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;@css:&quot;</span><span class="tsd-signature-symbol"> = &#x27;@css:&#x27;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L180">src/util/PathUtil.ts:180</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>A placeholder for the path to the <code>@solid/community-server</code> module root.
The resolveAssetPath function will replace this string with the actual path.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
@@ -104,7 +129,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -138,7 +163,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L164">src/util/PathUtil.ts:164</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L164">src/util/PathUtil.ts:164</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -178,7 +203,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L113">src/util/PathUtil.ts:113</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L113">src/util/PathUtil.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -206,7 +231,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L120">src/util/PathUtil.ts:120</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L120">src/util/PathUtil.ts:120</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -234,7 +259,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -268,7 +293,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L147">src/util/PathUtil.ts:147</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L147">src/util/PathUtil.ts:147</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -308,7 +333,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L87">src/util/PathUtil.ts:87</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L87">src/util/PathUtil.ts:87</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -340,7 +365,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L172">src/util/PathUtil.ts:172</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L172">src/util/PathUtil.ts:172</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -362,7 +387,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L138">src/util/PathUtil.ts:138</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L138">src/util/PathUtil.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -393,7 +418,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L128">src/util/PathUtil.ts:128</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L128">src/util/PathUtil.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -424,7 +449,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -462,7 +487,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -488,26 +513,26 @@
<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>
<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/fdd1a37/src/util/PathUtil.ts#L181">src/util/PathUtil.ts:181</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L187">src/util/PathUtil.ts:187</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;
Works similar to <code>absoluteFilePath</code> but paths that start with the <code>modulePathPlaceholder</code>
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>
<h5>path: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -524,7 +549,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L105">src/util/PathUtil.ts:105</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L105">src/util/PathUtil.ts:105</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -553,7 +578,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/PathUtil.ts#L78">src/util/PathUtil.ts:78</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/PathUtil.ts#L78">src/util/PathUtil.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -590,6 +615,9 @@
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-variable tsd-parent-kind-module">
<a href="util_pathutil.html#modulepathplaceholder" class="tsd-kind-icon">module<wbr>Path<wbr>Placeholder</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="util_pathutil.html#absolutefilepath" class="tsd-kind-icon">absolute<wbr>File<wbr>Path</a>
</li>