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>AppRunner | Community Solid Server - v1.0.0-beta.2</title>
<meta name="description" content="Documentation for Community Solid Server - v1.0.0-beta.2">
<title>AppRunner | 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/init_apprunner.html">init/AppRunner</a>
@@ -97,7 +97,6 @@
<ul class="tsd-index-list">
<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 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>
</ul>
@@ -130,7 +129,7 @@
<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/fdd1a37/src/init/AppRunner.ts#L22">src/init/AppRunner.ts:22</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/init/AppRunner.ts#L24">src/init/AppRunner.ts:24</a></li>
</ul>
</aside>
</section>
@@ -141,13 +140,13 @@
<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">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>
<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><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-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/fdd1a37/src/init/AppRunner.ts#L116">src/init/AppRunner.ts:116</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/init/AppRunner.ts#L118">src/init/AppRunner.ts:118</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -170,7 +169,7 @@
</div>
</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><span class="tsd-signature-symbol"> | </span><a href="../interfaces/init_apprunner.cliparams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</a></h5>
<h5>variables: <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-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>
<div class="tsd-comment tsd-typography">
<p>Variables to pass into the config file.</p>
</div>
@@ -190,7 +189,7 @@
<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>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/init/AppRunner.ts#L140">src/init/AppRunner.ts:140</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -208,38 +207,6 @@
</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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">resolve<wbr>File<wbr>Path<span class="tsd-signature-symbol">(</span>cwdPath<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, modulePath<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">string</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#L157">src/init/AppRunner.ts:157</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Resolves a path relative to the current working directory,
falling back to a path relative to this module.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> cwdPath: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>modulePath: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#x27;&#x27;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="run" class="tsd-anchor"></a>
<h3>run</h3>
@@ -250,7 +217,7 @@
<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#L31">src/init/AppRunner.ts:31</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/init/AppRunner.ts#L33">src/init/AppRunner.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -294,7 +261,7 @@
<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#L46">src/init/AppRunner.ts:46</a></li>
<li>Defined in <a href="https://github.com/solid/community-server/blob/ce27b55/src/init/AppRunner.ts#L48">src/init/AppRunner.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
@@ -362,9 +329,6 @@
<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 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>