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>BaseHttpServerFactory | Community Solid Server - v0.9.0</title>
<meta name="description" content="Documentation for Community Solid Server - v0.9.0">
<title>BaseHttpServerFactory | 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/server_basehttpserverfactory.html">server/BaseHttpServerFactory</a>
@@ -104,11 +104,13 @@
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="server_basehttpserverfactory.basehttpserverfactory.html#handler" class="tsd-kind-icon">handler</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="server_basehttpserverfactory.basehttpserverfactory.html#logger" class="tsd-kind-icon">logger</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="server_basehttpserverfactory.basehttpserverfactory.html#options" class="tsd-kind-icon">options</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 tsd-is-private"><a href="server_basehttpserverfactory.basehttpserverfactory.html#createserveroptions" class="tsd-kind-icon">create<wbr>Server<wbr>Options</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="server_basehttpserverfactory.basehttpserverfactory.html#startserver" class="tsd-kind-icon">start<wbr>Server</a></li>
</ul>
</section>
@@ -121,13 +123,13 @@
<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>Base<wbr>Http<wbr>Server<wbr>Factory<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">: </span><a href="server_httphandler.httphandler.html" class="tsd-signature-type" data-tsd-kind="Class">HttpHandler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="server_basehttpserverfactory.basehttpserverfactory.html" class="tsd-signature-type" data-tsd-kind="Class">BaseHttpServerFactory</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Base<wbr>Http<wbr>Server<wbr>Factory<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">: </span><a href="server_httphandler.httphandler.html" class="tsd-signature-type" data-tsd-kind="Class">HttpHandler</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/server_basehttpserverfactory.basehttpserveroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseHttpServerOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="server_basehttpserverfactory.basehttpserverfactory.html" class="tsd-signature-type" data-tsd-kind="Class">BaseHttpServerFactory</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/0a68fbf/src/server/BaseHttpServerFactory.ts#L16">src/server/BaseHttpServerFactory.ts:16</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/server/BaseHttpServerFactory.ts#L44">src/server/BaseHttpServerFactory.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -135,6 +137,9 @@
<li>
<h5>handler: <a href="server_httphandler.httphandler.html" class="tsd-signature-type" data-tsd-kind="Class">HttpHandler</a></h5>
</li>
<li>
<h5>options: <a href="../interfaces/server_basehttpserverfactory.basehttpserveroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseHttpServerOptions</a><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="server_basehttpserverfactory.basehttpserverfactory.html" class="tsd-signature-type" data-tsd-kind="Class">BaseHttpServerFactory</a></h4>
</li>
@@ -149,7 +154,7 @@
<div class="tsd-signature tsd-kind-icon">handler<span class="tsd-signature-symbol">:</span> <a href="server_httphandler.httphandler.html" class="tsd-signature-type" data-tsd-kind="Class">HttpHandler</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/server/BaseHttpServerFactory.ts#L16">src/server/BaseHttpServerFactory.ts:16</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/server/BaseHttpServerFactory.ts#L43">src/server/BaseHttpServerFactory.ts:43</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -164,13 +169,40 @@
<div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="logging_logger.logger.html" class="tsd-signature-type" data-tsd-kind="Class">Logger</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/server/BaseHttpServerFactory.ts#L13">src/server/BaseHttpServerFactory.ts:13</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/server/BaseHttpServerFactory.ts#L40">src/server/BaseHttpServerFactory.ts:40</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="options" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/server_basehttpserverfactory.basehttpserveroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseHttpServerOptions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/server/BaseHttpServerFactory.ts#L44">src/server/BaseHttpServerFactory.ts:44</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 tsd-is-private">
<a name="createserveroptions" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>Server<wbr>Options</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">create<wbr>Server<wbr>Options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/server_basehttpserverfactory.basehttpserveroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseHttpServerOptions</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/d01382d/src/server/BaseHttpServerFactory.ts#L94">src/server/BaseHttpServerFactory.ts:94</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/server_basehttpserverfactory.basehttpserveroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BaseHttpServerOptions</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="startserver" class="tsd-anchor"></a>
<h3>start<wbr>Server</h3>
@@ -182,12 +214,12 @@
<aside class="tsd-sources">
<p>Implementation of HttpServerFactory.startServer</p>
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0a68fbf/src/server/BaseHttpServerFactory.ts#L26">src/server/BaseHttpServerFactory.ts:26</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/d01382d/src/server/BaseHttpServerFactory.ts#L55">src/server/BaseHttpServerFactory.ts:55</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates and starts an HTTP server</p>
<p>Creates and starts an HTTP(S) server</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -209,7 +241,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/server_basehttpserverfactory.html">server/<wbr>Base<wbr>Http<wbr>Server<wbr>Factory</a>
@@ -232,6 +264,12 @@
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected">
<a href="server_basehttpserverfactory.basehttpserverfactory.html#logger" class="tsd-kind-icon">logger</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="server_basehttpserverfactory.basehttpserverfactory.html#options" class="tsd-kind-icon">options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="server_basehttpserverfactory.basehttpserverfactory.html#createserveroptions" class="tsd-kind-icon">create<wbr>Server<wbr>Options</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="server_basehttpserverfactory.basehttpserverfactory.html#startserver" class="tsd-kind-icon">start<wbr>Server</a>
</li>
@@ -239,6 +277,9 @@
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/server_basehttpserverfactory.basehttpserveroptions.html" class="tsd-kind-icon">Base<wbr>Http<wbr>Server<wbr>Options</a>
</li>
</ul>
</nav>
</div>
@@ -266,10 +307,11 @@
<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-protected"><span class="tsd-kind-icon">Protected property</span></li>
<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>
<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-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
</ul>
</div>
</div>