Deployed 39149eedfd to master with MkDocs 1.1.2 and mike 1.0.1

This commit is contained in:
GitHub Action committed 2021-06-03 12:51:11 +00:00
1 parent 23d02dc632
commit 850f9c7602
234 files changed
+4205 -4205

No files matched your search

@@ -776,7 +776,7 @@
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
<p>+ <strong>new IpcRenderer</strong>(<code>extension</code>: <a href="../_renderer_api_index_.lensrendererextension/">LensRendererExtension</a>): <em><a href="./">IpcRenderer</a></em></p>
<p><em>Overrides void</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/extensions/ipc/ipc-renderer.ts#L28">src/extensions/ipc/ipc-renderer.ts:28</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/extensions/ipc/ipc-renderer.ts#L28">src/extensions/ipc/ipc-renderer.ts:28</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -797,17 +797,17 @@
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
<p>• <strong>[IpcPrefix]</strong>: <em>string</em></p>
<p><em>Inherited from <a href="./">IpcRenderer</a>.<a href="./#[ipcprefix]">[IpcPrefix]</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/extensions/ipc/ipc-registrar.ts#L29">src/extensions/ipc/ipc-registrar.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/extensions/ipc/ipc-registrar.ts#L29">src/extensions/ipc/ipc-registrar.ts:29</a></em></p>
<hr />
<h3 id="protected-extension"><code>Protected</code> extension<a class="headerlink" href="#protected-extension" title="Permanent link">#</a></h3>
<p>• <strong>extension</strong>: <em>LensExtension</em></p>
<p><em>Inherited from <a href="./">IpcRenderer</a>.<a href="./#protected-extension">extension</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/extensions/ipc/ipc-registrar.ts#L31">src/extensions/ipc/ipc-registrar.ts:31</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/extensions/ipc/ipc-registrar.ts#L31">src/extensions/ipc/ipc-registrar.ts:31</a></em></p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="broadcast">broadcast<a class="headerlink" href="#broadcast" title="Permanent link">#</a></h3>
<p>▸ <strong>broadcast</strong>(<code>channel</code>: string, ...<code>args</code>: any[]): <em>void</em></p>
<p><em>Inherited from <a href="./">IpcRenderer</a>.<a href="./#broadcast">broadcast</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/extensions/ipc/ipc-registrar.ts#L41">src/extensions/ipc/ipc-registrar.ts:41</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/extensions/ipc/ipc-registrar.ts#L41">src/extensions/ipc/ipc-registrar.ts:41</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -834,7 +834,7 @@
<hr />
<h3 id="invoke">invoke<a class="headerlink" href="#invoke" title="Permanent link">#</a></h3>
<p>▸ <strong>invoke</strong>(<code>channel</code>: string, ...<code>args</code>: any[]): <em>Promise‹any›</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/extensions/ipc/ipc-renderer.ts#L60">src/extensions/ipc/ipc-renderer.ts:60</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/extensions/ipc/ipc-renderer.ts#L60">src/extensions/ipc/ipc-renderer.ts:60</a></em></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>
@@ -865,7 +865,7 @@ An error will be thrown if no function has been registered on <code>main</code>
<hr />
<h3 id="listen">listen<a class="headerlink" href="#listen" title="Permanent link">#</a></h3>
<p>▸ <strong>listen</strong>(<code>channel</code>: string, <code>listener</code>: function): <em>Disposer</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/extensions/ipc/ipc-renderer.ts#L42">src/extensions/ipc/ipc-renderer.ts:42</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/extensions/ipc/ipc-renderer.ts#L42">src/extensions/ipc/ipc-renderer.ts:42</a></em></p>
<p>Listen for broadcasts within your extension.
If the lifetime of the listener should be tied to the mounted lifetime of
a component then putting the returned value in a <code>disposeOnUnmount</code> call will suffice.</p>
@@ -900,7 +900,7 @@ a component then putting the returned value in a <code>disposeOnUnmount</code> c
<h3 id="static-createinstance"><code>Static</code> createInstance<a class="headerlink" href="#static-createinstance" title="Permanent link">#</a></h3>
<p>▸ <strong>createInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, ...<code>args</code>: R): <em>T</em></p>
<p><em>Inherited from <a href="../_common_api_index_._common_api_stores_.extensionstore/">ExtensionStore</a>.<a href="../_common_api_index_._common_api_stores_.extensionstore/#static-createinstance">createInstance</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/common/utils/singleton.ts#L46">src/common/utils/singleton.ts:46</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/common/utils/singleton.ts#L46">src/common/utils/singleton.ts:46</a></em></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>
@@ -937,7 +937,7 @@ only the first's arguments will be used.</p>
<h3 id="static-getinstance"><code>Static</code> getInstance<a class="headerlink" href="#static-getinstance" title="Permanent link">#</a></h3>
<p>▸ <strong>getInstance</strong>‹<strong>T</strong>, <strong>R</strong>›(<code>this</code>: StaticThis‹T, R›, <code>strict</code>: boolean): <em>T | undefined</em></p>
<p><em>Inherited from <a href="../_common_api_index_._common_api_stores_.extensionstore/">ExtensionStore</a>.<a href="../_common_api_index_._common_api_stores_.extensionstore/#static-getinstance">getInstance</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/common/utils/singleton.ts#L67">src/common/utils/singleton.ts:67</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/common/utils/singleton.ts#L67">src/common/utils/singleton.ts:67</a></em></p>
<p>Get the instance of the child class that was previously created.</p>
<p><strong>Type parameters:</strong></p>
<p>▪ <strong>T</strong></p>
@@ -973,7 +973,7 @@ only the first's arguments will be used.</p>
<h3 id="static-resetinstance"><code>Static</code> resetInstance<a class="headerlink" href="#static-resetinstance" title="Permanent link">#</a></h3>
<p>▸ <strong>resetInstance</strong>(): <em>void</em></p>
<p><em>Inherited from <a href="../_common_api_index_._common_api_stores_.extensionstore/">ExtensionStore</a>.<a href="../_common_api_index_._common_api_stores_.extensionstore/#static-resetinstance">resetInstance</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/0ad44d6f40/src/common/utils/singleton.ts#L82">src/common/utils/singleton.ts:82</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/39149eedfd/src/common/utils/singleton.ts#L82">src/common/utils/singleton.ts:82</a></em></p>
<p>Delete the instance of the child class.</p>
<p>Note: this doesn't prevent callers of <code>getInstance</code> from storing the result in a global.</p>
<p>There is <em>no</em> way in JS or TS to prevent globals like that.</p>