1
0
mirror of https://github.com/redis/node-redis.git synced 2025-12-09 21:21:11 +03:00
This commit is contained in:
documentation-bot
2023-01-25 18:14:55 +00:00
parent bbe4ce4a3a
commit fc7589a0fd
2093 changed files with 5661 additions and 5499 deletions

View File

@@ -6,7 +6,7 @@
<div id="tsd-toolbar-links"></div></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li></ul><a href="" class="title">@redis/client</a></div>
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@redis/client</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
<div class="container container-main">
<div class="col-8 col-content">
@@ -25,7 +25,7 @@
<ul class="tsd-hierarchy">
<li><a href="lib_commands_CLUSTER_NODES.RedisClusterMasterNode.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClusterMasterNode</a></li></ul></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L16">packages/client/lib/commands/CLUSTER_NODES.ts:16</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L16">packages/client/lib/commands/CLUSTER_NODES.ts:16</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -50,55 +50,55 @@
<h3 class="tsd-anchor-link"><span>address</span><a href="#address" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L18">packages/client/lib/commands/CLUSTER_NODES.ts:18</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L18">packages/client/lib/commands/CLUSTER_NODES.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="configEpoch" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>config<wbr/>Epoch</span><a href="#configEpoch" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">config<wbr/>Epoch<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L22">packages/client/lib/commands/CLUSTER_NODES.ts:22</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L22">packages/client/lib/commands/CLUSTER_NODES.ts:22</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="cport" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>cport</span><a href="#cport" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">cport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from RedisClusterNodeAddress.cport</p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L13">packages/client/lib/commands/CLUSTER_NODES.ts:13</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L13">packages/client/lib/commands/CLUSTER_NODES.ts:13</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="flags" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>flags</span><a href="#flags" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">flags<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L19">packages/client/lib/commands/CLUSTER_NODES.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L19">packages/client/lib/commands/CLUSTER_NODES.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="host" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>host</span><a href="#host" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from RedisClusterNodeAddress.host</p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L11">packages/client/lib/commands/CLUSTER_NODES.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L11">packages/client/lib/commands/CLUSTER_NODES.ts:11</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L17">packages/client/lib/commands/CLUSTER_NODES.ts:17</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L17">packages/client/lib/commands/CLUSTER_NODES.ts:17</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="linkState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>link<wbr/>State</span><a href="#linkState" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">link<wbr/>State<span class="tsd-signature-symbol">:</span> <a href="../enums/lib_commands_CLUSTER_NODES.RedisClusterNodeLinkStates.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RedisClusterNodeLinkStates</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L23">packages/client/lib/commands/CLUSTER_NODES.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L23">packages/client/lib/commands/CLUSTER_NODES.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pingSent" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ping<wbr/>Sent</span><a href="#pingSent" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">ping<wbr/>Sent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L20">packages/client/lib/commands/CLUSTER_NODES.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L20">packages/client/lib/commands/CLUSTER_NODES.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pongRecv" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>pong<wbr/>Recv</span><a href="#pongRecv" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">pong<wbr/>Recv<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L21">packages/client/lib/commands/CLUSTER_NODES.ts:21</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L21">packages/client/lib/commands/CLUSTER_NODES.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="port" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>port</span><a href="#port" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
<p>Inherited from RedisClusterNodeAddress.port</p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L12">packages/client/lib/commands/CLUSTER_NODES.ts:12</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0a46fcb/packages/client/lib/commands/CLUSTER_NODES.ts#L12">packages/client/lib/commands/CLUSTER_NODES.ts:12</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">