mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 514c6e5bb7 to master with MkDocs 1.3.1 and mike 1.1.2
This commit is contained in:
GitHub Action committed
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">
|
||||
|
||||
|
||||
|
||||
@@ -1123,7 +1123,7 @@
|
||||
<p><a href="../../modules/Renderer/">Renderer</a>.LensExtension</p>
|
||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||
<ul>
|
||||
<li><code>LensExtension</code><<code>LensRendererExtensionDependencies</code>></li>
|
||||
<li><code>LensExtension</code><<code>LensRendererExtensionDependencies</code>></li>
|
||||
</ul>
|
||||
<p>↳ <strong><code>LensExtension</code></strong></p>
|
||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||
@@ -1188,19 +1188,19 @@
|
||||
<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>__namedParameters</code></td>
|
||||
<td style="text-align: left;"><code>InstalledExtension</code></td>
|
||||
<td align="left"><code>__namedParameters</code></td>
|
||||
<td align="left"><code>InstalledExtension</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension<LensRendererExtensionDependencies>.constructor</p>
|
||||
<p>LensExtension<LensRendererExtensionDependencies>.constructor</p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
@@ -1222,7 +1222,7 @@
|
||||
<p>• <strong>appPreferences</strong>: <a href="../../interfaces/Common.Types.AppPreferenceRegistration/"><code>AppPreferenceRegistration</code></a>[] = <code>[]</code></p>
|
||||
<hr />
|
||||
<h3 id="catalogentitydetailitems">catalogEntityDetailItems<a class="headerlink" href="#catalogentitydetailitems" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>catalogEntityDetailItems</strong>: <code>CatalogEntityDetailRegistration</code><<a href="../Common.Catalog.CatalogEntity/"><code>CatalogEntity</code></a><<a href="../../interfaces/Common.Catalog.CatalogEntityMetadata/"><code>CatalogEntityMetadata</code></a>, <a href="../../interfaces/Common.Catalog.CatalogEntityStatus/"><code>CatalogEntityStatus</code></a>, <a href="../../modules/Common.Catalog/#catalogentityspec"><code>CatalogEntitySpec</code></a>>>[] = <code>[]</code></p>
|
||||
<p>• <strong>catalogEntityDetailItems</strong>: <code>CatalogEntityDetailRegistration</code><<a href="../Common.Catalog.CatalogEntity/"><code>CatalogEntity</code></a><<a href="../../interfaces/Common.Catalog.CatalogEntityMetadata/"><code>CatalogEntityMetadata</code></a>, <a href="../../interfaces/Common.Catalog.CatalogEntityStatus/"><code>CatalogEntityStatus</code></a>, <a href="../../modules/Common.Catalog/#catalogentityspec"><code>CatalogEntitySpec</code></a>>>[] = <code>[]</code></p>
|
||||
<hr />
|
||||
<h3 id="clusterpagemenus">clusterPageMenus<a class="headerlink" href="#clusterpagemenus" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>clusterPageMenus</strong>: <a href="../../interfaces/Common.Types.ClusterPageMenuRegistration/"><code>ClusterPageMenuRegistration</code></a>[] = <code>[]</code></p>
|
||||
@@ -1253,7 +1253,7 @@
|
||||
<p>LensExtension.isBundled</p>
|
||||
<hr />
|
||||
<h3 id="kubeobjectdetailitems">kubeObjectDetailItems<a class="headerlink" href="#kubeobjectdetailitems" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>kubeObjectDetailItems</strong>: <a href="../../interfaces/Common.Types.KubeObjectDetailRegistration/"><code>KubeObjectDetailRegistration</code></a><<a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>[] = <code>[]</code></p>
|
||||
<p>• <strong>kubeObjectDetailItems</strong>: <a href="../../interfaces/Common.Types.KubeObjectDetailRegistration/"><code>KubeObjectDetailRegistration</code></a><<a href="../Renderer.K8sApi.KubeObject/"><code>KubeObject</code></a><<a href="../../modules/Renderer.K8sApi/#kubeobjectmetadata"><code>KubeObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>[] = <code>[]</code></p>
|
||||
<hr />
|
||||
<h3 id="kubeobjecthandlers">kubeObjectHandlers<a class="headerlink" href="#kubeobjecthandlers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>kubeObjectHandlers</strong>: <a href="../../modules/Common.Types/#kubeobjecthandlerregistration"><code>KubeObjectHandlerRegistration</code></a>[] = <code>[]</code></p>
|
||||
@@ -1330,9 +1330,9 @@
|
||||
<p>LensExtension.version</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="activate">activate<a class="headerlink" href="#activate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>activate</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<p>▸ <strong>activate</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.activate</p>
|
||||
<hr />
|
||||
@@ -1343,16 +1343,16 @@
|
||||
<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>fn</code></td>
|
||||
<td style="text-align: left;"><code>CategoryFilter</code></td>
|
||||
<td style="text-align: left;">The function which should return a truthy value for those categories which should be kept.</td>
|
||||
<td align="left"><code>fn</code></td>
|
||||
<td align="left"><code>CategoryFilter</code></td>
|
||||
<td align="left">The function which should return a truthy value for those categories which should be kept.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1367,16 +1367,16 @@
|
||||
<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>fn</code></td>
|
||||
<td style="text-align: left;"><code>EntityFilter</code></td>
|
||||
<td style="text-align: left;">The function which should return a truthy value for those entities which should be kept.</td>
|
||||
<td align="left"><code>fn</code></td>
|
||||
<td align="left"><code>EntityFilter</code></td>
|
||||
<td align="left">The function which should return a truthy value for those entities which should be kept.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1385,47 +1385,47 @@
|
||||
<p>A function to clean up the filter</p>
|
||||
<hr />
|
||||
<h3 id="disable">disable<a class="headerlink" href="#disable" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>disable</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<p>▸ <strong>disable</strong>(): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.disable</p>
|
||||
<hr />
|
||||
<h3 id="enable">enable<a class="headerlink" href="#enable" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>enable</strong>(<code>register</code>): <code>Promise</code><<code>void</code>></p>
|
||||
<p>▸ <strong>enable</strong>(<code>register</code>): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" 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>register</code></td>
|
||||
<td style="text-align: left;">(<code>ext</code>: <a href="./"><code>LensExtension</code></a>) => <code>Promise</code><<code>Disposer</code>[]></td>
|
||||
<td align="left"><code>register</code></td>
|
||||
<td align="left">(<code>ext</code>: <a href="./"><code>LensExtension</code></a>) => <code>Promise</code><<code>Disposer</code>[]></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.enable</p>
|
||||
<hr />
|
||||
<h3 id="getextensionfilefolder">getExtensionFileFolder<a class="headerlink" href="#getextensionfilefolder" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getExtensionFileFolder</strong>(): <code>Promise</code><<code>string</code>></p>
|
||||
<p>▸ <strong>getExtensionFileFolder</strong>(): <code>Promise</code><<code>string</code>></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 obfuscation of the
|
||||
folder name.</p>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>string</code>></p>
|
||||
<p><code>Promise</code><<code>string</code>></p>
|
||||
<h4 id="inherited-from_16">Inherited from<a class="headerlink" href="#inherited-from_16" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.getExtensionFileFolder</p>
|
||||
<hr />
|
||||
<h3 id="isenabledforcluster">isEnabledForCluster<a class="headerlink" href="#isenabledforcluster" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>isEnabledForCluster</strong>(<code>cluster</code>): <code>Promise</code><<code>Boolean</code>></p>
|
||||
<p>▸ <strong>isEnabledForCluster</strong>(<code>cluster</code>): <code>Promise</code><<code>Boolean</code>></p>
|
||||
<p>Defines if extension is enabled for a given cluster. This method is only
|
||||
called when the extension is created within a cluster frame.</p>
|
||||
<p>The default implementation is to return <code>true</code></p>
|
||||
@@ -1434,55 +1434,55 @@ called when the extension is created within a cluster frame.</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>cluster</code></td>
|
||||
<td style="text-align: left;"><a href="../Common.Catalog.KubernetesCluster/"><code>KubernetesCluster</code></a><<a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a>></td>
|
||||
<td align="left"><code>cluster</code></td>
|
||||
<td align="left"><a href="../Common.Catalog.KubernetesCluster/"><code>KubernetesCluster</code></a><<a href="../../interfaces/Common.Catalog.KubernetesClusterMetadata/"><code>KubernetesClusterMetadata</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterStatus/"><code>KubernetesClusterStatus</code></a>, <a href="../../interfaces/Common.Catalog.KubernetesClusterSpec/"><code>KubernetesClusterSpec</code></a>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>Boolean</code>></p>
|
||||
<p><code>Promise</code><<code>Boolean</code>></p>
|
||||
<hr />
|
||||
<h3 id="navigate">navigate<a class="headerlink" href="#navigate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>navigate</strong>(<code>pageId?</code>, <code>params?</code>): <code>Promise</code><<code>void</code>></p>
|
||||
<p>▸ <strong>navigate</strong>(<code>pageId?</code>, <code>params?</code>): <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" 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>pageId?</code></td>
|
||||
<td style="text-align: left;"><code>string</code></td>
|
||||
<td align="left"><code>pageId?</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="text-align: left;"><code>params</code></td>
|
||||
<td style="text-align: left;"><code>object</code></td>
|
||||
<td align="left"><code>params</code></td>
|
||||
<td align="left"><code>object</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_12">Returns<a class="headerlink" href="#returns_12" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<p><code>Promise</code><<code>void</code>></p>
|
||||
<hr />
|
||||
<h3 id="onactivate">onActivate<a class="headerlink" href="#onactivate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<p>▸ <code>Protected</code> <strong>onActivate</strong>(): <code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<p><code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_17">Inherited from<a class="headerlink" href="#inherited-from_17" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.onActivate</p>
|
||||
<hr />
|
||||
<h3 id="ondeactivate">onDeactivate<a class="headerlink" href="#ondeactivate" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<p>▸ <code>Protected</code> <strong>onDeactivate</strong>(): <code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<p><code>void</code> | <code>Promise</code><<code>void</code>></p>
|
||||
<h4 id="inherited-from_18">Inherited from<a class="headerlink" href="#inherited-from_18" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.onDeactivate</p>
|
||||
|
||||
|
||||
Reference in new issue
Block a user