mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
Deployed 5263d9b5ec to master with MkDocs 1.4.0 and mike 1.1.2
This commit is contained in:
parent
76be61ed25
commit
c6967b02f0
@ -17,7 +17,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="/master/img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1383,7 +1383,7 @@ only the first's arguments will be used.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left">extends <a href="../Common.Util.Singleton/"><code>Singleton</code></a><<code>T</code>></td>
|
||||
<td align="left">extends <code>Singleton</code><<code>T</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -918,7 +918,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@73042</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74045</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
@ -1029,7 +1029,7 @@ only the first's arguments will be used.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left">extends <a href="../Common.Util.Singleton/"><code>Singleton</code></a><<code>T</code>></td>
|
||||
<td align="left">extends <code>Singleton</code><<code>T</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1069,12 +1069,12 @@
|
||||
<h3 id="disposers">[Disposers]<a class="headerlink" href="#disposers" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>[Disposers]</strong>: <code>ExtendableDisposer</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@Disposers@29133</p>
|
||||
<p>LensExtension.__@Disposers@29308</p>
|
||||
<hr />
|
||||
<h3 id="lensextensiondependencies">[lensExtensionDependencies]<a class="headerlink" href="#lensextensiondependencies" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[lensExtensionDependencies]</strong>: <code>LensMainExtensionDependencies</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>LensExtension.__@lensExtensionDependencies@29136</p>
|
||||
<p>LensExtension.__@lensExtensionDependencies@29311</p>
|
||||
<hr />
|
||||
<h3 id="appmenus">appMenus<a class="headerlink" href="#appmenus" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>appMenus</strong>: <code>MenuRegistration</code>[] = <code>[]</code></p>
|
||||
@ -1108,9 +1108,11 @@
|
||||
<p>• <code>Optional</code> <strong>terminalShellEnvModifier</strong>: <a href="../../modules/Common.Types/#shellenvmodifier"><code>ShellEnvModifier</code></a></p>
|
||||
<p>implement this to modify the shell environment that Lens terminals are opened with. The ShellEnvModifier type has the signature</p>
|
||||
<p>(ctx: ShellEnvContext, env: Record<string, string | undefined>) => Record<string, string | undefined></p>
|
||||
<p><strong><code>param</code></strong> the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get
|
||||
<p><strong><code>Param</code></strong></p>
|
||||
<p>the shell environment context, specifically the relevant catalog entity for the terminal. This can be used, for example, to get
|
||||
cluster-specific information that can be made available in the shell environment by the implementation of terminalShellEnvModifier</p>
|
||||
<p><strong><code>param</code></strong> the current shell environment that the terminal will be opened with. The implementation should modify this as desired.</p>
|
||||
<p><strong><code>Param</code></strong></p>
|
||||
<p>the current shell environment that the terminal will be opened with. The implementation should modify this as desired.</p>
|
||||
<hr />
|
||||
<h3 id="traymenus">trayMenus<a class="headerlink" href="#traymenus" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>trayMenus</strong>: <a href="../../interfaces/Common.Types.TrayMenuRegistration/"><code>TrayMenuRegistration</code></a>[] = <code>[]</code></p>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1019,8 +1019,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<DrawerParamTogglerProps, State>.constructor</p>
|
||||
<p>• <strong>new DrawerParamToggler</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1054,7 +1055,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1065,7 +1067,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1091,7 +1094,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1102,9 +1106,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
@ -1119,9 +1127,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1153,9 +1165,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1258,9 +1274,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
@ -1274,9 +1294,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1316,9 +1340,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1205,7 +1205,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1219,7 +1220,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
@ -1251,7 +1253,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1280,9 +1283,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1297,9 +1304,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1331,9 +1342,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1450,9 +1465,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_11">Returns<a class="headerlink" href="#returns_11" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
@ -1466,9 +1485,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1506,9 +1529,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1213,7 +1213,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1235,7 +1236,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature_1">Index signature<a class="headerlink" href="#index-signature_1" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
@ -1261,7 +1263,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1295,9 +1298,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1312,9 +1319,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1346,9 +1357,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1489,9 +1504,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_13">Returns<a class="headerlink" href="#returns_13" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
@ -1505,9 +1524,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1545,9 +1568,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1097,7 +1097,8 @@
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
@ -1133,9 +1134,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
@ -1150,9 +1155,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1184,9 +1193,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1309,9 +1322,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||
@ -1325,9 +1342,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1367,9 +1388,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -969,7 +969,7 @@
|
||||
<h1 id="class-pagelayout">Class: PageLayout<a class="headerlink" href="#class-pagelayout" title="Permanent link">#</a></h1>
|
||||
<p><a href="../../modules/Renderer/">Renderer</a>.<a href="../../modules/Renderer.Component/">Component</a>.PageLayout</p>
|
||||
<p>PageLayout is deprecated. See MainLayout & SettingLayout</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||
<ul>
|
||||
<li><a href="../Renderer.Component.SettingLayout/"><code>SettingLayout</code></a></li>
|
||||
@ -1029,8 +1029,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.Component.SettingLayout/">SettingLayout</a>.<a href="../Renderer.Component.SettingLayout/#constructor">constructor</a></p>
|
||||
<p>• <strong>new PageLayout</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1064,7 +1065,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.Component.SettingLayout/">SettingLayout</a>.<a href="../Renderer.Component.SettingLayout/#context">context</a></p>
|
||||
<hr />
|
||||
@ -1075,7 +1077,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1101,7 +1104,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.Component.SettingLayout/">SettingLayout</a>.<a href="../Renderer.Component.SettingLayout/#contexttype">contextType</a></p>
|
||||
<hr />
|
||||
@ -1117,9 +1121,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
@ -1134,9 +1142,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1168,9 +1180,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1272,9 +1288,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
@ -1288,9 +1308,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1328,9 +1352,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1046,7 +1046,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1057,7 +1058,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
@ -1083,7 +1085,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1094,9 +1097,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
@ -1111,9 +1118,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1145,9 +1156,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1249,9 +1264,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
@ -1265,9 +1284,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1305,9 +1328,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1054,7 +1054,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1065,7 +1066,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
@ -1091,7 +1093,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1105,9 +1108,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
@ -1122,9 +1129,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1156,9 +1167,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1265,9 +1280,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
@ -1281,9 +1300,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1321,9 +1344,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1029,8 +1029,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<SettingLayoutProps>.constructor</p>
|
||||
<p>• <strong>new SettingLayout</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1064,7 +1065,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1075,7 +1077,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1101,7 +1104,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1115,9 +1119,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1132,9 +1140,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1166,9 +1178,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1270,9 +1286,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
@ -1286,9 +1306,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1326,9 +1350,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1019,8 +1019,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>Component<SliderProps>.constructor</p>
|
||||
<p>• <strong>new Slider</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1054,7 +1055,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>Component.context</p>
|
||||
<hr />
|
||||
@ -1065,7 +1067,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1091,7 +1094,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>Component.contextType</p>
|
||||
<hr />
|
||||
@ -1105,9 +1109,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1122,9 +1130,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1156,9 +1168,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1261,9 +1277,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1277,9 +1297,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1319,9 +1343,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1019,8 +1019,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<SpinnerProps, {}>.constructor</p>
|
||||
<p>• <strong>new Spinner</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1054,7 +1055,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1065,7 +1067,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1091,7 +1094,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1124,9 +1128,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1141,9 +1149,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1175,9 +1187,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1280,9 +1296,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1296,9 +1316,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1338,9 +1362,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1011,8 +1011,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<StepperProps, {}>.constructor</p>
|
||||
<p>• <strong>new Stepper</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1046,7 +1047,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1057,7 +1059,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1083,7 +1086,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1094,9 +1098,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1111,9 +1119,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1145,9 +1157,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1250,9 +1266,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1266,9 +1286,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1308,9 +1332,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1011,8 +1011,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<SubTitleProps>.constructor</p>
|
||||
<p>• <strong>new SubTitle</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1046,7 +1047,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1057,7 +1059,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1083,7 +1086,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1094,9 +1098,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1111,9 +1119,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1145,9 +1157,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1250,9 +1266,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1266,9 +1286,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1308,9 +1332,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1105,7 +1105,8 @@
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
@ -1133,9 +1134,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
@ -1150,9 +1155,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1184,9 +1193,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1288,9 +1301,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
@ -1304,9 +1321,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1346,9 +1367,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1046,7 +1046,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1057,7 +1058,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
@ -1083,7 +1085,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1094,9 +1097,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
@ -1111,9 +1118,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1145,9 +1156,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1250,9 +1265,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
@ -1266,9 +1285,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1308,9 +1331,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1019,8 +1019,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<TableHeadProps>.constructor</p>
|
||||
<p>• <strong>new TableHead</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1054,7 +1055,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1065,7 +1067,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1091,7 +1094,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1105,9 +1109,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1122,9 +1130,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1156,9 +1168,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1261,9 +1277,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1277,9 +1297,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1319,9 +1343,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1044,8 +1044,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<TableRowProps<Item>>.constructor</p>
|
||||
<p>• <strong>new TableRow</strong><<code>Item</code>>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1092,7 +1093,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1103,7 +1105,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1129,7 +1132,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1140,9 +1144,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1157,9 +1165,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1191,9 +1203,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1296,9 +1312,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1312,9 +1332,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1354,9 +1378,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1019,8 +1019,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.PureComponent<TabsProps>.constructor</p>
|
||||
<p>• <strong>new Tabs</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1054,7 +1055,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.PureComponent.context</p>
|
||||
<hr />
|
||||
@ -1068,7 +1070,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1094,7 +1097,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.PureComponent.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1105,9 +1109,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1122,9 +1130,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1156,9 +1168,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1261,9 +1277,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1277,9 +1297,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1319,9 +1343,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1144,7 +1144,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1164,7 +1165,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
@ -1190,7 +1192,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1214,9 +1217,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
@ -1231,9 +1238,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1265,9 +1276,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1344,9 +1359,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||
@ -1360,9 +1379,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1400,9 +1423,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1139,8 +1139,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<WizardProps<D>, State>.constructor</p>
|
||||
<p>• <strong>new Wizard</strong><<code>D</code>>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1187,7 +1188,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1198,7 +1200,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1224,7 +1227,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="accessors_1">Accessors<a class="headerlink" href="#accessors_1" title="Permanent link">#</a></h2>
|
||||
@ -1263,9 +1267,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
@ -1280,9 +1288,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1314,9 +1326,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1419,9 +1435,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
@ -1435,9 +1455,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1477,9 +1501,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1011,8 +1011,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<WizardLayoutProps>.constructor</p>
|
||||
<p>• <strong>new WizardLayout</strong>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1046,7 +1047,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1057,7 +1059,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1083,7 +1086,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
@ -1094,9 +1098,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
@ -1111,9 +1119,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1145,9 +1157,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1250,9 +1266,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
@ -1266,9 +1286,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1308,9 +1332,13 @@ cancelled network requests, or cleaning up any DOM elements created in <code>com
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1092,8 +1092,9 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>React.Component<WizardStepProps<D>, WizardStepState>.constructor</p>
|
||||
<p>• <strong>new WizardStep</strong><<code>D</code>>(<code>props</code>, <code>context</code>)</p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/legacy-context.html</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/legacy-context.html</p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1140,7 +1141,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="c1">// For TS 3.7 and above:</span><span class="w"></span>
|
||||
<span class="kr">declare</span><span class="w"> </span><span class="nx">context</span><span class="o">:</span><span class="w"> </span><span class="kt">React.ContextType</span><span class="o"><</span><span class="ow">typeof</span><span class="w"> </span><span class="nx">MyContext</span><span class="o">></span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html</p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.context</p>
|
||||
<hr />
|
||||
@ -1151,7 +1153,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<hr />
|
||||
<h3 id="refs">refs<a class="headerlink" href="#refs" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>refs</strong>: <code>Object</code></p>
|
||||
<p><strong><code>deprecated</code></strong> https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs</p>
|
||||
<h4 id="index-signature">Index signature<a class="headerlink" href="#index-signature" title="Permanent link">#</a></h4>
|
||||
<p>▪ [key: <code>string</code>]: <code>ReactInstance</code></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
@ -1180,7 +1183,8 @@ Should be used with type annotation or static contextType.</p>
|
||||
<span class="w"> </span><span class="p">}</span><span class="w"></span>
|
||||
<span class="p">}</span><span class="w"></span>
|
||||
</code></pre></div>
|
||||
<p><strong><code>see</code></strong> https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<p>https://reactjs.org/docs/context.html#classcontexttype</p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>React.Component.contextType</p>
|
||||
<hr />
|
||||
@ -1194,9 +1198,13 @@ Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
@ -1211,9 +1219,13 @@ props if you only want to handle changes.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1245,9 +1257,13 @@ prevents this from being invoked.</p>
|
||||
<p>This method will not stop working in React 17.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1350,9 +1366,13 @@ the entire component tree to unmount.</p>
|
||||
Avoid introducing any side-effects or subscriptions in this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use componentDidMount or the constructor instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
@ -1366,9 +1386,13 @@ props if you only want to handle changes.</p>
|
||||
<p>Calling <code>Component#setState</code> generally does not trigger this method.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use static getDerivedStateFromProps instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1406,9 +1430,13 @@ prevents this from being invoked.</p>
|
||||
<p>Note: You cannot call <code>Component#setState</code> here.</p>
|
||||
<p>Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps
|
||||
prevents this from being invoked.</p>
|
||||
<p><strong><code>deprecated</code></strong> 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>see</code></strong> - https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
|
||||
- https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17</p>
|
||||
<p><strong><code>See</code></strong></p>
|
||||
<ul>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update</li>
|
||||
<li>https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path</li>
|
||||
</ul>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -918,7 +918,7 @@
|
||||
<h3 id="ipcprefix">[IpcPrefix]<a class="headerlink" href="#ipcprefix" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>[IpcPrefix]</strong>: <code>string</code></p>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>IpcRegistrar.__@IpcPrefix@73042</p>
|
||||
<p>IpcRegistrar.__@IpcPrefix@74045</p>
|
||||
<hr />
|
||||
<h3 id="extension">extension<a class="headerlink" href="#extension" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <strong>extension</strong>: <code>LensExtension</code><<code>LensExtensionDependencies</code>></p>
|
||||
@ -1034,7 +1034,7 @@ only the first's arguments will be used.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left">extends <a href="../Common.Util.Singleton/"><code>Singleton</code></a><<code>T</code>></td>
|
||||
<td align="left">extends <code>Singleton</code><<code>T</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1233,7 +1233,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1256,7 +1257,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1393,7 +1395,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1402,7 +1405,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1436,7 +1440,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1241,7 +1241,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1264,7 +1265,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1406,7 +1408,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1415,7 +1418,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1449,7 +1453,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1244,7 +1244,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1267,7 +1268,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1404,7 +1406,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1413,7 +1416,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1447,7 +1451,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new ConfigMapsStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1243,7 +1243,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1266,7 +1267,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1413,7 +1415,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1432,7 +1435,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1466,7 +1470,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1331,7 +1331,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1354,7 +1355,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1568,7 +1570,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_27">Returns<a class="headerlink" href="#returns_27" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1592,7 +1595,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1626,7 +1630,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1259,7 +1259,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1292,7 +1293,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1444,7 +1446,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1458,7 +1461,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1492,7 +1496,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1275,7 +1275,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1308,7 +1309,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1504,7 +1506,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1518,7 +1521,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1552,7 +1556,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1223,7 +1223,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#objectconstructor">objectConstructor</a></p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <code>KubeJsonApi</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <a href="../Renderer.K8sApi.KubeJsonApi/"><code>KubeJsonApi</code></a></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#request">request</a></p>
|
||||
<hr />
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1790,7 +1790,7 @@
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>DeploymentStatuses</code></p>
|
||||
<p>▸ <strong>getStatuses</strong>(<code>deployments</code>): <code>DeploymentStatuses</code></p>
|
||||
<p><strong><code>deprecated</code></strong> </p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<h4 id="parameters_14">Parameters<a class="headerlink" href="#parameters_14" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1230,7 +1230,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1253,7 +1254,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1390,7 +1392,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1399,7 +1402,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1438,7 +1442,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new EndpointStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new HPAStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1267,7 +1267,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1290,7 +1291,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1477,7 +1479,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_22">Returns<a class="headerlink" href="#returns_22" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1486,7 +1489,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1520,7 +1524,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1251,7 +1251,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1274,7 +1275,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1436,7 +1438,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_20">Returns<a class="headerlink" href="#returns_20" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1445,7 +1448,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1479,7 +1483,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1191,7 +1191,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#objectconstructor">objectConstructor</a></p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <code>KubeJsonApi</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <a href="../Renderer.K8sApi.KubeJsonApi/"><code>KubeJsonApi</code></a></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#request">request</a></p>
|
||||
<hr />
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new IngressStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1291,7 +1291,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1324,7 +1325,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1496,7 +1498,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1510,7 +1513,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1544,7 +1548,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1214,7 +1214,7 @@
|
||||
<p>• <code>Readonly</code> <strong>objectConstructor</strong>: <code>KubeObjectConstructor</code><<code>Object</code>, <code>Data</code>></p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <code>KubeJsonApi</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <a href="../Renderer.K8sApi.KubeJsonApi/"><code>KubeJsonApi</code></a></p>
|
||||
<hr />
|
||||
<h3 id="resourceversions">resourceVersions<a class="headerlink" href="#resourceversions" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>resourceVersions</strong>: <code>Map</code><<code>string</code>, <code>string</code>></p>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1392,7 +1392,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1415,7 +1416,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1491,7 +1493,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="getfirstseentime">getFirstSeenTime<a class="headerlink" href="#getfirstseentime" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getFirstSeenTime</strong>(): <code>string</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
@ -1511,7 +1514,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="getlastseentime">getLastSeenTime<a class="headerlink" href="#getlastseentime" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getLastSeenTime</strong>(): <code>string</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function is not reactive to changing of time. If rendering use <code><ReactiveDuration /></code> instead</p>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code></p>
|
||||
<hr />
|
||||
@ -1564,7 +1568,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1578,7 +1583,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1612,7 +1618,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -13,17 +13,17 @@
|
||||
<meta name="author" content="Mirantis, Inc.">
|
||||
|
||||
|
||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/Common.Util.Singleton/">
|
||||
<link rel="canonical" href="https://api-docs.k8slens.dev/master/extensions/api/classes/Renderer.K8sApi.KubeJsonApi/">
|
||||
|
||||
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
<title>Class: Singleton - Lens Extension Development</title>
|
||||
<title>Class: KubeJsonApi - Lens Extension Development</title>
|
||||
|
||||
|
||||
|
||||
@ -88,7 +88,7 @@
|
||||
<div data-md-component="skip">
|
||||
|
||||
|
||||
<a href="#class-singleton" class="md-skip">
|
||||
<a href="#class-kubejsonapi" class="md-skip">
|
||||
Skip to content
|
||||
</a>
|
||||
|
||||
@ -126,7 +126,7 @@
|
||||
<div class="md-header__topic" data-md-component="header-topic">
|
||||
<span class="md-ellipsis">
|
||||
|
||||
Class: Singleton
|
||||
Class: KubeJsonApi
|
||||
|
||||
</span>
|
||||
</div>
|
||||
@ -711,6 +711,13 @@
|
||||
</label>
|
||||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#hierarchy" class="md-nav__link">
|
||||
Hierarchy
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#table-of-contents" class="md-nav__link">
|
||||
Table of contents
|
||||
@ -724,6 +731,13 @@
|
||||
Constructors
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#properties" class="md-nav__link">
|
||||
Properties
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@ -756,6 +770,61 @@
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#properties_1" class="md-nav__link">
|
||||
Properties
|
||||
</a>
|
||||
|
||||
<nav class="md-nav" aria-label="Properties">
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#config" class="md-nav__link">
|
||||
config
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#ondata" class="md-nav__link">
|
||||
onData
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#onerror" class="md-nav__link">
|
||||
onError
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#reqinit" class="md-nav__link">
|
||||
reqInit
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#configdefault" class="md-nav__link">
|
||||
configDefault
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#reqinitdefault" class="md-nav__link">
|
||||
reqInitDefault
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
@ -767,22 +836,78 @@
|
||||
<ul class="md-nav__list">
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#createinstance" class="md-nav__link">
|
||||
createInstance
|
||||
<a href="#del" class="md-nav__link">
|
||||
del
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#getinstance" class="md-nav__link">
|
||||
getInstance
|
||||
<a href="#get" class="md-nav__link">
|
||||
get
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#resetinstance" class="md-nav__link">
|
||||
resetInstance
|
||||
<a href="#getresponse" class="md-nav__link">
|
||||
getResponse
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#parseerror" class="md-nav__link">
|
||||
parseError
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#parseresponse" class="md-nav__link">
|
||||
parseResponse
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#patch" class="md-nav__link">
|
||||
patch
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#post" class="md-nav__link">
|
||||
post
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#put" class="md-nav__link">
|
||||
put
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#request" class="md-nav__link">
|
||||
request
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#writelog" class="md-nav__link">
|
||||
writeLog
|
||||
</a>
|
||||
|
||||
</li>
|
||||
|
||||
<li class="md-nav__item">
|
||||
<a href="#forcluster" class="md-nav__link">
|
||||
forCluster
|
||||
</a>
|
||||
|
||||
</li>
|
||||
@ -806,30 +931,117 @@
|
||||
|
||||
|
||||
|
||||
<h1 id="class-singleton">Class: Singleton<a class="headerlink" href="#class-singleton" title="Permanent link">#</a></h1>
|
||||
<p><a href="../../modules/Common/">Common</a>.<a href="../../modules/Common.Util/">Util</a>.Singleton</p>
|
||||
<h1 id="class-kubejsonapi">Class: KubeJsonApi<a class="headerlink" href="#class-kubejsonapi" title="Permanent link">#</a></h1>
|
||||
<p><a href="../../modules/Renderer/">Renderer</a>.<a href="../../modules/Renderer.K8sApi/">K8sApi</a>.KubeJsonApi</p>
|
||||
<h2 id="hierarchy">Hierarchy<a class="headerlink" href="#hierarchy" title="Permanent link">#</a></h2>
|
||||
<ul>
|
||||
<li><code>JsonApi</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a>></li>
|
||||
</ul>
|
||||
<p>↳ <strong><code>KubeJsonApi</code></strong></p>
|
||||
<h2 id="table-of-contents">Table of contents<a class="headerlink" href="#table-of-contents" title="Permanent link">#</a></h2>
|
||||
<h3 id="constructors">Constructors<a class="headerlink" href="#constructors" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#constructor">constructor</a></li>
|
||||
</ul>
|
||||
<h3 id="properties">Properties<a class="headerlink" href="#properties" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#config">config</a></li>
|
||||
<li><a href="./#ondata">onData</a></li>
|
||||
<li><a href="./#onerror">onError</a></li>
|
||||
<li><a href="./#reqinit">reqInit</a></li>
|
||||
<li><a href="./#configdefault">configDefault</a></li>
|
||||
<li><a href="./#reqinitdefault">reqInitDefault</a></li>
|
||||
</ul>
|
||||
<h3 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">#</a></h3>
|
||||
<ul>
|
||||
<li><a href="./#createinstance">createInstance</a></li>
|
||||
<li><a href="./#getinstance">getInstance</a></li>
|
||||
<li><a href="./#resetinstance">resetInstance</a></li>
|
||||
<li><a href="./#del">del</a></li>
|
||||
<li><a href="./#get">get</a></li>
|
||||
<li><a href="./#getresponse">getResponse</a></li>
|
||||
<li><a href="./#parseerror">parseError</a></li>
|
||||
<li><a href="./#parseresponse">parseResponse</a></li>
|
||||
<li><a href="./#patch">patch</a></li>
|
||||
<li><a href="./#post">post</a></li>
|
||||
<li><a href="./#put">put</a></li>
|
||||
<li><a href="./#request">request</a></li>
|
||||
<li><a href="./#writelog">writeLog</a></li>
|
||||
<li><a href="./#forcluster">forCluster</a></li>
|
||||
</ul>
|
||||
<h2 id="constructors_1">Constructors<a class="headerlink" href="#constructors_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="constructor">constructor<a class="headerlink" href="#constructor" title="Permanent link">#</a></h3>
|
||||
<p>• <strong>new Singleton</strong>()</p>
|
||||
<p>• <strong>new KubeJsonApi</strong>(<code>config</code>, <code>reqInit?</code>)</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>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>config</code></td>
|
||||
<td align="left"><code>JsonApiConfig</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>reqInit?</code></td>
|
||||
<td align="left"><code>RequestInit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi<KubeJsonApiData>.constructor</p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="config">config<a class="headerlink" href="#config" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>config</strong>: <code>JsonApiConfig</code></p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.config</p>
|
||||
<hr />
|
||||
<h3 id="ondata">onData<a class="headerlink" href="#ondata" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>onData</strong>: <code>EventEmitter</code><[<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>, <code>Response</code>]></p>
|
||||
<h4 id="inherited-from_2">Inherited from<a class="headerlink" href="#inherited-from_2" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.onData</p>
|
||||
<hr />
|
||||
<h3 id="onerror">onError<a class="headerlink" href="#onerror" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Readonly</code> <strong>onError</strong>: <code>EventEmitter</code><[<code>JsonApiErrorParsed</code>, <code>Response</code>]></p>
|
||||
<h4 id="inherited-from_3">Inherited from<a class="headerlink" href="#inherited-from_3" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.onError</p>
|
||||
<hr />
|
||||
<h3 id="reqinit">reqInit<a class="headerlink" href="#reqinit" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>reqInit</strong>: <code>Defaulted</code><<code>RequestInit</code>, <code>"headers"</code>></p>
|
||||
<h4 id="inherited-from_4">Inherited from<a class="headerlink" href="#inherited-from_4" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.reqInit</p>
|
||||
<hr />
|
||||
<h3 id="configdefault">configDefault<a class="headerlink" href="#configdefault" title="Permanent link">#</a></h3>
|
||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>configDefault</strong>: <code>Partial</code><<code>JsonApiConfig</code>></p>
|
||||
<h4 id="inherited-from_5">Inherited from<a class="headerlink" href="#inherited-from_5" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.configDefault</p>
|
||||
<hr />
|
||||
<h3 id="reqinitdefault">reqInitDefault<a class="headerlink" href="#reqinitdefault" title="Permanent link">#</a></h3>
|
||||
<p>▪ <code>Static</code> <code>Readonly</code> <strong>reqInitDefault</strong>: <code>Object</code></p>
|
||||
<h4 id="type-declaration">Type declaration<a class="headerlink" href="#type-declaration" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>headers</code></td>
|
||||
<td align="left">{ <code>content-type</code>: <code>string</code> = "application/json" }</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>headers.content-type</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="inherited-from_6">Inherited from<a class="headerlink" href="#inherited-from_6" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.reqInitDefault</p>
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="createinstance">createInstance<a class="headerlink" href="#createinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>createInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, ...<code>args</code>): <code>T</code></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>
|
||||
<p>Note: this is a racy function, if two (or more) calls are racing to call this function
|
||||
only the first's arguments will be used.</p>
|
||||
<h3 id="del">del<a class="headerlink" href="#del" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>del</strong><<code>OutData</code>, <code>Query</code>>(<code>path</code>, <code>params?</code>, <code>reqInit?</code>): <code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="type-parameters">Type parameters<a class="headerlink" href="#type-parameters" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -840,44 +1052,45 @@ only the first's arguments will be used.</p>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left">extends <a href="./"><code>Singleton</code></a><<code>T</code>></td>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
<td align="left"><a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">extends <code>any</code>[]</td>
|
||||
<td align="left"><code>Query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>Record</code><<code>string</code>, <code>QueryParam</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">#</a></h4>
|
||||
<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>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
<td align="left"><code>path</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>...args</code></td>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">The constructor arguments for the child class</td>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>ParamsAndQuery</code><<code>JsonApiParams</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>, <code>Query</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>reqInit</code></td>
|
||||
<td align="left"><code>RequestInit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns">Returns<a class="headerlink" href="#returns" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code></p>
|
||||
<p>An instance of the child class</p>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_7">Inherited from<a class="headerlink" href="#inherited-from_7" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.del</p>
|
||||
<hr />
|
||||
<h3 id="getinstance">getInstance<a class="headerlink" href="#getinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict?</code>): <code>T</code></p>
|
||||
<p>Get the instance of the child class that was previously created.</p>
|
||||
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>get</strong><<code>OutData</code>, <code>Query</code>>(<code>path</code>, <code>params?</code>, <code>reqInit?</code>): <code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="type-parameters_1">Type parameters<a class="headerlink" href="#type-parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -888,57 +1101,12 @@ only the first's arguments will be used.</p>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
<td align="left"><a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">extends <code>any</code>[]</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<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>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left">Implicit argument that is the child class type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strict?</code></td>
|
||||
<td align="left"><code>true</code></td>
|
||||
<td align="left">If false will return <code>undefined</code> instead of throwing when an instance doesn't exist. Default: <code>true</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>T</code></p>
|
||||
<p>An instance of the child class</p>
|
||||
<p>▸ <code>Static</code> <strong>getInstance</strong><<code>T</code>, <code>R</code>>(<code>this</code>, <code>strict</code>): <code>undefined</code> | <code>T</code></p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>T</code></td>
|
||||
<td align="left"><code>T</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>R</code></td>
|
||||
<td align="left">extends <code>any</code>[]</td>
|
||||
<td align="left"><code>Query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>Record</code><<code>string</code>, <code>QueryParam</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -952,25 +1120,369 @@ only the first's arguments will be used.</p>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>this</code></td>
|
||||
<td align="left"><code>StaticThis</code><<code>T</code>, <code>R</code>></td>
|
||||
<td align="left"><code>path</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>strict</code></td>
|
||||
<td align="left"><code>false</code></td>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>ParamsAndQuery</code><<code>JsonApiParams</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>, <code>Query</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>reqInit</code></td>
|
||||
<td align="left"><code>RequestInit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_1">Returns<a class="headerlink" href="#returns_1" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_8">Inherited from<a class="headerlink" href="#inherited-from_8" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.get</p>
|
||||
<hr />
|
||||
<h3 id="getresponse">getResponse<a class="headerlink" href="#getresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getResponse</strong><<code>Query</code>>(<code>path</code>, <code>params?</code>, <code>init?</code>): <code>Promise</code><<code>Response</code>></p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>Query</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_3">Parameters<a class="headerlink" href="#parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>path</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>ParamsAndQuery</code><<code>JsonApiParams</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>, <code>Query</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>init</code></td>
|
||||
<td align="left"><code>RequestInit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_2">Returns<a class="headerlink" href="#returns_2" title="Permanent link">#</a></h4>
|
||||
<p><code>undefined</code> | <code>T</code></p>
|
||||
<p><code>Promise</code><<code>Response</code>></p>
|
||||
<h4 id="inherited-from_9">Inherited from<a class="headerlink" href="#inherited-from_9" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.getResponse</p>
|
||||
<hr />
|
||||
<h3 id="resetinstance">resetInstance<a class="headerlink" href="#resetinstance" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>resetInstance</strong>(): <code>void</code></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>
|
||||
<h3 id="parseerror">parseError<a class="headerlink" href="#parseerror" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseError</strong>(<code>error</code>, <code>res</code>): <code>string</code>[]</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>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>error</code></td>
|
||||
<td align="left"><code>string</code> | <code>KubeJsonApiError</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>res</code></td>
|
||||
<td align="left"><code>Response</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_3">Returns<a class="headerlink" href="#returns_3" title="Permanent link">#</a></h4>
|
||||
<p><code>string</code>[]</p>
|
||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.parseError</p>
|
||||
<hr />
|
||||
<h3 id="parseresponse">parseResponse<a class="headerlink" href="#parseresponse" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>parseResponse</strong><<code>OutData</code>>(<code>res</code>, <code>log</code>): <code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="type-parameters_3">Type parameters<a class="headerlink" href="#type-parameters_3" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>res</code></td>
|
||||
<td align="left"><code>Response</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>log</code></td>
|
||||
<td align="left"><code>JsonApiLog</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_4">Returns<a class="headerlink" href="#returns_4" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_10">Inherited from<a class="headerlink" href="#inherited-from_10" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.parseResponse</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong><<code>OutData</code>, <code>Query</code>>(<code>path</code>, <code>params?</code>, <code>reqInit?</code>): <code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="type-parameters_4">Type parameters<a class="headerlink" href="#type-parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
<td align="left"><a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>Record</code><<code>string</code>, <code>QueryParam</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>path</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>ParamsAndQuery</code><<code>Omit</code><<code>JsonApiParams</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>, <code>"data"</code>>, <code>Query</code>> & { <code>data?</code>: <code>Patch</code> | <code>PartialObjectDeep</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>> }</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>reqInit</code></td>
|
||||
<td align="left"><code>RequestInit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_5">Returns<a class="headerlink" href="#returns_5" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_11">Inherited from<a class="headerlink" href="#inherited-from_11" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.patch</p>
|
||||
<hr />
|
||||
<h3 id="post">post<a class="headerlink" href="#post" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>post</strong><<code>OutData</code>, <code>Query</code>>(<code>path</code>, <code>params?</code>, <code>reqInit?</code>): <code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="type-parameters_5">Type parameters<a class="headerlink" href="#type-parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
<td align="left"><a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>Record</code><<code>string</code>, <code>QueryParam</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_7">Parameters<a class="headerlink" href="#parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>path</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>ParamsAndQuery</code><<code>JsonApiParams</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>, <code>Query</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>reqInit</code></td>
|
||||
<td align="left"><code>RequestInit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_6">Returns<a class="headerlink" href="#returns_6" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.post</p>
|
||||
<hr />
|
||||
<h3 id="put">put<a class="headerlink" href="#put" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>put</strong><<code>OutData</code>, <code>Query</code>>(<code>path</code>, <code>params?</code>, <code>reqInit?</code>): <code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="type-parameters_6">Type parameters<a class="headerlink" href="#type-parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
<td align="left"><a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>Record</code><<code>string</code>, <code>QueryParam</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>path</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params?</code></td>
|
||||
<td align="left"><code>ParamsAndQuery</code><<code>JsonApiParams</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>, <code>Query</code>></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>reqInit</code></td>
|
||||
<td align="left"><code>RequestInit</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_7">Returns<a class="headerlink" href="#returns_7" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_13">Inherited from<a class="headerlink" href="#inherited-from_13" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.put</p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>request</strong><<code>OutData</code>, <code>Query</code>>(<code>path</code>, <code>params</code>, <code>init</code>): <code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="type-parameters_7">Type parameters<a class="headerlink" href="#type-parameters_7" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
<td align="left"><code>OutData</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>Query</code></td>
|
||||
<td align="left"><code>Partial</code><<code>Record</code><<code>string</code>, <code>QueryParam</code>>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>path</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>params</code></td>
|
||||
<td align="left"><code>undefined</code> | <code>ParamsAndQuery</code><<code>Omit</code><<code>JsonApiParams</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>>, <code>"data"</code>>, <code>Query</code>> & { <code>data?</code>: <code>unknown</code> }</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="left"><code>init</code></td>
|
||||
<td align="left"><code>Defaulted</code><<code>RequestInit</code>, <code>"method"</code>></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_8">Returns<a class="headerlink" href="#returns_8" title="Permanent link">#</a></h4>
|
||||
<p><code>Promise</code><<code>OutData</code>></p>
|
||||
<h4 id="inherited-from_14">Inherited from<a class="headerlink" href="#inherited-from_14" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.request</p>
|
||||
<hr />
|
||||
<h3 id="writelog">writeLog<a class="headerlink" href="#writelog" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Protected</code> <strong>writeLog</strong>(<code>log</code>): <code>void</code></p>
|
||||
<h4 id="parameters_10">Parameters<a class="headerlink" href="#parameters_10" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>log</code></td>
|
||||
<td align="left"><code>JsonApiLog</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_9">Returns<a class="headerlink" href="#returns_9" title="Permanent link">#</a></h4>
|
||||
<p><code>void</code></p>
|
||||
<h4 id="inherited-from_15">Inherited from<a class="headerlink" href="#inherited-from_15" title="Permanent link">#</a></h4>
|
||||
<p>JsonApi.writeLog</p>
|
||||
<hr />
|
||||
<h3 id="forcluster">forCluster<a class="headerlink" href="#forcluster" title="Permanent link">#</a></h3>
|
||||
<p>▸ <code>Static</code> <strong>forCluster</strong>(<code>clusterId</code>): <a href="./"><code>KubeJsonApi</code></a></p>
|
||||
<h4 id="parameters_11">Parameters<a class="headerlink" href="#parameters_11" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th align="left">Name</th>
|
||||
<th align="left">Type</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td align="left"><code>clusterId</code></td>
|
||||
<td align="left"><code>string</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h4 id="returns_10">Returns<a class="headerlink" href="#returns_10" title="Permanent link">#</a></h4>
|
||||
<p><a href="./"><code>KubeJsonApi</code></a></p>
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1276,7 +1276,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1297,7 +1298,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1409,14 +1411,16 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_14">Returns<a class="headerlink" href="#returns_14" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1446,7 +1450,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1416,7 +1416,8 @@
|
||||
<h4 id="overrides">Overrides<a class="headerlink" href="#overrides" title="Permanent link">#</a></h4>
|
||||
<p>ItemStore<K\>.constructor</p>
|
||||
<p>• <strong>new KubeObjectStore</strong><<code>K</code>, <code>A</code>, <code>D</code>>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="type-parameters_2">Type parameters<a class="headerlink" href="#type-parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1227,7 +1227,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1250,7 +1251,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1397,7 +1399,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1406,7 +1409,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1440,7 +1444,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new LimitRangesStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1211,7 +1211,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1234,7 +1235,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1371,7 +1373,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1380,7 +1383,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1414,7 +1418,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -2496,7 +2496,8 @@ functions have been all exhausted then the order is unchanged (ie a stable sort)
|
||||
<p>▸ <strong>toggleAll</strong>(<code>selectAll?</code>): <code>void</code></p>
|
||||
<p>This function selects all namespaces implicitly.</p>
|
||||
<p>NOTE: does not toggle any namespaces</p>
|
||||
<p><strong><code>deprecated</code></strong> Use <code>NamespaceStore.selectAll</code> instead.</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Use <code>NamespaceStore.selectAll</code> instead.</p>
|
||||
<h4 id="parameters_35">Parameters<a class="headerlink" href="#parameters_35" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1219,7 +1219,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1242,7 +1243,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1379,7 +1381,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1393,7 +1396,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1427,7 +1431,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new NetworkPolicyStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1307,7 +1307,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1335,7 +1336,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1514,7 +1516,8 @@ of <code>"True"</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_24">Returns<a class="headerlink" href="#returns_24" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1538,7 +1541,8 @@ of <code>"True"</code></p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1572,7 +1576,8 @@ of <code>"True"</code></p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1191,7 +1191,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#objectconstructor">objectConstructor</a></p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <code>KubeJsonApi</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <a href="../Renderer.K8sApi.KubeJsonApi/"><code>KubeJsonApi</code></a></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#request">request</a></p>
|
||||
<hr />
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1243,7 +1243,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1266,7 +1267,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1440,7 +1442,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1449,7 +1452,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1483,7 +1487,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1243,7 +1243,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1266,7 +1267,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1438,7 +1440,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1447,7 +1450,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1481,7 +1485,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_6">Parameters<a class="headerlink" href="#parameters_6" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1191,7 +1191,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#objectconstructor">objectConstructor</a></p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <code>KubeJsonApi</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <a href="../Renderer.K8sApi.KubeJsonApi/"><code>KubeJsonApi</code></a></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#request">request</a></p>
|
||||
<hr />
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1342,7 +1342,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new PersistentVolumesStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1419,7 +1419,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1452,7 +1453,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1756,7 +1758,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_38">Returns<a class="headerlink" href="#returns_38" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1780,7 +1783,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_8">Parameters<a class="headerlink" href="#parameters_8" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1814,7 +1818,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_9">Parameters<a class="headerlink" href="#parameters_9" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1243,7 +1243,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1266,7 +1267,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1423,7 +1425,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_19">Returns<a class="headerlink" href="#returns_19" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1432,7 +1435,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1466,7 +1470,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new PodDisruptionBudgetsStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1199,7 +1199,7 @@
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#objectconstructor">objectConstructor</a></p>
|
||||
<hr />
|
||||
<h3 id="request">request<a class="headerlink" href="#request" title="Permanent link">#</a></h3>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <code>KubeJsonApi</code></p>
|
||||
<p>• <code>Protected</code> <code>Readonly</code> <strong>request</strong>: <a href="../Renderer.K8sApi.KubeJsonApi/"><code>KubeJsonApi</code></a></p>
|
||||
<h4 id="inherited-from_12">Inherited from<a class="headerlink" href="#inherited-from_12" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeApi/">KubeApi</a>.<a href="../Renderer.K8sApi.KubeApi/#request">request</a></p>
|
||||
<hr />
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1279,7 +1279,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1302,7 +1303,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1449,7 +1451,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_17">Returns<a class="headerlink" href="#returns_17" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1463,7 +1466,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1497,7 +1501,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new PriorityClassStoreStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1283,7 +1283,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1316,7 +1317,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1483,7 +1485,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1497,7 +1500,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1531,7 +1535,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1211,7 +1211,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1234,7 +1235,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1371,7 +1373,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1380,7 +1383,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1414,7 +1418,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new ResourceQuotasStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1222,7 +1222,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1245,7 +1246,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1382,7 +1384,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1391,7 +1394,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1425,7 +1429,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1241,7 +1241,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1264,7 +1265,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1406,7 +1408,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1415,7 +1418,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1449,7 +1453,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1350,7 +1350,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new RoleBindingsStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new RolesStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1241,7 +1241,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1264,7 +1265,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1401,7 +1403,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_15">Returns<a class="headerlink" href="#returns_15" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1415,7 +1418,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1449,7 +1453,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new SecretsStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1291,7 +1291,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1314,7 +1315,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1491,7 +1493,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_23">Returns<a class="headerlink" href="#returns_23" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1510,7 +1513,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1544,7 +1548,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1252,7 +1252,8 @@
|
||||
<h2 id="methods_1">Methods<a class="headerlink" href="#methods_1" title="Permanent link">#</a></h2>
|
||||
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>delete</strong>(<code>params?</code>): <code>Promise</code><<a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.delete instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.delete instead</p>
|
||||
<h4 id="parameters_1">Parameters<a class="headerlink" href="#parameters_1" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1275,7 +1276,8 @@
|
||||
<hr />
|
||||
<h3 id="getage">getAge<a class="headerlink" href="#getage" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>getAge</strong>(<code>humanize?</code>, <code>compact?</code>, <code>fromNow?</code>): <code>string</code> | <code>number</code></p>
|
||||
<p><strong><code>deprecated</code></strong> This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: this function also is not reactive to updates in the current time so it should not be used for renderering</p>
|
||||
<h4 id="parameters_2">Parameters<a class="headerlink" href="#parameters_2" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
@ -1417,7 +1419,8 @@ creation timestamp of this object.</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> This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>This function computes a new "now" on every call which might cause subtle issues if called multiple times</p>
|
||||
<p>NOTE: Generally you can use <code>getCreationTimestamp</code> instead.</p>
|
||||
<h4 id="returns_16">Returns<a class="headerlink" href="#returns_16" title="Permanent link">#</a></h4>
|
||||
<p><code>number</code></p>
|
||||
@ -1426,7 +1429,8 @@ creation timestamp of this object.</p>
|
||||
<hr />
|
||||
<h3 id="patch">patch<a class="headerlink" href="#patch" title="Permanent link">#</a></h3>
|
||||
<p>▸ <strong>patch</strong>(<code>patch</code>): <code>Promise</code><<code>null</code> | <a href="../../interfaces/Renderer.K8sApi.KubeJsonApiData/"><code>KubeJsonApiData</code></a><<a href="../../modules/Renderer.K8sApi/#kubejsonapiobjectmetadata"><code>KubeJsonApiObjectMetadata</code></a><<code>KubeObjectScope</code>>, <code>unknown</code>, <code>unknown</code>>></p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.patch instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.patch instead</p>
|
||||
<h4 id="parameters_4">Parameters<a class="headerlink" href="#parameters_4" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
@ -1460,7 +1464,8 @@ creation timestamp of this object.</p>
|
||||
<p>Note: this is brittle if <code>data</code> is not actually partial (but instead whole).
|
||||
As fields such as <code>resourceVersion</code> will probably out of date. This is a
|
||||
common race condition.</p>
|
||||
<p><strong><code>deprecated</code></strong> use KubeApi.update instead</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>use KubeApi.update instead</p>
|
||||
<h4 id="parameters_5">Parameters<a class="headerlink" href="#parameters_5" title="Permanent link">#</a></h4>
|
||||
<table>
|
||||
<thead>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new ServiceAccountsStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
@ -19,7 +19,7 @@
|
||||
|
||||
|
||||
<link rel="icon" href="../../../../img/favicon.ico">
|
||||
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
<meta name="generator" content="mkdocs-1.4.0, mkdocs-material-7.1.8+insiders-2.9.2">
|
||||
|
||||
|
||||
|
||||
@ -1334,7 +1334,8 @@
|
||||
<h4 id="inherited-from">Inherited from<a class="headerlink" href="#inherited-from" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<p>• <strong>new ServiceStore</strong>()</p>
|
||||
<p><strong><code>deprecated</code></strong> Supply API instance through constructor</p>
|
||||
<p><strong><code>Deprecated</code></strong></p>
|
||||
<p>Supply API instance through constructor</p>
|
||||
<h4 id="inherited-from_1">Inherited from<a class="headerlink" href="#inherited-from_1" title="Permanent link">#</a></h4>
|
||||
<p><a href="../Renderer.K8sApi.KubeObjectStore/">KubeObjectStore</a>.<a href="../Renderer.K8sApi.KubeObjectStore/#constructor">constructor</a></p>
|
||||
<h2 id="properties_1">Properties<a class="headerlink" href="#properties_1" title="Permanent link">#</a></h2>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user