mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 41fc9089b5 to master with MkDocs 1.3.0 and mike 1.1.2
This commit is contained in:
1 parent
86376f8a6f
commit
8fa0529b3e
75 files changed
+638
-542
No files matched your search
@@ -786,8 +786,6 @@
|
||||
<h2 id="variables_1">Variables<a class="headerlink" href="#variables_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="appeventbus">appEventBus<a class="headerlink" href="#appeventbus" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Const</code> <strong>appEventBus</strong>: <code>EventEmitter</code><[<a href="../../interfaces/Common.EventBus.AppEvent/"><code>AppEvent</code></a>]></p>
|
||||
<p>Copyright (c) OpenLens Authors. All rights reserved.
|
||||
Licensed under MIT License. See LICENSE in root directory for more information.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -775,27 +775,23 @@
|
||||
<h2 id="functions_1">Functions<a class="headerlink" href="#functions_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="resolvesystemproxy">resolveSystemProxy<a class="headerlink" href="#resolvesystemproxy" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>resolveSystemProxy</strong>(<code>url</code>): <code>Promise</code><<code>string</code>></p>
|
||||
<p>Resolves URL-specific proxy information from system. See more here: https://www.electronjs.org/docs/latest/api/session#sesresolveproxyurl</p>
|
||||
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>url</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The URL for proxy information</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>string</code>></p>
|
||||
<p>Promise for proxy information as string</p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -877,19 +877,24 @@ running.</p>
|
||||
<hr />
|
||||
<h3 id="openexternal">openExternal<a class="headerlink" href="#openexternal" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>openExternal</strong>(<code>url</code>): <code>Promise</code><<code>void</code>></p>
|
||||
<p><strong><code>deprecated</code></strong> use openBrowser</p>
|
||||
<p>Opens a link using the program configured as the default browser
|
||||
on the target platform. Will reject URLs with a scheme other than
|
||||
http or https to prevent programs other than the default browser
|
||||
running.</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>url</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
<td align="left">The URL to open</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@@ -1192,8 +1192,6 @@
|
||||
|
||||
<h1 id="namespace-k8sapi">Namespace: K8sApi<a class="headerlink" href="#namespace-k8sapi" title="Permanent link">#</a></h1>
|
||||
<p><a href="../Main/">Main</a>.K8sApi</p>
|
||||
<p>Copyright (c) OpenLens Authors. All rights reserved.
|
||||
Licensed under MIT License. See LICENSE in root directory for more information.</p>
|
||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||
<h3 id="references">References<a class="headerlink" href="#references" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
@@ -1428,7 +1426,8 @@ Licensed under MIT License. See LICENSE in root directory for more information.<
|
||||
<h2 id="functions_1">Functions<a class="headerlink" href="#functions_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="isallowedresource">isAllowedResource<a class="headerlink" href="#isallowedresource" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>isAllowedResource</strong>(...<code>args</code>): <code>boolean</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function never works</p>
|
||||
<p>Copyright (c) OpenLens Authors. All rights reserved.
|
||||
Licensed under MIT License. See LICENSE in root directory for more information.</p>
|
||||
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -1446,7 +1445,6 @@ Licensed under MIT License. See LICENSE in root directory for more information.<
|
||||
</table>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>boolean</code></p>
|
||||
<p>false</p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -830,76 +830,63 @@
|
||||
<h2 id="functions_1">Functions<a class="headerlink" href="#functions_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="onresume">onResume<a class="headerlink" href="#onresume" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>onResume</strong>(<code>listener</code>): <code>Disposer</code></p>
|
||||
<p>Adds event listener to system resume event</p>
|
||||
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>listener</code></td>
|
||||
<td align="left"><a href="./#powereventlistener"><code>PowerEventListener</code></a></td>
|
||||
<td align="left">function which will be called on system resume</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>Disposer</code></p>
|
||||
<p>function to remove event listener</p>
|
||||
<hr />
|
||||
<h3 id="onshutdown">onShutdown<a class="headerlink" href="#onshutdown" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>onShutdown</strong>(<code>listener</code>): <code>Disposer</code></p>
|
||||
<p>Adds event listener to the event which is emitted when
|
||||
the system is about to reboot or shut down</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>listener</code></td>
|
||||
<td align="left"><a href="./#powereventlistener"><code>PowerEventListener</code></a></td>
|
||||
<td align="left">function which will be called on system shutdown</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>Disposer</code></p>
|
||||
<p>function to remove event listener</p>
|
||||
<hr />
|
||||
<h3 id="onsuspend">onSuspend<a class="headerlink" href="#onsuspend" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>onSuspend</strong>(<code>listener</code>): <code>Disposer</code></p>
|
||||
<p>Adds event listener to system suspend events</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>listener</code></td>
|
||||
<td align="left"><a href="./#powereventlistener"><code>PowerEventListener</code></a></td>
|
||||
<td align="left">function which will be called on system suspend</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>Disposer</code></p>
|
||||
<p>function to remove event listener</p>
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -2396,7 +2396,6 @@
|
||||
<hr />
|
||||
<h3 id="getdetailsurl">getDetailsUrl<a class="headerlink" href="#getdetailsurl" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getDetailsUrl</strong>(<code>selfLink</code>, <code>resetSelected?</code>, <code>mergeGlobals?</code>): <code>string</code></p>
|
||||
<p><strong><code>deprecated</code></strong> use <code>di.inject(getDetailsUrlInjectable)</code> instead</p>
|
||||
<h4 id="parameters_21">Parameters<a class="headerlink" href="#parameters_21" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@@ -2528,23 +2527,26 @@
|
||||
<hr />
|
||||
<h3 id="showdetails">showDetails<a class="headerlink" href="#showdetails" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>showDetails</strong>(<code>selfLink</code>, <code>resetSelected?</code>): <code>void</code></p>
|
||||
<p><strong><code>deprecated</code></strong> use <code>di.inject(showDetailsInjectable)</code> instead</p>
|
||||
<p><strong><code>default</code></strong> resetSelected true</p>
|
||||
<h4 id="parameters_26">Parameters<a class="headerlink" href="#parameters_26" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>selfLink</code></td>
|
||||
<td align="left"><code>undefined</code> | <code>string</code></td>
|
||||
<td align="left">The Kube selflink to show details for</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>resetSelected?</code></td>
|
||||
<td align="left"><code>boolean</code></td>
|
||||
<td align="left">If true then will reset the selected kube object (which object is highlighted generally)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@@ -946,22 +946,26 @@
|
||||
<hr />
|
||||
<h3 id="showdetails">showDetails<a class="headerlink" href="#showdetails" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>showDetails</strong>(<code>selfLink</code>, <code>resetSelected?</code>): <code>void</code></p>
|
||||
<p><strong><code>default</code></strong> resetSelected true</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>selfLink</code></td>
|
||||
<td align="left"><code>undefined</code> | <code>string</code></td>
|
||||
<td align="left">The Kube selflink to show details for</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>resetSelected?</code></td>
|
||||
<td align="left"><code>boolean</code></td>
|
||||
<td align="left">If true then will reset the selected kube object (which object is highlighted generally)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Reference in new issue
Block a user