mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 452042f5c5 to master with MkDocs 1.5.2 and mike 1.1.2
This commit is contained in:
GitHub Action committed
1 parent
02aaf1710c
commit
8f9ec26ed7
313 files changed
+14863
-14863
No files matched your search
@@ -17,7 +17,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.4.3, mkdocs-material-9.1.15">
|
||||
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.1.21">
|
||||
|
||||
|
||||
|
||||
@@ -25,7 +25,7 @@
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../../../../assets/stylesheets/main.26e3688c.min.css">
|
||||
<link rel="stylesheet" href="../../../../assets/stylesheets/main.eebd395e.min.css">
|
||||
|
||||
|
||||
<link rel="stylesheet" href="../../../../assets/stylesheets/palette.ecc896b0.min.css">
|
||||
@@ -908,14 +908,14 @@
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>extension</code></td>
|
||||
<td align="left"><a href="../Renderer.LensExtension/"><code>LensExtension</code></a></td>
|
||||
<td style="text-align: left;"><code>extension</code></td>
|
||||
<td style="text-align: left;"><a href="../Renderer.LensExtension/"><code>LensExtension</code></a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -938,21 +938,21 @@
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
<th style="text-align: left;">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<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>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>...args</code></td>
|
||||
<td align="left"><code>any</code>[]</td>
|
||||
<td align="left">The arguments passed to all listeners</td>
|
||||
<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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -962,7 +962,7 @@
|
||||
<p>IpcRegistrar.broadcast</p>
|
||||
<hr />
|
||||
<h3 id="invoke">invoke<a class="headerlink" href="#invoke" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>invoke</strong>(<code>channel</code>, <code>...args</code>): <code>Promise</code><<code>any</code>></p>
|
||||
<p>▸ <strong>invoke</strong>(<code>channel</code>, <code>...args</code>): <code>Promise</code><<code>any</code>></p>
|
||||
<p>Request main to execute its function over the <code>channel</code> channel.
|
||||
This function only interacts with functions registered via <code>Ipc.IpcMain.handleRpc</code>
|
||||
An error will be thrown if no function has been registered on <code>main</code> with this channel ID.</p>
|
||||
@@ -970,26 +970,26 @@ An error will be thrown if no function has been registered on <code>main</code>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
<th style="text-align: left;">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>channel</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The channel to invoke a RPC on</td>
|
||||
<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 invoke a RPC on</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>...args</code></td>
|
||||
<td align="left"><code>any</code>[]</td>
|
||||
<td align="left">The arguments to pass to the RPC</td>
|
||||
<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 to pass to the RPC</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>any</code>></p>
|
||||
<p><code>Promise</code><<code>any</code>></p>
|
||||
<p>A promise of the resulting value</p>
|
||||
<hr />
|
||||
<h3 id="listen">listen<a class="headerlink" href="#listen" title="Permanent link">#</a></h3>
|
||||
@@ -1001,21 +1001,21 @@ a component then putting the returned value in a <code>disposeOnUnmount</code> c
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
<th style="text-align: left;">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<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>
|
||||
<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>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>listener</code></td>
|
||||
<td align="left">(<code>event</code>: <code>IpcRendererEvent</code>, ...<code>args</code>: <code>any</code>[]) => <code>any</code></td>
|
||||
<td align="left">The function that will be called with the arguments of the broadcast</td>
|
||||
<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>[]) => <code>any</code></td>
|
||||
<td style="text-align: left;">The function that will be called with the arguments of the broadcast</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1024,7 +1024,7 @@ a component then putting the returned value in a <code>disposeOnUnmount</code> c
|
||||
<p>An optional disposer, Lens will cleanup 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><<code>T</code>, <code>R</code>>(<code>this</code>, <code>...args</code>): <code>T</code></p>
|
||||
<p>▸ <code>Static</code> <strong>createInstance</strong><<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>
|
||||
@@ -1034,18 +1034,18 @@ only the first's arguments will be used.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left">extends <a href="../Common.Util.Singleton/"><code>Singleton</code></a><<code>T</code>></td>
|
||||
<td style="text-align: left;"><code>T</code></td>
|
||||
<td style="text-align: left;">extends <a href="../Common.Util.Singleton/"><code>Singleton</code></a><<code>T</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">extends <code>any</code>[]</td>
|
||||
<td style="text-align: left;"><code>R</code></td>
|
||||
<td style="text-align: left;">extends <code>any</code>[]</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1053,21 +1053,21 @@ only the first's arguments will be used.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
<th style="text-align: left;">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
<td style="text-align: left;"><code>this</code></td>
|
||||
<td style="text-align: left;"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td style="text-align: left;">Implicit argument that is the child class type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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>
|
||||
<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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1078,24 +1078,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><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict?</code>): <code>T</code></p>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<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 align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td style="text-align: left;"><code>T</code></td>
|
||||
<td style="text-align: left;"><code>T</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">extends <code>any</code>[]</td>
|
||||
<td style="text-align: left;"><code>R</code></td>
|
||||
<td style="text-align: left;">extends <code>any</code>[]</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1103,21 +1103,21 @@ only the first's arguments will be used.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
<th style="text-align: left;">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
<td style="text-align: left;"><code>this</code></td>
|
||||
<td style="text-align: left;"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td style="text-align: left;">Implicit argument that is the child class type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<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>
|
||||
<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>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1126,23 +1126,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><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict</code>): <code>undefined</code> | <code>T</code></p>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<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 align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td style="text-align: left;"><code>T</code></td>
|
||||
<td style="text-align: left;"><code>T</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">extends <code>any</code>[]</td>
|
||||
<td style="text-align: left;"><code>R</code></td>
|
||||
<td style="text-align: left;">extends <code>any</code>[]</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1150,18 +1150,18 @@ only the first's arguments will be used.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th style="text-align: left;">Name</th>
|
||||
<th style="text-align: left;">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td style="text-align: left;"><code>this</code></td>
|
||||
<td style="text-align: left;"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strict</code></td>
|
||||
<td align="left"><code>false</code></td>
|
||||
<td style="text-align: left;"><code>strict</code></td>
|
||||
<td style="text-align: left;"><code>false</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1253,10 +1253,10 @@ only the first's arguments will be used.</p>
|
||||
<div class="md-dialog__inner md-typeset"></div>
|
||||
</div>
|
||||
|
||||
<script id="__config" type="application/json">{"base": "../../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../../assets/javascripts/workers/search.208ed371.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
|
||||
<script id="__config" type="application/json">{"base": "../../../..", "features": ["toc.autohide", "search.suggest", "search.highlight", "content.code.copy"], "search": "../../../../assets/javascripts/workers/search.74e28a9f.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
|
||||
|
||||
|
||||
<script src="../../../../assets/javascripts/bundle.b4d07000.min.js"></script>
|
||||
<script src="../../../../assets/javascripts/bundle.220ee61c.min.js"></script>
|
||||
|
||||
|
||||
</body>
|
||||
|
||||
Reference in new issue
Block a user