mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
597 lines
42 KiB
HTML
597 lines
42 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>TemplatedResourcesGenerator | Community Solid Server</title>
|
|
<meta name="description" content="Documentation for Community Solid Server">
|
|
<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>
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<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</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../modules.html">Community Solid Server</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/index.html">index</a>
|
|
</li>
|
|
<li>
|
|
<a href="index.templatedresourcesgenerator.html">TemplatedResourcesGenerator</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class TemplatedResourcesGenerator</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates resources by making use of a template engine.
|
|
The template folder structure will be kept.
|
|
Folders will be interpreted as containers and files as documents.
|
|
A FileIdentifierMapper will be used to generate identifiers that correspond to the relative structure.</p>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">TemplatedResourcesGenerator</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel">
|
|
<h3>Implements</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li><a href="../interfaces/pods_generate_resourcesgenerator.resourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourcesGenerator</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="index.templatedresourcesgenerator.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
|
|
<h3>Properties</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#engine" class="tsd-kind-icon">engine</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#factory" class="tsd-kind-icon">factory</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#metaextension" class="tsd-kind-icon">meta<wbr>Extension</a></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#templatefolder" class="tsd-kind-icon">template<wbr>Folder</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="index.templatedresourcesgenerator.html#generate" class="tsd-kind-icon">generate</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#generatelinks" class="tsd-kind-icon">generate<wbr>Links</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#generatemetadata" class="tsd-kind-icon">generate<wbr>Metadata</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#generateresource" class="tsd-kind-icon">generate<wbr>Resource</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#grouplinks" class="tsd-kind-icon">group<wbr>Links</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#ismeta" class="tsd-kind-icon">is<wbr>Meta</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#metatoresource" class="tsd-kind-icon">meta<wbr>ToResource</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#parsefolder" class="tsd-kind-icon">parse<wbr>Folder</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="index.templatedresourcesgenerator.html#parsetemplate" class="tsd-kind-icon">parse<wbr>Template</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Templated<wbr>Resources<wbr>Generator<span class="tsd-signature-symbol">(</span>templateFolder<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, factory<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapperfactory.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapperFactory</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapper.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapper</a><span class="tsd-signature-symbol">></span>, engine<span class="tsd-signature-symbol">: </span><a href="../interfaces/pods_generate_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="pods_generate_templatedresourcesgenerator.templatedresourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Class">TemplatedResourcesGenerator</a></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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L29">src/pods/generate/TemplatedResourcesGenerator.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A mapper is needed to convert the template file paths to identifiers relative to the given base identifier.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>templateFolder: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Folder where the templates are located.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>factory: <a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapperfactory.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapperFactory</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapper.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapper</a><span class="tsd-signature-symbol">></span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Factory used to generate mapper relative to the base identifier.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>engine: <a href="../interfaces/pods_generate_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Template engine for generating the resources.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="pods_generate_templatedresourcesgenerator.templatedresourcesgenerator.html" class="tsd-signature-type" data-tsd-kind="Class">TemplatedResourcesGenerator</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
|
|
<h2>Properties</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="engine" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> engine</h3>
|
|
<div class="tsd-signature tsd-kind-icon">engine<span class="tsd-signature-symbol">:</span> <a href="../interfaces/pods_generate_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L28">src/pods/generate/TemplatedResourcesGenerator.ts:28</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="factory" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> factory</h3>
|
|
<div class="tsd-signature tsd-kind-icon">factory<span class="tsd-signature-symbol">:</span> <a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapperfactory.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapperFactory</a></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L27">src/pods/generate/TemplatedResourcesGenerator.ts:27</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="metaextension" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> meta<wbr>Extension</h3>
|
|
<div class="tsd-signature tsd-kind-icon">meta<wbr>Extension<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">".meta"</span><span class="tsd-signature-symbol"> = '.meta'</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L29">src/pods/generate/TemplatedResourcesGenerator.ts:29</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a name="templatefolder" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> template<wbr>Folder</h3>
|
|
<div class="tsd-signature tsd-kind-icon">template<wbr>Folder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/solid/community-server/blob/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L26">src/pods/generate/TemplatedResourcesGenerator.ts:26</a></li>
|
|
</ul>
|
|
</aside>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="generate" class="tsd-anchor"></a>
|
|
<h3>generate</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">generate<span class="tsd-signature-symbol">(</span>location<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Dict</span><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><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/pods_generate_resourcesgenerator.resource.html" class="tsd-signature-type" data-tsd-kind="Interface">Resource</a><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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L44">src/pods/generate/TemplatedResourcesGenerator.ts:44</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>location: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>options: <span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><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">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/pods_generate_resourcesgenerator.resource.html" class="tsd-signature-type" data-tsd-kind="Interface">Resource</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="generatelinks" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> generate<wbr>Links</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Links<span class="tsd-signature-symbol">(</span>folderPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, mapper<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapper.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapper</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L77">src/pods/generate/TemplatedResourcesGenerator.ts:77</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates ResourceLinks for each entry in the given folder.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>folderPath: <span class="tsd-signature-type">string</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mapper: <a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapper.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapper</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="generatemetadata" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> generate<wbr>Metadata</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Metadata<span class="tsd-signature-symbol">(</span>metaLink<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Dict</span><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><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L140">src/pods/generate/TemplatedResourcesGenerator.ts:140</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a RepresentationMetadata using the given template.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>metaLink: <a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>options: <span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><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">Promise</span><span class="tsd-signature-symbol"><</span><a href="ldp_representation_representationmetadata.representationmetadata.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationMetadata</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="generateresource" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> generate<wbr>Resource</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">generate<wbr>Resource<span class="tsd-signature-symbol">(</span>link<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span>, metaLink<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><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="../interfaces/pods_generate_resourcesgenerator.resource.html" class="tsd-signature-type" data-tsd-kind="Interface">Resource</a><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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L109">src/pods/generate/TemplatedResourcesGenerator.ts:109</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates a Resource object for the given ResourceLink.
|
|
In the case of documents the corresponding template will be used.
|
|
If a ResourceLink of metadata is provided the corresponding data will be added as metadata.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>link: <a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>options: <span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> metaLink: <a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/pods_generate_resourcesgenerator.resource.html" class="tsd-signature-type" data-tsd-kind="Interface">Resource</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="grouplinks" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> group<wbr>Links</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">group<wbr>Links<span class="tsd-signature-symbol">(</span>linkGen<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">></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><span class="tsd-signature-type">Record</span><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>link<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">; </span>meta<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L89">src/pods/generate/TemplatedResourcesGenerator.ts:89</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Parses a group of ResourceLinks so resources and their metadata are grouped together.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>linkGen: <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Record</span><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>link<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol">; </span>meta<span class="tsd-signature-symbol">?: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="ismeta" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> is<wbr>Meta</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">is<wbr>Meta<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">boolean</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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L164">src/pods/generate/TemplatedResourcesGenerator.ts:164</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Verifies if the given path corresponds to a metadata file.</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">boolean</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="metatoresource" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> meta<wbr>ToResource</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">meta<wbr>ToResource<span class="tsd-signature-symbol">(</span>metaIdentifier<span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L171">src/pods/generate/TemplatedResourcesGenerator.ts:171</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Converts a generated metadata identifier to the identifier of its corresponding resource.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>metaIdentifier: <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ldp_representation_resourceidentifier.resourceidentifier.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceIdentifier</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="parsefolder" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> parse<wbr>Folder</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Folder<span class="tsd-signature-symbol">(</span>folderLink<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a>, mapper<span class="tsd-signature-symbol">: </span><a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapper.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapper</a>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Dict</span><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><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/pods_generate_resourcesgenerator.resource.html" class="tsd-signature-type" data-tsd-kind="Interface">Resource</a><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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L53">src/pods/generate/TemplatedResourcesGenerator.ts:53</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Generates results for all entries in the given folder, including the folder itself.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>folderLink: <a href="../interfaces/storage_mapping_fileidentifiermapper.resourcelink.html" class="tsd-signature-type" data-tsd-kind="Interface">ResourceLink</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>mapper: <a href="../interfaces/storage_mapping_fileidentifiermapper.fileidentifiermapper.html" class="tsd-signature-type" data-tsd-kind="Interface">FileIdentifierMapper</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>options: <span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><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">AsyncIterable</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/pods_generate_resourcesgenerator.resource.html" class="tsd-signature-type" data-tsd-kind="Interface">Resource</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a name="parsetemplate" class="tsd-anchor"></a>
|
|
<h3><span class="tsd-flag ts-flagPrivate">Private</span> parse<wbr>Template</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Template<span class="tsd-signature-symbol">(</span>filePath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Dict</span><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><span class="tsd-signature-type">Promise</span><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/de939ac/src/pods/generate/TemplatedResourcesGenerator.ts#L156">src/pods/generate/TemplatedResourcesGenerator.ts:156</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Applies the given options to the template found at the given path.</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>
|
|
</li>
|
|
<li>
|
|
<h5>options: <span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol"><</span><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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class=" ">
|
|
<a href="../modules.html">Exports</a>
|
|
</li>
|
|
<li class="current tsd-kind-module">
|
|
<a href="../modules/index.html">index</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
<a href="index.templatedresourcesgenerator.html" class="tsd-kind-icon">Templated<wbr>Resources<wbr>Generator</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="index.templatedresourcesgenerator.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#engine" class="tsd-kind-icon">engine</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#factory" class="tsd-kind-icon">factory</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#metaextension" class="tsd-kind-icon">meta<wbr>Extension</a>
|
|
</li>
|
|
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#templatefolder" class="tsd-kind-icon">template<wbr>Folder</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="index.templatedresourcesgenerator.html#generate" class="tsd-kind-icon">generate</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#generatelinks" class="tsd-kind-icon">generate<wbr>Links</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#generatemetadata" class="tsd-kind-icon">generate<wbr>Metadata</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#generateresource" class="tsd-kind-icon">generate<wbr>Resource</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#grouplinks" class="tsd-kind-icon">group<wbr>Links</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#ismeta" class="tsd-kind-icon">is<wbr>Meta</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#metatoresource" class="tsd-kind-icon">meta<wbr>ToResource</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#parsefolder" class="tsd-kind-icon">parse<wbr>Folder</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
|
|
<a href="index.templatedresourcesgenerator.html#parsetemplate" class="tsd-kind-icon">parse<wbr>Template</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |