This commit is contained in:
RubenVerborgh
2021-06-29 16:54:45 +00:00
parent e1e35a84d0
commit 8591fda008
525 changed files with 12756 additions and 8659 deletions

View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ServerInitializer | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<title>ServerInitializer | 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/init_serverinitializer.html">init/ServerInitializer</a>
@@ -88,6 +88,12 @@
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/init_final_finalizable.finalizable.html" class="tsd-signature-type" data-tsd-kind="Interface">Finalizable</a></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
@@ -102,6 +108,7 @@
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="init_serverinitializer.serverinitializer.html#port" class="tsd-kind-icon">port</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="init_serverinitializer.serverinitializer.html#server" class="tsd-kind-icon">server</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="init_serverinitializer.serverinitializer.html#serverfactory" class="tsd-kind-icon">server<wbr>Factory</a></li>
</ul>
</section>
@@ -109,6 +116,7 @@
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="init_serverinitializer.serverinitializer.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="init_serverinitializer.serverinitializer.html#finalize" class="tsd-kind-icon">finalize</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="init_serverinitializer.serverinitializer.html#handle" class="tsd-kind-icon">handle</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="init_serverinitializer.serverinitializer.html#handlesafe" class="tsd-kind-icon">handle<wbr>Safe</a></li>
</ul>
@@ -129,7 +137,7 @@
<aside class="tsd-sources">
<p>Overrides <a href="init_initializer.initializer.html">Initializer</a>.<a href="init_initializer.initializer.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/init/ServerInitializer.ts#L9">src/init/ServerInitializer.ts:9</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/init/ServerInitializer.ts#L14">src/init/ServerInitializer.ts:14</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -154,7 +162,17 @@
<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/init/ServerInitializer.ts#L9">src/init/ServerInitializer.ts:9</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/init/ServerInitializer.ts#L12">src/init/ServerInitializer.ts:12</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="server" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> server</h3>
<div class="tsd-signature tsd-kind-icon">server<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Server</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/init/ServerInitializer.ts#L14">src/init/ServerInitializer.ts:14</a></li>
</ul>
</aside>
</section>
@@ -164,7 +182,7 @@
<div class="tsd-signature tsd-kind-icon">server<wbr>Factory<span class="tsd-signature-symbol">:</span> <a href="../interfaces/server_httpserverfactory.httpserverfactory.html" class="tsd-signature-type" data-tsd-kind="Interface">HttpServerFactory</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/init/ServerInitializer.ts#L8">src/init/ServerInitializer.ts:8</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/init/ServerInitializer.ts#L11">src/init/ServerInitializer.ts:11</a></li>
</ul>
</aside>
</section>
@@ -182,7 +200,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="init_initializer.initializer.html">Initializer</a>.<a href="init_initializer.initializer.html#canhandle">canHandle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/util/handlers/AsyncHandler.ts#L13">src/util/handlers/AsyncHandler.ts:13</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -205,6 +223,24 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="finalize" class="tsd-anchor"></a>
<h3>finalize</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">finalize<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>Implementation of Finalizable.finalize</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/init/ServerInitializer.ts#L26">src/init/ServerInitializer.ts:26</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <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></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a name="handle" class="tsd-anchor"></a>
<h3>handle</h3>
@@ -216,10 +252,17 @@
<aside class="tsd-sources">
<p>Overrides <a href="init_initializer.initializer.html">Initializer</a>.<a href="init_initializer.initializer.html#handle">handle</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/init/ServerInitializer.ts#L17">src/init/ServerInitializer.ts:17</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/init/ServerInitializer.ts#L22">src/init/ServerInitializer.ts:22</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Handles the given input. This should only be done if the <a href="init_serverinitializer.serverinitializer.html#canhandle">canHandle</a> function returned <code>true</code>.
Therefore, consider using the <a href="init_serverinitializer.serverinitializer.html#handlesafe">handleSafe</a> function instead.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <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></h4>
<p>A promise resolving when the handling is finished. Return value depends on the given type.</p>
</li>
</ul>
</section>
@@ -234,7 +277,7 @@
<aside class="tsd-sources">
<p>Inherited from <a href="init_initializer.initializer.html">Initializer</a>.<a href="init_initializer.initializer.html#handlesafe">handleSafe</a></p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/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/d01382d/src/util/handlers/AsyncHandler.ts#L35">src/util/handlers/AsyncHandler.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -265,7 +308,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/init_serverinitializer.html">init/<wbr>Server<wbr>Initializer</a>
@@ -285,12 +328,18 @@
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="init_serverinitializer.serverinitializer.html#port" class="tsd-kind-icon">port</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="init_serverinitializer.serverinitializer.html#server" class="tsd-kind-icon">server</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="init_serverinitializer.serverinitializer.html#serverfactory" class="tsd-kind-icon">server<wbr>Factory</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="init_serverinitializer.serverinitializer.html#canhandle" class="tsd-kind-icon">can<wbr>Handle</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="init_serverinitializer.serverinitializer.html#finalize" class="tsd-kind-icon">finalize</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
<a href="init_serverinitializer.serverinitializer.html#handle" class="tsd-kind-icon">handle</a>
</li>