Deployed 47675270 to v4.0.0-rc.1 with MkDocs 1.1.2 and mike 0.5.5

This commit is contained in:
GitHub Action committed 2020-11-26 14:56:14 +00:00
1 parent 42ab5fcb2e
commit eeac7d219e
520 files changed
+389593 -3653

No files matched your search

@@ -567,6 +567,30 @@
</li>
<li class="md-nav__item">
<a href="../../../guides/generator/" class="md-nav__link">
Generator
</a>
</li>
<li class="md-nav__item">
<a href="../../../guides/working-with-mobx/" class="md-nav__link">
Working with mobx
</a>
</li>
</ul>
</nav>
</li>
@@ -730,6 +754,18 @@
<li class="md-nav__item">
<a href="../../../../support/" class="md-nav__link">
Support
</a>
</li>
<li class="md-nav__item">
<a href="../../../../faq/" class="md-nav__link">
FAQ
@@ -998,6 +1034,20 @@
enable
</a>
</li>
<li class="md-nav__item">
<a href="#getextensionfilefolder" class="md-nav__link">
getExtensionFileFolder
</a>
</li>
<li class="md-nav__item">
<a href="#isenabledforcluster" class="md-nav__link">
isEnabledForCluster
</a>
</li>
<li class="md-nav__item">
@@ -1092,6 +1142,8 @@
<ul>
<li><a href="./#disable">disable</a></li>
<li><a href="./#enable">enable</a></li>
<li><a href="./#getextensionfilefolder">getExtensionFileFolder</a></li>
<li><a href="./#isenabledforcluster">isEnabledForCluster</a></li>
<li><a href="./#navigate">navigate</a></li>
<li><a href="./#protected-onactivate">onActivate</a></li>
<li><a href="./#protected-ondeactivate">onDeactivate</a></li>
@@ -1102,7 +1154,7 @@
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
<p>+ <strong>new LensRendererExtension</strong>(<code>__namedParameters</code>: object): <em><a href="./">LensRendererExtension</a></em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#constructor">constructor</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L21">src/extensions/lens-extension.ts:21</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L23">src/extensions/lens-extension.ts:23</a></em></p>
<p><strong>Parameters:</strong></p>
<p>▪ <strong>__namedParameters</strong>: <em>object</em></p>
<table>
@@ -1131,98 +1183,129 @@
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
<h3 id="apppreferences">appPreferences<a class="headerlink" href="#apppreferences" title="Permanent link">#</a></h3>
<p>• <strong>appPreferences</strong>: <em><a href="../../interfaces/_interfaces_index_.apppreferenceregistration/">AppPreferenceRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L12">src/extensions/lens-renderer-extension.ts:12</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L14">src/extensions/lens-renderer-extension.ts:14</a></em></p>
<hr />
<h3 id="clusterfeatures">clusterFeatures<a class="headerlink" href="#clusterfeatures" title="Permanent link">#</a></h3>
<p>• <strong>clusterFeatures</strong>: <em><a href="../../interfaces/_interfaces_index_.clusterfeatureregistration/">ClusterFeatureRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L13">src/extensions/lens-renderer-extension.ts:13</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L15">src/extensions/lens-renderer-extension.ts:15</a></em></p>
<hr />
<h3 id="clusterpagemenus">clusterPageMenus<a class="headerlink" href="#clusterpagemenus" title="Permanent link">#</a></h3>
<p>• <strong>clusterPageMenus</strong>: <em><a href="../../interfaces/_interfaces_index_.pagemenuregistration/">PageMenuRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L10">src/extensions/lens-renderer-extension.ts:10</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L12">src/extensions/lens-renderer-extension.ts:12</a></em></p>
<hr />
<h3 id="clusterpages">clusterPages<a class="headerlink" href="#clusterpages" title="Permanent link">#</a></h3>
<p>• <strong>clusterPages</strong>: <em><a href="../../interfaces/_interfaces_index_.pageregistration/">PageRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L8">src/extensions/lens-renderer-extension.ts:8</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L10">src/extensions/lens-renderer-extension.ts:10</a></em></p>
<hr />
<h3 id="globalpagemenus">globalPageMenus<a class="headerlink" href="#globalpagemenus" title="Permanent link">#</a></h3>
<p>• <strong>globalPageMenus</strong>: <em><a href="../../interfaces/_interfaces_index_.pagemenuregistration/">PageMenuRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L9">src/extensions/lens-renderer-extension.ts:9</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L11">src/extensions/lens-renderer-extension.ts:11</a></em></p>
<hr />
<h3 id="globalpages">globalPages<a class="headerlink" href="#globalpages" title="Permanent link">#</a></h3>
<p>• <strong>globalPages</strong>: <em><a href="../../interfaces/_interfaces_index_.pageregistration/">PageRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L7">src/extensions/lens-renderer-extension.ts:7</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L9">src/extensions/lens-renderer-extension.ts:9</a></em></p>
<hr />
<h3 id="isbundled">isBundled<a class="headerlink" href="#isbundled" title="Permanent link">#</a></h3>
<p>• <strong>isBundled</strong>: <em>boolean</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#isbundled">isBundled</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L19">src/extensions/lens-extension.ts:19</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L21">src/extensions/lens-extension.ts:21</a></em></p>
<hr />
<h3 id="kubeobjectdetailitems">kubeObjectDetailItems<a class="headerlink" href="#kubeobjectdetailitems" title="Permanent link">#</a></h3>
<p>• <strong>kubeObjectDetailItems</strong>: <em><a href="../../interfaces/_interfaces_index_.kubeobjectdetailregistration/">KubeObjectDetailRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L15">src/extensions/lens-renderer-extension.ts:15</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L17">src/extensions/lens-renderer-extension.ts:17</a></em></p>
<hr />
<h3 id="kubeobjectmenuitems">kubeObjectMenuItems<a class="headerlink" href="#kubeobjectmenuitems" title="Permanent link">#</a></h3>
<p>• <strong>kubeObjectMenuItems</strong>: <em><a href="../../interfaces/_interfaces_index_.kubeobjectmenuregistration/">KubeObjectMenuRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L16">src/extensions/lens-renderer-extension.ts:16</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L18">src/extensions/lens-renderer-extension.ts:18</a></em></p>
<hr />
<h3 id="kubeobjectstatustexts">kubeObjectStatusTexts<a class="headerlink" href="#kubeobjectstatustexts" title="Permanent link">#</a></h3>
<p>• <strong>kubeObjectStatusTexts</strong>: <em><a href="../../interfaces/_interfaces_index_.kubeobjectstatusregistration/">KubeObjectStatusRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L11">src/extensions/lens-renderer-extension.ts:11</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L13">src/extensions/lens-renderer-extension.ts:13</a></em></p>
<hr />
<h3 id="manifest">manifest<a class="headerlink" href="#manifest" title="Permanent link">#</a></h3>
<p>• <strong>manifest</strong>: <em>LensExtensionManifest</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#manifest">manifest</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L17">src/extensions/lens-extension.ts:17</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L19">src/extensions/lens-extension.ts:19</a></em></p>
<hr />
<h3 id="manifestpath">manifestPath<a class="headerlink" href="#manifestpath" title="Permanent link">#</a></h3>
<p>• <strong>manifestPath</strong>: <em>string</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#manifestpath">manifestPath</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L18">src/extensions/lens-extension.ts:18</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L20">src/extensions/lens-extension.ts:20</a></em></p>
<hr />
<h3 id="statusbaritems">statusBarItems<a class="headerlink" href="#statusbaritems" title="Permanent link">#</a></h3>
<p>• <strong>statusBarItems</strong>: <em><a href="../../interfaces/_interfaces_index_.statusbarregistration/">StatusBarRegistration</a>[]</em> = []</p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L14">src/extensions/lens-renderer-extension.ts:14</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L16">src/extensions/lens-renderer-extension.ts:16</a></em></p>
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
<h3 id="description">description<a class="headerlink" href="#description" title="Permanent link">#</a></h3>
<p>• <strong>get description</strong>(): <em>string</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#description">description</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L41">src/extensions/lens-extension.ts:41</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L55">src/extensions/lens-extension.ts:55</a></em></p>
<p><strong>Returns:</strong> <em>string</em></p>
<hr />
<h3 id="id">id<a class="headerlink" href="#id" title="Permanent link">#</a></h3>
<p>• <strong>get id</strong>(): <em>LensExtensionId</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#id">id</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L29">src/extensions/lens-extension.ts:29</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L31">src/extensions/lens-extension.ts:31</a></em></p>
<p><strong>Returns:</strong> <em>LensExtensionId</em></p>
<hr />
<h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">#</a></h3>
<p>• <strong>get name</strong>(): <em>string</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#name">name</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L33">src/extensions/lens-extension.ts:33</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L36">src/extensions/lens-extension.ts:36</a></em></p>
<p><strong>Returns:</strong> <em>string</em></p>
<hr />
<h3 id="version">version<a class="headerlink" href="#version" title="Permanent link">#</a></h3>
<p>• <strong>get version</strong>(): <em>string</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#version">version</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L37">src/extensions/lens-extension.ts:37</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L40">src/extensions/lens-extension.ts:40</a></em></p>
<p><strong>Returns:</strong> <em>string</em></p>
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
<p>▸ <strong>disable</strong>(): <em>Promise‹void›</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#disable">disable</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L54">src/extensions/lens-extension.ts:54</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L68">src/extensions/lens-extension.ts:68</a></em></p>
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
<hr />
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
<p>▸ <strong>enable</strong>(): <em>Promise‹void›</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#enable">enable</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L46">src/extensions/lens-extension.ts:46</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L60">src/extensions/lens-extension.ts:60</a></em></p>
<p><strong>Returns:</strong> <em>Promise‹void›</em></p>
<hr />
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
<p>▸ <strong>getExtensionFileFolder</strong>(): <em>Promise‹string›</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#getextensionfilefolder">getExtensionFileFolder</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L51">src/extensions/lens-extension.ts:51</a></em></p>
<p>getExtensionFileFolder returns the path to an already created folder. This
folder is for the sole use of this extension.</p>
<p>Note: there is no security done on this folder, only obfiscation of the
folder name.</p>
<p><strong>Returns:</strong> <em>Promise‹string›</em></p>
<hr />
<h3 id="isenabledforcluster">isEnabledForCluster<a class="headerlink" href="#isenabledforcluster" title="Permanent link">#</a></h3>
<p>▸ <strong>isEnabledForCluster</strong>(<code>cluster</code>: <a href="../_core_api_stores_.cluster/">Cluster</a>): <em>Promise‹Boolean›</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L33">src/extensions/lens-renderer-extension.ts:33</a></em></p>
<p>Defines if extension is enabled for a given cluster. Defaults to <code>true</code>.</p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>cluster</code></td>
<td><a href="../_core_api_stores_.cluster/">Cluster</a></td>
</tr>
</tbody>
</table>
<p><strong>Returns:</strong> <em>Promise‹Boolean›</em></p>
<hr />
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
<p>▸ <strong>navigate</strong>‹<strong>P</strong>›(<code>pageId?</code>: string, <code>params?</code>: P): <em>Promise‹void›</em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-renderer-extension.ts#L18">src/extensions/lens-renderer-extension.ts:18</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-renderer-extension.ts#L20">src/extensions/lens-renderer-extension.ts:20</a></em></p>
<p><strong>Type parameters:</strong></p>
<p>▪ <strong>P</strong>: <em>object</em></p>
<p><strong>Parameters:</strong></p>
@@ -1249,19 +1332,19 @@
<h3 id="protected-onactivate"><code>Protected</code> onActivate<a class="headerlink" href="#protected-onactivate" title="Permanent link">#</a></h3>
<p>▸ <strong>onActivate</strong>(): <em>void</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#protected-onactivate">onActivate</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L90">src/extensions/lens-extension.ts:90</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L105">src/extensions/lens-extension.ts:105</a></em></p>
<p><strong>Returns:</strong> <em>void</em></p>
<hr />
<h3 id="protected-ondeactivate"><code>Protected</code> onDeactivate<a class="headerlink" href="#protected-ondeactivate" title="Permanent link">#</a></h3>
<p>▸ <strong>onDeactivate</strong>(): <em>void</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#protected-ondeactivate">onDeactivate</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L94">src/extensions/lens-extension.ts:94</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L109">src/extensions/lens-extension.ts:109</a></em></p>
<p><strong>Returns:</strong> <em>void</em></p>
<hr />
<h3 id="toggle">toggle<a class="headerlink" href="#toggle" title="Permanent link">#</a></h3>
<p>▸ <strong>toggle</strong>(<code>enable?</code>: boolean): <em>void</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#toggle">toggle</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L61">src/extensions/lens-extension.ts:61</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L75">src/extensions/lens-extension.ts:75</a></em></p>
<p><strong>Parameters:</strong></p>
<table>
<thead>
@@ -1282,10 +1365,10 @@
<h3 id="whenenabled">whenEnabled<a class="headerlink" href="#whenenabled" title="Permanent link">#</a></h3>
<p>▸ <strong>whenEnabled</strong>(<code>handlers</code>: function): <em>Promise‹(Anonymous function)›</em></p>
<p><em>Inherited from <a href="../lensmainextension/">LensMainExtension</a>.<a href="../lensmainextension/#whenenabled">whenEnabled</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/fc3f48f4/src/extensions/lens-extension.ts#L69">src/extensions/lens-extension.ts:69</a></em></p>
<p><em>Defined in <a href="https://github.com/lensapp/lens/blob/47675270/src/extensions/lens-extension.ts#L83">src/extensions/lens-extension.ts:83</a></em></p>
<p><strong>Parameters:</strong></p>
<p>▪ <strong>handlers</strong>: <em>function</em></p>
<p>▸ (): <em>Function[]</em></p>
<p>▸ (): <em>Promise‹Function[]›</em></p>
<p><strong>Returns:</strong> <em>Promise‹(Anonymous function)›</em></p>
@@ -1353,7 +1436,7 @@
<script>
app = initialize({
base: "../../../..",
features: ['navigation.instant', 'toc.autohide', 'search.suggest', 'search.highlight'],
features: ['toc.autohide', 'search.suggest', 'search.highlight'],
search: Object.assign({
worker: "../../../../assets/javascripts/worker/search.0f64ce30.min.js"
}, typeof search !== "undefined" && search),