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

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TemplateHandler | Community Solid Server - v1.0.0-beta.2</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
<title>TemplateHandler | 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="../modules/server_util_templatehandler.html">server/util/TemplateHandler</a>
@@ -87,15 +87,10 @@
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="util_handlers_asynchandler.asynchandler.html" class="tsd-signature-type" data-tsd-kind="Class">AsyncHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span>
<a href="util_handlers_asynchandler.asynchandler.html" class="tsd-signature-type" data-tsd-kind="Class">AsyncHandler</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><a href="../modules/server_httpresponse.html#httpresponse" class="tsd-signature-type" data-tsd-kind="Type alias">HttpResponse</a><span class="tsd-signature-symbol">; </span>templateFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">&gt;</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">TemplateHandler</span>
<ul class="tsd-hierarchy">
<li>
<a href="identity_interaction_util_idprenderhandler.idprenderhandler.html" class="tsd-signature-type" data-tsd-kind="Class">IdpRenderHandler</a>
</li>
</ul>
</li>
</ul>
</li>
@@ -142,7 +137,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="util_handlers_asynchandler.asynchandler.html">AsyncHandler</a>.<a href="util_handlers_asynchandler.asynchandler.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/server/util/TemplateHandler.ts#L12">src/server/util/TemplateHandler.ts:12</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/server/util/TemplateHandler.ts#L12">src/server/util/TemplateHandler.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@@ -173,7 +168,7 @@
<div class="tsd-signature tsd-kind-icon">content<wbr>Type<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/fdd1a37/src/server/util/TemplateHandler.ts#L12">src/server/util/TemplateHandler.ts:12</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/server/util/TemplateHandler.ts#L12">src/server/util/TemplateHandler.ts:12</a></li>
</ul>
</aside>
</section>
@@ -183,7 +178,7 @@
<div class="tsd-signature tsd-kind-icon">template<wbr>Engine<span class="tsd-signature-symbol">:</span> <a href="../interfaces/util_templates_templateengine.templateengine.html" class="tsd-signature-type" data-tsd-kind="Interface">TemplateEngine</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Dict</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/server/util/TemplateHandler.ts#L11">src/server/util/TemplateHandler.ts:11</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/server/util/TemplateHandler.ts#L11">src/server/util/TemplateHandler.ts:11</a></li>
</ul>
</aside>
</section>
@@ -194,14 +189,14 @@
<a name="canhandle" class="tsd-anchor"></a>
<h3>can<wbr>Handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">can<wbr>Handle<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol">; </span>templateFile<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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="util_handlers_asynchandler.asynchandler.html">AsyncHandler</a>.<a href="util_handlers_asynchandler.asynchandler.html#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -213,7 +208,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<h5>input: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol">; </span>templateFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that could potentially be handled.</p>
</div>
@@ -224,6 +219,9 @@
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span></h5>
</li>
<li class="tsd-parameter">
<h5>template<wbr>File<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
@@ -236,14 +234,14 @@
<a name="handle" class="tsd-anchor"></a>
<h3>handle</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">handle<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol">; </span>templateFile<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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides <a href="util_handlers_asynchandler.asynchandler.html">AsyncHandler</a>.<a href="util_handlers_asynchandler.asynchandler.html#handle">handle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/server/util/TemplateHandler.ts#L20">src/server/util/TemplateHandler.ts:20</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/server/util/TemplateHandler.ts#L20">src/server/util/TemplateHandler.ts:20</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -255,7 +253,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol">; </span>templateFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span></h5>
@@ -263,6 +261,9 @@
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span></h5>
</li>
<li class="tsd-parameter">
<h5>template<wbr>File<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>
@@ -274,14 +275,14 @@
<a name="handlesafe" class="tsd-anchor"></a>
<h3>handle<wbr>Safe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">handle<wbr>Safe<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol">; </span>templateFile<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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="util_handlers_asynchandler.asynchandler.html">AsyncHandler</a>.<a href="util_handlers_asynchandler.asynchandler.html#handlesafe">handleSafe</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -294,7 +295,7 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>input: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol"> }</span></h5>
<h5>input: <span class="tsd-signature-symbol">{ </span>contents<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">; </span>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span><span class="tsd-signature-symbol">; </span>templateFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5>
<div class="tsd-comment tsd-typography">
<p>Input data that will be handled if it can be handled.</p>
</div>
@@ -305,6 +306,9 @@
<li class="tsd-parameter">
<h5>response<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ServerResponse</span></h5>
</li>
<li class="tsd-parameter">
<h5>template<wbr>File<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</li>
</ul>