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">
@@ -901,14 +901,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>extension</code></td>
<td style="text-align: left;"><a href="../Main.LensExtension/"><code>LensExtension</code></a></td>
<td align="left"><code>extension</code></td>
<td align="left"><a href="../Main.LensExtension/"><code>LensExtension</code></a></td>
</tr>
</tbody>
</table>
@@ -921,7 +921,7 @@
<p>IpcRegistrar.__@IpcPrefix@80659</p>
<hr />
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>&gt;</p>
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code>&lt;<code>LensExtensionDependencies</code>></p>
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
<p>IpcRegistrar.extension</p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
@@ -931,21 +931,21 @@
<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>channel</code></td>
<td style="text-align: left;"><code>string</code></td>
<td style="text-align: left;">The channel to broadcast to your whole extension, both <code>main</code> and <code>renderer</code></td>
<td align="left"><code>channel</code></td>
<td align="left"><code>string</code></td>
<td align="left">The channel to broadcast to your whole extension, both <code>main</code> and <code>renderer</code></td>
</tr>
<tr>
<td style="text-align: left;"><code>...args</code></td>
<td style="text-align: left;"><code>any</code>[]</td>
<td style="text-align: left;">The arguments passed to all listeners</td>
<td align="left"><code>...args</code></td>
<td align="left"><code>any</code>[]</td>
<td align="left">The arguments passed to all listeners</td>
</tr>
</tbody>
</table>
@@ -961,21 +961,21 @@
<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>channel</code></td>
<td style="text-align: left;"><code>string</code></td>
<td style="text-align: left;">The name of the RPC</td>
<td align="left"><code>channel</code></td>
<td align="left"><code>string</code></td>
<td align="left">The name of the RPC</td>
</tr>
<tr>
<td style="text-align: left;"><code>handler</code></td>
<td style="text-align: left;">(<code>event</code>: <code>IpcMainInvokeEvent</code>, ...<code>args</code>: <code>any</code>[]) =&gt; <code>any</code></td>
<td style="text-align: left;">The remote procedure that is called</td>
<td align="left"><code>handler</code></td>
<td align="left">(<code>event</code>: <code>IpcMainInvokeEvent</code>, ...<code>args</code>: <code>any</code>[]) =&gt; <code>any</code></td>
<td align="left">The remote procedure that is called</td>
</tr>
</tbody>
</table>
@@ -989,21 +989,21 @@
<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>channel</code></td>
<td style="text-align: left;"><code>string</code></td>
<td style="text-align: left;">The channel to listen for broadcasts on</td>
<td align="left"><code>channel</code></td>
<td align="left"><code>string</code></td>
<td align="left">The channel to listen for broadcasts on</td>
</tr>
<tr>
<td style="text-align: left;"><code>listener</code></td>
<td style="text-align: left;">(<code>event</code>: <code>IpcRendererEvent</code>, ...<code>args</code>: <code>any</code>[]) =&gt; <code>any</code></td>
<td style="text-align: left;">The function that will be called with the arguments of the broadcast</td>
<td align="left"><code>listener</code></td>
<td align="left">(<code>event</code>: <code>IpcRendererEvent</code>, ...<code>args</code>: <code>any</code>[]) =&gt; <code>any</code></td>
<td align="left">The function that will be called with the arguments of the broadcast</td>
</tr>
</tbody>
</table>
@@ -1012,7 +1012,7 @@
<p>An optional disposer, Lens will cleanup when the extension is disabled or uninstalled even if this is not called</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>
@@ -1022,18 +1022,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>
@@ -1041,21 +1041,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>
@@ -1066,24 +1066,24 @@ only the first's arguments will be used.</p>
<p>IpcRegistrar.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_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 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>
@@ -1091,21 +1091,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>
@@ -1114,23 +1114,23 @@ only the first's arguments will be used.</p>
<p>An instance of the child class</p>
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
<p>IpcRegistrar.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_2">Type parameters<a class="headerlink" href="#type-parameters_2" 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>
@@ -1138,18 +1138,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>