mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
deploy: d01382d36e
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>FileIdentifierMapper | Community Solid Server - v0.9.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
|
||||
<title>FileIdentifierMapper | Community Solid Server - v1.0.0-beta.0</title>
|
||||
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.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.9.0</a>
|
||||
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.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.9.0</a>
|
||||
<a href="../modules.html">Community Solid Server - v1.0.0-beta.0</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../modules/storage_mapping_fileidentifiermapper.html">storage/mapping/FileIdentifierMapper</a>
|
||||
@@ -111,25 +111,9 @@
|
||||
<div class="tsd-signature tsd-kind-icon">map<wbr>File<wbr>Path<wbr>ToUrl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, isContainer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/FileIdentifierMapper.ts#L29">src/storage/mapping/FileIdentifierMapper.ts:29</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/FileIdentifierMapper.ts#L29">src/storage/mapping/FileIdentifierMapper.ts:29</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Maps the given file path to an URL and determines the content-type</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>param</dt>
|
||||
<dd><p>The input file path.</p>
|
||||
</dd>
|
||||
<dt>param</dt>
|
||||
<dd><p>If the path corresponds to a file.</p>
|
||||
</dd>
|
||||
<dt>returns</dt>
|
||||
<dd><p>A ResourceLink with all the necessary metadata.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -139,16 +123,32 @@
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Maps the given file path to an URL and determines the content-type</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>filePath: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The input file path.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>isContainer: <span class="tsd-signature-type">boolean</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>If the path corresponds to a file.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A ResourceLink with all the necessary metadata.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -161,28 +161,9 @@
|
||||
<div class="tsd-signature tsd-kind-icon">map<wbr>Url<wbr>ToFile<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, contentType<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">Promise</span><span class="tsd-signature-symbol"><</span><a href="storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">></span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/storage/mapping/FileIdentifierMapper.ts#L40">src/storage/mapping/FileIdentifierMapper.ts:40</a></li>
|
||||
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/storage/mapping/FileIdentifierMapper.ts#L40">src/storage/mapping/FileIdentifierMapper.ts:40</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Maps the given resource identifier / URL to a file path.
|
||||
Determines the content-type if no content-type was provided by finding the corresponding file.
|
||||
If there is no corresponding file a file path will be generated.
|
||||
For containers the content-type input gets ignored.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>param</dt>
|
||||
<dd><p>The input identifier.</p>
|
||||
</dd>
|
||||
<dt>param</dt>
|
||||
<dd><p>The (optional) content-type of the resource.</p>
|
||||
</dd>
|
||||
<dt>returns</dt>
|
||||
<dd><p>A ResourceLink with all the necessary metadata.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
@@ -192,16 +173,35 @@
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Maps the given resource identifier / URL to a file path.
|
||||
Determines the content-type if no content-type was provided by finding the corresponding file.
|
||||
If there is no corresponding file a file path will be generated.
|
||||
For containers the content-type input gets ignored.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>identifier: <a href="ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The input identifier.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> contentType: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The (optional) content-type of the resource.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A ResourceLink with all the necessary metadata.</p>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -214,7 +214,7 @@
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class=" ">
|
||||
<a href="../modules.html">Exports</a>
|
||||
<a href="../modules.html">Modules</a>
|
||||
</li>
|
||||
<li class="current tsd-kind-module">
|
||||
<a href="../modules/storage_mapping_fileidentifiermapper.html">storage/mapping/<wbr>File<wbr>Identifier<wbr>Mapper</a>
|
||||
|
||||
Reference in New Issue
Block a user