Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: fdd1a3732e

Browse Source
This commit is contained in:
RubenVerborgh
2021-07-30 15:22:58 +00:00
parent 9ba53b9d07
commit 7efe96d24f
518 changed files with 5397 additions and 4076 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
docs/classes/init_apprunner.apprunner.html
View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AppRunner | Community Solid Server - v1.0.0-beta.1</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.1">
<title>AppRunner | Community Solid Server - v1.0.0-beta.2</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
<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.1</a>
<a href="../index.html" class="title">Community Solid Server - v1.0.0-beta.2</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.1</a>
<a href="../modules.html">Community Solid Server - v1.0.0-beta.2</a>
</li>
<li>
<a href="../modules/init_apprunner.html">init/AppRunner</a>
@@ -95,9 +95,8 @@
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="init_apprunner.apprunner.html#createapp" class="tsd-kind-icon">create<wbr>App</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="init_apprunner.apprunner.html#createapp" class="tsd-kind-icon">create<wbr>App</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="init_apprunner.apprunner.html#createvariables" class="tsd-kind-icon">create<wbr>Variables</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="init_apprunner.apprunner.html#getapp" class="tsd-kind-icon">get<wbr>App</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="init_apprunner.apprunner.html#resolvefilepath" class="tsd-kind-icon">resolve<wbr>File<wbr>Path</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="init_apprunner.apprunner.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="init_apprunner.apprunner.html#runcli" class="tsd-kind-icon">run<wbr>Cli</a></li>
@@ -131,91 +130,29 @@
<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/0be8222/src/init/AppRunner.ts#L12">src/init/AppRunner.ts:12</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/init/AppRunner.ts#L22">src/init/AppRunner.ts:22</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-protected">
<a name="createapp" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>App</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">create<wbr>App<span class="tsd-signature-symbol">(</span>componentsProperties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</span>, configFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, variables<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</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/0be8222/src/init/AppRunner.ts#L145">src/init/AppRunner.ts:145</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Creates the server initializer</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>componentsProperties: <span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5>configFile: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>variables: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><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-protected">
<a name="createvariables" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Variables</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">create<wbr>Variables<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/init_apprunner.configvariables.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigVariables</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/0be8222/src/init/AppRunner.ts#L127">src/init/AppRunner.ts:127</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Translates command-line parameters into configuration variables</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>params: <a href="../interfaces/init_apprunner.configvariables.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigVariables</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</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">
<a name="getapp" class="tsd-anchor"></a>
<h3>get<wbr>App</h3>
<a name="createapp" class="tsd-anchor"></a>
<h3>create<wbr>App</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>App<span class="tsd-signature-symbol">(</span>loaderProperties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</span>, configFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, variableParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/init_apprunner.configvariables.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigVariables</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">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">create<wbr>App<span class="tsd-signature-symbol">(</span>loaderProperties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</span>, configFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, variables<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/init_apprunner.cliparams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</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">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</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/0be8222/src/init/AppRunner.ts#L20">src/init/AppRunner.ts:20</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/init/AppRunner.ts#L116">src/init/AppRunner.ts:116</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generic function for getting the app object to start the server from JavaScript for a given config.</p>
<p>Creates the main app object to start the server from a given config.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -229,11 +166,11 @@
<li>
<h5>configFile: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Path to the server config file.</p>
<p>Path to a Components.js config file.</p>
</div>
</li>
<li>
<h5>variableParams: <a href="../interfaces/init_apprunner.configvariables.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigVariables</a></h5>
<h5>variables: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/init_apprunner.cliparams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>Variables to pass into the config file.</p>
</div>
@@ -243,6 +180,34 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="createvariables" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> create<wbr>Variables</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">create<wbr>Variables<span class="tsd-signature-symbol">(</span>params<span class="tsd-signature-symbol">: </span><a href="../interfaces/init_apprunner.cliparams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</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/fdd1a37/src/init/AppRunner.ts#L138">src/init/AppRunner.ts:138</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Translates command-line parameters into Components.js variables.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>params: <a href="../interfaces/init_apprunner.cliparams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</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-protected">
<a name="resolvefilepath" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> resolve<wbr>File<wbr>Path</h3>
@@ -253,7 +218,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/init/AppRunner.ts#L118">src/init/AppRunner.ts:118</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/init/AppRunner.ts#L157">src/init/AppRunner.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -279,18 +244,19 @@
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>loaderProperties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</span>, configFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, variableParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/init_apprunner.configvariables.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigVariables</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">run<span class="tsd-signature-symbol">(</span>loaderProperties<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol">&lt;</span><a href="init_app.app.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">&gt;</span>, configFile<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, variableParams<span class="tsd-signature-symbol">: </span><a href="../interfaces/init_apprunner.cliparams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</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">&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">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/init/AppRunner.ts#L35">src/init/AppRunner.ts:35</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/init/AppRunner.ts#L31">src/init/AppRunner.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generic run function for starting the server from JavaScript for a given config.</p>
<p>Starts the server with a given config.
This method can be used to start the server from within another JavaScript application.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -308,7 +274,7 @@
</div>
</li>
<li>
<h5>variableParams: <a href="../interfaces/init_apprunner.configvariables.html" class="tsd-signature-type" data-tsd-kind="Interface">ConfigVariables</a></h5>
<h5>variableParams: <a href="../interfaces/init_apprunner.cliparams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>Variables to pass into the config file.</p>
</div>
@@ -328,13 +294,13 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/0be8222/src/init/AppRunner.ts#L50">src/init/AppRunner.ts:50</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/fdd1a37/src/init/AppRunner.ts#L46">src/init/AppRunner.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Generic run function for starting the server on the CLI from a given config
Made run to be non-async to lower the chance of unhandled promise rejection errors in the future.</p>
<p>Starts the server as a command-line application.
Made non-async to lower the risk of unhandled promise rejections.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -390,15 +356,12 @@
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="init_apprunner.apprunner.html#logger" class="tsd-kind-icon">logger</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="init_apprunner.apprunner.html#createapp" class="tsd-kind-icon">create<wbr>App</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="init_apprunner.apprunner.html#createvariables" class="tsd-kind-icon">create<wbr>Variables</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="init_apprunner.apprunner.html#getapp" class="tsd-kind-icon">get<wbr>App</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a href="init_apprunner.apprunner.html#resolvefilepath" class="tsd-kind-icon">resolve<wbr>File<wbr>Path</a>
</li>
@@ -413,7 +376,7 @@
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/init_apprunner.configvariables.html" class="tsd-kind-icon">Config<wbr>Variables</a>
<a href="../interfaces/init_apprunner.cliparams.html" class="tsd-kind-icon">Cli<wbr>Params</a>
</li>
</ul>
</nav>