mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
deploy: 038693a679
This commit is contained in:
RubenVerborgh
@@ -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.5.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.5.0">
|
||||
<title>util/PathUtil | Community Solid Server - v0.6.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.6.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.5.0</a>
|
||||
<a href="../index.html" class="title">Community Solid Server - v0.6.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.5.0</a>
|
||||
<a href="../modules.html">Community Solid Server - v0.6.0</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="util_pathutil.html">util/PathUtil</a>
|
||||
@@ -72,9 +72,11 @@
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Functions</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<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>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#decodeuripathcomponents" class="tsd-kind-icon">decode<wbr>Uri<wbr>Path<wbr>Components</a></li>
|
||||
<li class="tsd-kind-function tsd-parent-kind-module"><a href="util_pathutil.html#encodeuripathcomponents" class="tsd-kind-icon">encode<wbr>Uri<wbr>Path<wbr>Components</a></li>
|
||||
<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#getextension" class="tsd-kind-icon">get<wbr>Extension</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>
|
||||
@@ -88,6 +90,40 @@
|
||||
</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">
|
||||
<a name="absolutefilepath" class="tsd-anchor"></a>
|
||||
<h3>absolute<wbr>File<wbr>Path</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">absolute<wbr>File<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/038693a/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Resolves a path to its absolute form.
|
||||
Absolute inputs will not be changed (except changing Windows to POSIX).
|
||||
Relative inputs will be interpreted relative to process.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>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Path to check (POSIX or Windows).</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
<p>The potentially changed path (POSIX).</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="decodeuripathcomponents" class="tsd-anchor"></a>
|
||||
<h3>decode<wbr>Uri<wbr>Path<wbr>Components</h3>
|
||||
@@ -98,7 +134,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L75">src/util/PathUtil.ts:75</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L105">src/util/PathUtil.ts:105</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -126,7 +162,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L82">src/util/PathUtil.ts:82</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L112">src/util/PathUtil.ts:112</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -154,7 +190,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -178,6 +214,38 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="getextension" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Extension</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Extension<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/038693a/src/util/PathUtil.ts#L87">src/util/PathUtil.ts:87</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Extracts the extension (without dot) from a path.
|
||||
Custom function since <code>path.extname</code> does not work on all cases (e.g. ".acl")</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>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Input path to parse.</p>
|
||||
</div>
|
||||
</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="iscontaineridentifier" class="tsd-anchor"></a>
|
||||
<h3>is<wbr>Container<wbr>Identifier</h3>
|
||||
@@ -188,7 +256,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L100">src/util/PathUtil.ts:100</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L130">src/util/PathUtil.ts:130</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -219,7 +287,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L90">src/util/PathUtil.ts:90</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L120">src/util/PathUtil.ts:120</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -250,7 +318,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -288,12 +356,12 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Resolves relative segments in the path/</p>
|
||||
<p>Resolves relative segments in the path.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -320,7 +388,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L97">src/util/PathUtil.ts:97</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -350,7 +418,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/c469df2/src/util/PathUtil.ts#L58">src/util/PathUtil.ts:58</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/038693a/src/util/PathUtil.ts#L78">src/util/PathUtil.ts:78</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -387,6 +455,9 @@
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<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>
|
||||
<li class=" tsd-kind-function tsd-parent-kind-module">
|
||||
<a href="util_pathutil.html#decodeuripathcomponents" class="tsd-kind-icon">decode<wbr>Uri<wbr>Path<wbr>Components</a>
|
||||
</li>
|
||||
@@ -396,6 +467,9 @@
|
||||
<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#getextension" class="tsd-kind-icon">get<wbr>Extension</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>
|
||||
|
||||
Reference in New Issue
Block a user