Deployed 514c6e5bb7 to master with MkDocs 1.3.1 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2022-07-19 12:54:14 +00:00
1 parent 160bf97245
commit ed00a1e72f
294 files changed
+19570 -19570

No files matched your search

@@ -19,7 +19,7 @@
<link rel="icon" href="../../../../img/favicon.ico">
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-7.1.8+insiders-2.9.2">
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
@@ -1014,24 +1014,24 @@
<h1 id="class-extensionstoret">Class: ExtensionStore&lt;T&gt;<a class="headerlink" href="#class-extensionstoret" title="Permanent link">#</a></h1>
<h1 id="class-extensionstoret">Class: ExtensionStore&lt;T><a class="headerlink" href="#class-extensionstoret" title="Permanent link">#</a></h1>
<p><a href="../../modules/Common/">Common</a>.<a href="../../modules/Common.Store/">Store</a>.ExtensionStore</p>
<h2 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h2>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th align="left">Name</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>T</code></td>
</tr>
</tbody>
</table>
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
<ul>
<li><code>BaseStore</code>&lt;<code>T</code>&gt;</li>
<li><code>BaseStore</code>&lt;<code>T</code>></li>
</ul>
<p>↳ <strong><code>ExtensionStore</code></strong></p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
@@ -1075,17 +1075,17 @@
</ul>
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>new ExtensionStore</strong>&lt;<code>T</code>&gt;(<code>params</code>)</p>
<p>• <code>Protected</code> <strong>new ExtensionStore</strong>&lt;<code>T</code>>(<code>params</code>)</p>
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th align="left">Name</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>T</code></td>
</tr>
</tbody>
</table>
@@ -1093,19 +1093,19 @@
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>params</code></td>
<td style="text-align: left;"><code>BaseStoreParams</code>&lt;<code>T</code>&gt;</td>
<td align="left"><code>params</code></td>
<td align="left"><code>BaseStoreParams</code>&lt;<code>T</code>></td>
</tr>
</tbody>
</table>
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
<p>BaseStore&lt;T&gt;.constructor</p>
<p>BaseStore&lt;T>.constructor</p>
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="displayname">displayName<a class="headerlink" href="#displayname" title="Permanent link">#</a></h3>
<p>• <code>Readonly</code> <strong>displayName</strong>: <code>"ExtensionStore&lt;T&gt;"</code></p>
@@ -1113,15 +1113,15 @@
<p>BaseStore.displayName</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <code>Optional</code> <strong>extension</strong>: <code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>&gt;</p>
<p>• <code>Protected</code> <code>Optional</code> <strong>extension</strong>: <code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>></p>
<hr />
<h3 id="params">params<a class="headerlink" href="#params" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>params</strong>: <code>BaseStoreParams</code>&lt;<code>T</code>&gt;</p>
<p>• <code>Protected</code> <strong>params</strong>: <code>BaseStoreParams</code>&lt;<code>T</code>></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p>BaseStore.params</p>
<hr />
<h3 id="storeconfig">storeConfig<a class="headerlink" href="#storeconfig" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <code>Optional</code> <strong>storeConfig</strong>: <code>Conf</code>&lt;<code>T</code>&gt;</p>
<p>• <code>Protected</code> <code>Optional</code> <strong>storeConfig</strong>: <code>Conf</code>&lt;<code>T</code>></p>
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
<p>BaseStore.storeConfig</p>
<hr />
@@ -1164,14 +1164,14 @@
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>callback</code></td>
<td style="text-align: left;">() =&gt; <code>void</code></td>
<td align="left"><code>callback</code></td>
<td align="left">() =&gt; <code>void</code></td>
</tr>
</tbody>
</table>
@@ -1210,16 +1210,16 @@ system.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Description</th>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>data</code></td>
<td style="text-align: left;"><code>T</code></td>
<td style="text-align: left;">the parsed information read from the stored JSON file</td>
<td align="left"><code>data</code></td>
<td align="left"><code>T</code></td>
<td align="left">the parsed information read from the stored JSON file</td>
</tr>
</tbody>
</table>
@@ -1241,14 +1241,14 @@ system.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>extension</code></td>
<td style="text-align: left;"><code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>&gt;</td>
<td align="left"><code>extension</code></td>
<td align="left"><code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>></td>
</tr>
</tbody>
</table>
@@ -1261,14 +1261,14 @@ system.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>model</code></td>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>model</code></td>
<td align="left"><code>T</code></td>
</tr>
</tbody>
</table>
@@ -1283,14 +1283,14 @@ system.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>model</code></td>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>model</code></td>
<td align="left"><code>T</code></td>
</tr>
</tbody>
</table>
@@ -1305,14 +1305,14 @@ system.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>model</code></td>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>model</code></td>
<td align="left"><code>T</code></td>
</tr>
</tbody>
</table>
@@ -1327,14 +1327,14 @@ system.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>model</code></td>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>model</code></td>
<td align="left"><code>T</code></td>
</tr>
</tbody>
</table>
@@ -1362,7 +1362,7 @@ produce a JSON serializable object representation of the current state.</p>
<p>BaseStore.unregisterIpcListener</p>
<hr />
<h3 id="createinstance">createInstance<a class="headerlink" href="#createinstance" title="Permanent link">#</a></h3>
<p>▸ <code>Static</code> <strong>createInstance</strong>&lt;<code>T</code>, <code>R</code>&gt;(<code>this</code>, ...<code>args</code>): <code>T</code></p>
<p>▸ <code>Static</code> <strong>createInstance</strong>&lt;<code>T</code>, <code>R</code>>(<code>this</code>, ...<code>args</code>): <code>T</code></p>
<p>Creates the single instance of the child class if one was not already created.</p>
<p>Multiple calls will return the same instance.
Essentially throwing away the arguments to the subsequent calls.</p>
@@ -1372,18 +1372,18 @@ only the first's arguments will be used.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>T</code></td>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>T</code></td>
<td align="left"><code>T</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>R</code></td>
<td style="text-align: left;">extends <code>any</code>[]</td>
<td align="left"><code>R</code></td>
<td align="left">extends <code>any</code>[]</td>
</tr>
</tbody>
</table>
@@ -1391,21 +1391,21 @@ only the first's arguments will be used.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Description</th>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>this</code></td>
<td style="text-align: left;"><code>StaticThis</code>&lt;<code>T</code>, <code>R</code>&gt;</td>
<td style="text-align: left;">Implicit argument that is the child class type</td>
<td align="left"><code>this</code></td>
<td align="left"><code>StaticThis</code>&lt;<code>T</code>, <code>R</code>></td>
<td align="left">Implicit argument that is the child class type</td>
</tr>
<tr>
<td style="text-align: left;"><code>...args</code></td>
<td style="text-align: left;"><code>R</code></td>
<td style="text-align: left;">The constructor arguments for the child class</td>
<td align="left"><code>...args</code></td>
<td align="left"><code>R</code></td>
<td align="left">The constructor arguments for the child class</td>
</tr>
</tbody>
</table>
@@ -1416,24 +1416,24 @@ only the first's arguments will be used.</p>
<p>BaseStore.createInstance</p>
<hr />
<h3 id="getinstance">getInstance<a class="headerlink" href="#getinstance" title="Permanent link">#</a></h3>
<p>▸ <code>Static</code> <strong>getInstance</strong>&lt;<code>T</code>, <code>R</code>&gt;(<code>this</code>, <code>strict?</code>): <code>T</code></p>
<p>▸ <code>Static</code> <strong>getInstance</strong>&lt;<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict?</code>): <code>T</code></p>
<p>Get the instance of the child class that was previously created.</p>
<h4 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>T</code></td>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>T</code></td>
<td align="left"><code>T</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>R</code></td>
<td style="text-align: left;">extends <code>any</code>[]</td>
<td align="left"><code>R</code></td>
<td align="left">extends <code>any</code>[]</td>
</tr>
</tbody>
</table>
@@ -1441,21 +1441,21 @@ only the first's arguments will be used.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th style="text-align: left;">Description</th>
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>this</code></td>
<td style="text-align: left;"><code>StaticThis</code>&lt;<code>T</code>, <code>R</code>&gt;</td>
<td style="text-align: left;">Implicit argument that is the child class type</td>
<td align="left"><code>this</code></td>
<td align="left"><code>StaticThis</code>&lt;<code>T</code>, <code>R</code>></td>
<td align="left">Implicit argument that is the child class type</td>
</tr>
<tr>
<td style="text-align: left;"><code>strict?</code></td>
<td style="text-align: left;"><code>true</code></td>
<td style="text-align: left;">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
<td align="left"><code>strict?</code></td>
<td align="left"><code>true</code></td>
<td align="left">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
</tr>
</tbody>
</table>
@@ -1464,23 +1464,23 @@ only the first's arguments will be used.</p>
<p>An instance of the child class</p>
<h4 id="inherited-from_19">Inherited from<a class="headerlink" href="#inherited-from_19" title="Permanent link">#</a></h4>
<p>BaseStore.getInstance</p>
<p>▸ <code>Static</code> <strong>getInstance</strong>&lt;<code>T</code>, <code>R</code>&gt;(<code>this</code>, <code>strict</code>): <code>undefined</code> | <code>T</code></p>
<p>▸ <code>Static</code> <strong>getInstance</strong>&lt;<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict</code>): <code>undefined</code> | <code>T</code></p>
<h4 id="type-parameters_4">Type parameters<a class="headerlink" href="#type-parameters_4" title="Permanent link">#</a></h4>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>T</code></td>
<td style="text-align: left;"><code>T</code></td>
<td align="left"><code>T</code></td>
<td align="left"><code>T</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>R</code></td>
<td style="text-align: left;">extends <code>any</code>[]</td>
<td align="left"><code>R</code></td>
<td align="left">extends <code>any</code>[]</td>
</tr>
</tbody>
</table>
@@ -1488,18 +1488,18 @@ only the first's arguments will be used.</p>
<table>
<thead>
<tr>
<th style="text-align: left;">Name</th>
<th style="text-align: left;">Type</th>
<th align="left">Name</th>
<th align="left">Type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;"><code>this</code></td>
<td style="text-align: left;"><code>StaticThis</code>&lt;<code>T</code>, <code>R</code>&gt;</td>
<td align="left"><code>this</code></td>
<td align="left"><code>StaticThis</code>&lt;<code>T</code>, <code>R</code>></td>
</tr>
<tr>
<td style="text-align: left;"><code>strict</code></td>
<td style="text-align: left;"><code>false</code></td>
<td align="left"><code>strict</code></td>
<td align="left"><code>false</code></td>
</tr>
</tbody>
</table>