mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
18 lines
20 KiB
HTML
18 lines
20 KiB
HTML
<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>AppRunner | Community Solid Server - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><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 - v2.0.0</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Community Solid Server - v2.0.0</a></li><li><a href="AppRunner.html">AppRunner</a></li></ul><h1>Class AppRunner</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">AppRunner</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="AppRunner.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-private tsd-is-private-protected"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="AppRunner.html#logger" class="tsd-kind-icon">logger</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"><a href="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="AppRunner.html#createVariables" class="tsd-kind-icon">create<wbr/>Variables</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AppRunner.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AppRunner.html#runCli" class="tsd-kind-icon">run<wbr/>Cli</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><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/>App<wbr/>Runner<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="AppRunner.html" class="tsd-signature-type" data-tsd-kind="Class">AppRunner</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"></aside><h4 class="tsd-returns-title">Returns <a href="AppRunner.html" class="tsd-signature-type" data-tsd-kind="Class">AppRunner</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a name="logger" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> logger</h3><div class="tsd-signature tsd-kind-icon">logger<span class="tsd-signature-symbol">:</span> <a href="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/216788e/src/init/AppRunner.ts#L24">src/init/AppRunner.ts:24</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"><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"><</span><a href="App.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">></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"><</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">></span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/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"><</span><a href="App.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">></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/216788e/src/init/AppRunner.ts#L118">src/init/AppRunner.ts:118</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates the main app object to start the server from a given config.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>loaderProperties: <span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>Components.js loader properties.</p>
|
|
</div></div></li><li><h5>configFile: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>Path to a Components.js config file.</p>
|
|
</div></div></li><li><h5>variables: <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/CliParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</a></h5><div class="tsd-comment tsd-typography"><div><p>Variables to pass into the config file.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">></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/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"><</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">></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/216788e/src/init/AppRunner.ts#L140">src/init/AppRunner.ts:140</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/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"><</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">></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><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"><</span><a href="App.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">></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/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"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></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/216788e/src/init/AppRunner.ts#L33">src/init/AppRunner.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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><ul class="tsd-parameters"><li><h5>loaderProperties: <span class="tsd-signature-type">IComponentsManagerBuilderOptions</span><span class="tsd-signature-symbol"><</span><a href="App.html" class="tsd-signature-type" data-tsd-kind="Class">App</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><div><p>Components.js loader properties.</p>
|
|
</div></div></li><li><h5>configFile: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div><p>Path to the server config file.</p>
|
|
</div></div></li><li><h5>variableParams: <a href="../interfaces/CliParams.html" class="tsd-signature-type" data-tsd-kind="Interface">CliParams</a></h5><div class="tsd-comment tsd-typography"><div><p>Variables to pass into the config file.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a name="runCli" class="tsd-anchor"></a><h3>run<wbr/>Cli</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">run<wbr/>Cli<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>argv<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>stderr<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WriteStream</span><span class="tsd-signature-symbol">; </span>stdin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReadStream</span><span class="tsd-signature-symbol">; </span>stdout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WriteStream</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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/216788e/src/init/AppRunner.ts#L48">src/init/AppRunner.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<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><ul class="tsd-parameters"><li><h5>__namedParameters: <span class="tsd-signature-symbol">{ </span>argv<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>stderr<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WriteStream</span><span class="tsd-signature-symbol">; </span>stdin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReadStream</span><span class="tsd-signature-symbol">; </span>stdout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WriteStream</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = {}</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> argv<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> stderr<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WriteStream</span></h5><div class="tsd-comment tsd-typography"><div><p>Standard error stream.</p>
|
|
</div></div></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> stdin<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReadStream</span></h5></li><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> stdout<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">WriteStream</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="AppRunner.html" class="tsd-kind-icon">App<wbr/>Runner</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="AppRunner.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="AppRunner.html#logger" class="tsd-kind-icon">logger</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="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="AppRunner.html#createVariables" class="tsd-kind-icon">create<wbr/>Variables</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AppRunner.html#run" class="tsd-kind-icon">run</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="AppRunner.html#runCli" class="tsd-kind-icon">run<wbr/>Cli</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</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-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected 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-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-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |