1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-19 07:02:06 +03:00
This commit is contained in:
documentation-bot
2023-01-25 16:31:23 +00:00
parent a7c796ca18
commit bbe4ce4a3a
2065 changed files with 18112 additions and 3239 deletions

View File

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">RedisClusterMasterNode</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/CLUSTER_NODES.ts#L26">packages/client/lib/commands/CLUSTER_NODES.ts:26</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L26">packages/client/lib/commands/CLUSTER_NODES.ts:26</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">
@@ -51,71 +51,71 @@
<div class="tsd-signature">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#address">address</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 tsd-is-inherited"><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">
<p>Inherited from <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#configEpoch">configEpoch</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#cport">cport</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 tsd-is-inherited"><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">
<p>Inherited from <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#flags">flags</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#host">host</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 tsd-is-inherited"><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">
<p>Inherited from <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 tsd-is-inherited"><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">
<p>Inherited from <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#linkState">linkState</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 tsd-is-inherited"><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">
<p>Inherited from <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#pingSent">pingSent</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 tsd-is-inherited"><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">
<p>Inherited from <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#pongRecv">pongRecv</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/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/3b1bad2/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 <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html">RedisClusterReplicaNode</a>.<a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html#port">port</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/CLUSTER_NODES.ts#L12">packages/client/lib/commands/CLUSTER_NODES.ts:12</a></li></ul></aside></section>
<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 class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="replicas" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>replicas</span><a href="#replicas" 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">replicas<span class="tsd-signature-symbol">:</span> <a href="lib_commands_CLUSTER_NODES.RedisClusterReplicaNode.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClusterReplicaNode</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/CLUSTER_NODES.ts#L31">packages/client/lib/commands/CLUSTER_NODES.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L31">packages/client/lib/commands/CLUSTER_NODES.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="slots" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>slots</span><a href="#slots" 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">slots<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>to<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</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/e75a5db/packages/client/lib/commands/CLUSTER_NODES.ts#L27">packages/client/lib/commands/CLUSTER_NODES.ts:27</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/CLUSTER_NODES.ts#L27">packages/client/lib/commands/CLUSTER_NODES.ts:27</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">
@@ -147,6 +147,7 @@
<li class="tsd-kind-module"><a href="../modules/lib_client_commands.html">lib/client/commands</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_commands_queue.html">lib/client/commands-<wbr/>queue</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_multi_command.html">lib/client/multi-<wbr/>command</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_pub_sub.html">lib/client/pub-<wbr/>sub</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_socket.html">lib/client/socket</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_cluster.html">lib/cluster</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_cluster_cluster_slots.html">lib/cluster/cluster-<wbr/>slots</a></li>
@@ -363,6 +364,7 @@
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_CHANNELS.html">lib/commands/PUBSUB_<wbr/>CHANNELS</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_NUMPAT.html">lib/commands/PUBSUB_<wbr/>NUMPAT</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_NUMSUB.html">lib/commands/PUBSUB_<wbr/>NUMSUB</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_SHARDCHANNELS.html">lib/commands/PUBSUB_<wbr/>SHARDCHANNELS</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_RANDOMKEY.html">lib/commands/RANDOMKEY</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_READONLY.html">lib/commands/READONLY</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_READWRITE.html">lib/commands/READWRITE</a></li>
@@ -404,6 +406,7 @@
<li class="tsd-kind-module"><a href="../modules/lib_commands_SORT_RO.html">lib/commands/SORT_<wbr/>RO</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SORT_STORE.html">lib/commands/SORT_<wbr/>STORE</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SPOP.html">lib/commands/SPOP</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SPUBLISH.html">lib/commands/SPUBLISH</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SRANDMEMBER.html">lib/commands/SRANDMEMBER</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SRANDMEMBER_COUNT.html">lib/commands/SRANDMEMBER_<wbr/>COUNT</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SREM.html">lib/commands/SREM</a></li>