mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
deploy: 12ace1b556
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.7.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.7.0">
|
||||
<title>util/PathUtil | Community Solid Server - v0.8.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.8.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.7.0</a>
|
||||
<a href="../index.html" class="title">Community Solid Server - v0.8.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.7.0</a>
|
||||
<a href="../modules.html">Community Solid Server - v0.8.0</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="util_pathutil.html">util/PathUtil</a>
|
||||
@@ -73,9 +73,11 @@
|
||||
<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#createsubdomainregexp" class="tsd-kind-icon">create<wbr>Subdomain<wbr>Regexp</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#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#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>
|
||||
@@ -100,7 +102,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L47">src/util/PathUtil.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -124,6 +126,46 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="createsubdomainregexp" class="tsd-anchor"></a>
|
||||
<h3>create<wbr>Subdomain<wbr>Regexp</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">create<wbr>Subdomain<wbr>Regexp<span class="tsd-signature-symbol">(</span>baseUrl<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">RegExp</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/12ace1b/src/util/PathUtil.ts#L164">src/util/PathUtil.ts:164</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Creates a regular expression that matches URLs containing the given baseUrl, or a subdomain of the given baseUrl.
|
||||
In case there is a subdomain, the first match of the regular expression will be that subdomain.</p>
|
||||
</div>
|
||||
<p>Examples with baseUrl <code>http://test.com/foo/</code>:</p>
|
||||
<ul>
|
||||
<li>Will match <code>http://test.com/foo/</code></li>
|
||||
<li>Will match <code>http://test.com/foo/bar/baz</code></li>
|
||||
<li>Will match <code>http://alice.bob.test.com/foo/bar/baz</code>, first match result will be <code>alice.bob</code></li>
|
||||
<li>Will not match <code>http://test.com/</code></li>
|
||||
<li>Will not match <code>http://alicetest.com/foo/</code></li>
|
||||
</ul>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>baseUrl: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>Base URL for the regular expression.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RegExp</span></h4>
|
||||
</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>
|
||||
@@ -134,7 +176,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L105">src/util/PathUtil.ts:105</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L113">src/util/PathUtil.ts:113</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -162,7 +204,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L112">src/util/PathUtil.ts:112</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L120">src/util/PathUtil.ts:120</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -190,7 +232,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L67">src/util/PathUtil.ts:67</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -214,6 +256,46 @@
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
|
||||
<a name="extractscheme" class="tsd-anchor"></a>
|
||||
<h3>extract<wbr>Scheme</h3>
|
||||
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
|
||||
<li class="tsd-signature tsd-kind-icon">extract<wbr>Scheme<span class="tsd-signature-symbol">(</span>url<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>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></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/12ace1b/src/util/PathUtil.ts#L147">src/util/PathUtil.ts:147</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Splits a URL (or similar) string into a part containing its scheme and one containing the rest.
|
||||
E.g., <code>http://test.com/</code> results in <code>{ scheme: 'http://', rest: 'test.com/' }</code>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>url: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>String to parse.</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <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></h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>rest<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>scheme<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</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>
|
||||
@@ -224,7 +306,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L87">src/util/PathUtil.ts:87</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L87">src/util/PathUtil.ts:87</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -256,7 +338,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L130">src/util/PathUtil.ts:130</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L138">src/util/PathUtil.ts:138</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -287,7 +369,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L120">src/util/PathUtil.ts:120</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L128">src/util/PathUtil.ts:128</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -318,7 +400,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L34">src/util/PathUtil.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -356,7 +438,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L22">src/util/PathUtil.ts:22</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -388,14 +470,13 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L97">src/util/PathUtil.ts:97</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L105">src/util/PathUtil.ts:105</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Converts a URI path to the canonical version by splitting on slashes,
|
||||
decoding any percent-based encodings,
|
||||
and then encoding any special characters.</p>
|
||||
decoding any percent-based encodings, and then encoding any special characters.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -418,7 +499,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/59a7c51/src/util/PathUtil.ts#L78">src/util/PathUtil.ts:78</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/12ace1b/src/util/PathUtil.ts#L78">src/util/PathUtil.ts:78</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -458,6 +539,9 @@
|
||||
<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#createsubdomainregexp" class="tsd-kind-icon">create<wbr>Subdomain<wbr>Regexp</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>
|
||||
@@ -467,6 +551,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#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>
|
||||
|
||||
Reference in New Issue
Block a user