Deployed 1a817d314c to master with MkDocs 1.4.3 and mike 1.1.2

This commit is contained in:
GitHub Action committed 2023-05-15 16:15:06 +00:00
1 parent a399aa485d
commit da61f51c5a
49 files changed
+231 -1169

No files matched your search

@@ -1008,12 +1008,12 @@
<p>filtered menu items</p>
<hr />
<h3 id="getbadge">getBadge<a class="headerlink" href="#getbadge" title="Permanent link">#</a></h3>
<p>▸ <strong>getBadge</strong>(): <code>ReactNode</code></p>
<p>▸ <strong>getBadge</strong>(): <code>StrictReactNode</code></p>
<p>Get the badge of this category.
Defaults to no badge.
The badge is displayed next to the Category name in the Catalog Category menu</p>
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
<p><code>ReactNode</code></p>
<p><code>StrictReactNode</code></p>
<hr />
<h3 id="getid">getId<a class="headerlink" href="#getid" title="Permanent link">#</a></h3>
<p>▸ <strong>getId</strong>(): <code>string</code></p>
@@ -1040,12 +1040,12 @@
<p><a href="../Common.Catalog.CatalogCategory/">CatalogCategory</a>.<a href="../Common.Catalog.CatalogCategory/#filtereditems">filteredItems</a></p>
<hr />
<h3 id="getbadge">getBadge<a class="headerlink" href="#getbadge" title="Permanent link">#</a></h3>
<p>▸ <strong>getBadge</strong>(): <code>ReactNode</code></p>
<p>▸ <strong>getBadge</strong>(): <code>StrictReactNode</code></p>
<p>Get the badge of this category.
Defaults to no badge.
The badge is displayed next to the Category name in the Catalog Category menu</p>
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
<p><code>ReactNode</code></p>
<p><code>StrictReactNode</code></p>
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
<p><a href="../Common.Catalog.CatalogCategory/">CatalogCategory</a>.<a href="../Common.Catalog.CatalogCategory/#getbadge">getBadge</a></p>
<hr />
@@ -1054,6 +1054,13 @@
getPreferedVersion
</a>
</li>
<li class="md-nav__item">
<a href="#getpreferredversion" class="md-nav__link">
getPreferredVersion
</a>
</li>
<li class="md-nav__item">
@@ -1250,6 +1257,7 @@
<li><a href="./#getownerrefs">getOwnerRefs</a></li>
<li><a href="./#getpluralname">getPluralName</a></li>
<li><a href="./#getpreferedversion">getPreferedVersion</a></li>
<li><a href="./#getpreferredversion">getPreferredVersion</a></li>
<li><a href="./#getprintercolumns">getPrinterColumns</a></li>
<li><a href="./#getresourceapibase">getResourceApiBase</a></li>
<li><a href="./#getresourcekind">getResourceKind</a></li>
@@ -1767,9 +1775,16 @@ creation timestamp of this object.</p>
<hr />
<h3 id="getpreferedversion">getPreferedVersion<a class="headerlink" href="#getpreferedversion" title="Permanent link">#</a></h3>
<p>▸ <strong>getPreferedVersion</strong>(): <code>CustomResourceDefinitionVersion</code></p>
<p><strong><code>Deprecated</code></strong></p>
<p>Switch to using <a href="./#getpreferredversion">getPreferredVersion</a> instead (which fixes the is a typo)</p>
<h4 id="returns_25">Returns<a class="headerlink" href="#returns_25" title="Permanent link">#</a></h4>
<p><code>CustomResourceDefinitionVersion</code></p>
<hr />
<h3 id="getpreferredversion">getPreferredVersion<a class="headerlink" href="#getpreferredversion" title="Permanent link">#</a></h3>
<p>▸ <strong>getPreferredVersion</strong>(): <code>CustomResourceDefinitionVersion</code></p>
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
<p><code>CustomResourceDefinitionVersion</code></p>
<hr />
<h3 id="getprintercolumns">getPrinterColumns<a class="headerlink" href="#getprintercolumns" title="Permanent link">#</a></h3>
<p>▸ <strong>getPrinterColumns</strong>(<code>ignorePriority?</code>): <code>AdditionalPrinterColumnsV1</code>[]</p>
<h4 id="parameters_13">Parameters<a class="headerlink" href="#parameters_13" title="Permanent link">#</a></h4>
@@ -1787,82 +1802,82 @@ creation timestamp of this object.</p>
</tr>
</tbody>
</table>
<h4 id="returns_26">Returns<a class="headerlink" href="#returns_26" title="Permanent link">#</a></h4>
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
<p><code>AdditionalPrinterColumnsV1</code>[]</p>
<hr />
<h3 id="getresourceapibase">getResourceApiBase<a class="headerlink" href="#getresourceapibase" title="Permanent link">#</a></h3>
<p>▸ <strong>getResourceApiBase</strong>(): <code>string</code></p>
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
<h3 id="getresourcekind">getResourceKind<a class="headerlink" href="#getresourcekind" title="Permanent link">#</a></h3>
<p>▸ <strong>getResourceKind</strong>(): <code>string</code></p>
<h4 id="returns_28">Returns<a class="headerlink" href="#returns_28" title="Permanent link">#</a></h4>
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
<h3 id="getresourcetitle">getResourceTitle<a class="headerlink" href="#getresourcetitle" title="Permanent link">#</a></h3>
<p>▸ <strong>getResourceTitle</strong>(): <code>string</code></p>
<h4 id="returns_29">Returns<a class="headerlink" href="#returns_29" title="Permanent link">#</a></h4>
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
<h3 id="getresourceurl">getResourceUrl<a class="headerlink" href="#getresourceurl" title="Permanent link">#</a></h3>
<p>▸ <strong>getResourceUrl</strong>(): <code>string</code></p>
<h4 id="returns_30">Returns<a class="headerlink" href="#returns_30" title="Permanent link">#</a></h4>
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
<h3 id="getresourceversion">getResourceVersion<a class="headerlink" href="#getresourceversion" title="Permanent link">#</a></h3>
<p>▸ <strong>getResourceVersion</strong>(): <code>string</code></p>
<h4 id="returns_31">Returns<a class="headerlink" href="#returns_31" title="Permanent link">#</a></h4>
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="inherited-from_26">Inherited from<a class="headerlink" href="#inherited-from_26" title="Permanent link">#</a></h4>
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getresourceversion">getResourceVersion</a></p>
<hr />
<h3 id="getscope">getScope<a class="headerlink" href="#getscope" title="Permanent link">#</a></h3>
<p>▸ <strong>getScope</strong>(): <code>"Cluster"</code> | <code>"Namespaced"</code></p>
<h4 id="returns_32">Returns<a class="headerlink" href="#returns_32" title="Permanent link">#</a></h4>
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
<p><code>"Cluster"</code> | <code>"Namespaced"</code></p>
<hr />
<h3 id="getscopedname">getScopedName<a class="headerlink" href="#getscopedname" title="Permanent link">#</a></h3>
<p>▸ <strong>getScopedName</strong>(): <code>string</code></p>
<h4 id="returns_33">Returns<a class="headerlink" href="#returns_33" title="Permanent link">#</a></h4>
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<h4 id="inherited-from_27">Inherited from<a class="headerlink" href="#inherited-from_27" title="Permanent link">#</a></h4>
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getscopedname">getScopedName</a></p>
<hr />
<h3 id="getsearchfields">getSearchFields<a class="headerlink" href="#getsearchfields" title="Permanent link">#</a></h3>
<p>▸ <strong>getSearchFields</strong>(): (<code>undefined</code> | <code>string</code>)[]</p>
<h4 id="returns_34">Returns<a class="headerlink" href="#returns_34" title="Permanent link">#</a></h4>
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
<p>(<code>undefined</code> | <code>string</code>)[]</p>
<h4 id="inherited-from_28">Inherited from<a class="headerlink" href="#inherited-from_28" title="Permanent link">#</a></h4>
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#getsearchfields">getSearchFields</a></p>
<hr />
<h3 id="getstoredversions">getStoredVersions<a class="headerlink" href="#getstoredversions" title="Permanent link">#</a></h3>
<p>▸ <strong>getStoredVersions</strong>(): <code>string</code></p>
<h4 id="returns_35">Returns<a class="headerlink" href="#returns_35" title="Permanent link">#</a></h4>
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
<h3 id="gettimedifffromnow">getTimeDiffFromNow<a class="headerlink" href="#gettimedifffromnow" title="Permanent link">#</a></h3>
<p>▸ <strong>getTimeDiffFromNow</strong>(): <code>number</code></p>
<p><strong><code>Deprecated</code></strong></p>
<p>This function computes a new "now". Switch to using <a href="../Main.K8sApi.KubeObject/#getcreationtimestamp">getCreationTimestamp</a> instead</p>
<h4 id="returns_36">Returns<a class="headerlink" href="#returns_36" title="Permanent link">#</a></h4>
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
<p><code>number</code></p>
<h4 id="inherited-from_29">Inherited from<a class="headerlink" href="#inherited-from_29" title="Permanent link">#</a></h4>
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#gettimedifffromnow">getTimeDiffFromNow</a></p>
<hr />
<h3 id="getvalidation">getValidation<a class="headerlink" href="#getvalidation" title="Permanent link">#</a></h3>
<p>▸ <strong>getValidation</strong>(): <code>string</code></p>
<h4 id="returns_37">Returns<a class="headerlink" href="#returns_37" title="Permanent link">#</a></h4>
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
<h3 id="getversion">getVersion<a class="headerlink" href="#getversion" title="Permanent link">#</a></h3>
<p>▸ <strong>getVersion</strong>(): <code>string</code></p>
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
<p><code>string</code></p>
<hr />
<h3 id="isnamespaced">isNamespaced<a class="headerlink" href="#isnamespaced" title="Permanent link">#</a></h3>
<p>▸ <strong>isNamespaced</strong>(): <code>boolean</code></p>
<h4 id="returns_39">Returns<a class="headerlink" href="#returns_39" title="Permanent link">#</a></h4>
<h4 id="returns_40">Returns<a class="headerlink" href="#returns_40" title="Permanent link">#</a></h4>
<p><code>boolean</code></p>
<hr />
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
@@ -1884,14 +1899,14 @@ creation timestamp of this object.</p>
</tr>
</tbody>
</table>
<h4 id="returns_40">Returns<a class="headerlink" href="#returns_40" title="Permanent link">#</a></h4>
<h4 id="returns_41">Returns<a class="headerlink" href="#returns_41" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a>&lt;<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a>&lt;<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
<h4 id="inherited-from_30">Inherited from<a class="headerlink" href="#inherited-from_30" title="Permanent link">#</a></h4>
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#patch">patch</a></p>
<hr />
<h3 id="toplainobject">toPlainObject<a class="headerlink" href="#toplainobject" title="Permanent link">#</a></h3>
<p>▸ <strong>toPlainObject</strong>(): <code>Record</code>&lt;<code>string</code>, <code>unknown</code>></p>
<h4 id="returns_41">Returns<a class="headerlink" href="#returns_41" title="Permanent link">#</a></h4>
<h4 id="returns_42">Returns<a class="headerlink" href="#returns_42" title="Permanent link">#</a></h4>
<p><code>Record</code>&lt;<code>string</code>, <code>unknown</code>></p>
<h4 id="inherited-from_31">Inherited from<a class="headerlink" href="#inherited-from_31" title="Permanent link">#</a></h4>
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#toplainobject">toPlainObject</a></p>
@@ -1915,7 +1930,7 @@ creation timestamp of this object.</p>
</tr>
</tbody>
</table>
<h4 id="returns_42">Returns<a class="headerlink" href="#returns_42" title="Permanent link">#</a></h4>
<h4 id="returns_43">Returns<a class="headerlink" href="#returns_43" title="Permanent link">#</a></h4>
<p><code>Promise</code>&lt;<code>null</code> | <a href="../../interfaces/Main.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a>&lt;<a href="../../modules/Main.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a>&lt;<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
<h4 id="inherited-from_32">Inherited from<a class="headerlink" href="#inherited-from_32" title="Permanent link">#</a></h4>
<p><a href="../Main.K8sApi.KubeObject/">KubeObject</a>.<a href="../Main.K8sApi.KubeObject/#update">update</a></p>
@@ -1309,7 +1309,7 @@
<tbody>
<tr>
<td align="left"><code>errors</code></td>
<td align="left"><code>ReactNode</code>[]</td>
<td align="left"><code>StrictReactNode</code>[]</td>
</tr>
</tbody>
</table>
@@ -831,7 +831,7 @@
<p><a href="../../modules/Renderer/">Renderer</a>.<a href="../../modules/Renderer.Component/">Component</a>.TableCell</p>
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
<ul>
<li><code>Component</code>&lt;<a href="../../interfaces/Renderer.Component.TableCellProps/"><code>TableCellProps</code></a>></li>
<li><code>Component</code>&lt;<code>TableCellProps</code>></li>
</ul>
<p>↳ <strong><code>TableCell</code></strong></p>
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
@@ -860,7 +860,7 @@
<tbody>
<tr>
<td align="left"><code>props</code></td>
<td align="left"><a href="../../interfaces/Renderer.Component.TableCellProps/"><code>TableCellProps</code></a></td>
<td align="left"><code>TableCellProps</code></td>
</tr>
</tbody>
</table>