redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-11 22:42:42 +03:00
Code Activity

Updates

Browse Source
This commit is contained in:
documentation-bot
2023-05-29 13:41:43 +00:00
parent dc7acd04a8
commit b14eaaf890
2065 changed files with 2866 additions and 2866 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/client/interfaces/lib_cluster.RedisClusterOptions.html
View File

@@ -32,7 +32,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">RedisClusterOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/cluster/index.ts#L17">packages/client/lib/cluster/index.ts:17</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/cluster/index.ts#L17">packages/client/lib/cluster/index.ts:17</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">
@@ -59,20 +59,20 @@
for example: ACL credentials, timeouts, TLS configuration etc.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/cluster/index.ts#L31">packages/client/lib/cluster/index.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/cluster/index.ts#L31">packages/client/lib/cluster/index.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="functions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>functions</span><a href="#functions" 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"><span class="tsd-kind-property">functions</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type tsd-kind-type-parameter">F</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisExtensions.html">RedisExtensions</a>.<a href="lib_commands.RedisExtensions.html#functions">functions</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/commands/index.ts#L87">packages/client/lib/commands/index.ts:87</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/commands/index.ts#L87">packages/client/lib/commands/index.ts:87</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="maxCommandRedirections" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>max<wbr/>Command<wbr/>Redirections</span><a href="#maxCommandRedirections" 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"><span class="tsd-kind-property">max<wbr/>Command<wbr/>Redirections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>The maximum number of times a command will be redirected due to <code>MOVED</code> or <code>ASK</code> errors.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/cluster/index.ts#L44">packages/client/lib/cluster/index.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/cluster/index.ts#L44">packages/client/lib/cluster/index.ts:44</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="minimizeConnections" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>minimize<wbr/>Connections</span><a href="#minimizeConnections" 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"><span class="tsd-kind-property">minimize<wbr/>Connections</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -80,13 +80,13 @@ for example: ACL credentials, timeouts, TLS configuration etc.</p>
Useful for short-term or PubSub-only connections.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/cluster/index.ts#L36">packages/client/lib/cluster/index.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/cluster/index.ts#L36">packages/client/lib/cluster/index.ts:36</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="modules" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>modules</span><a href="#modules" 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"><span class="tsd-kind-property">modules</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type tsd-kind-type-parameter">M</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisExtensions.html">RedisExtensions</a>.<a href="lib_commands.RedisExtensions.html#modules">modules</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/commands/index.ts#L86">packages/client/lib/commands/index.ts:86</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/commands/index.ts#L86">packages/client/lib/commands/index.ts:86</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="nodeAddressMap" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>node<wbr/>Address<wbr/>Map</span><a href="#nodeAddressMap" 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"><span class="tsd-kind-property">node<wbr/>Address<wbr/>Map</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib_cluster_cluster_slots.NodeAddressMap.html" class="tsd-signature-type tsd-kind-type-alias">NodeAddressMap</a></div>
@@ -94,7 +94,7 @@ Useful for short-term or PubSub-only connections.</p>
Useful when the cluster is running on another network</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/cluster/index.ts#L50">packages/client/lib/cluster/index.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/cluster/index.ts#L50">packages/client/lib/cluster/index.ts:50</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="rootNodes" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>root<wbr/>Nodes</span><a href="#rootNodes" 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"><span class="tsd-kind-property">root<wbr/>Nodes</span><span class="tsd-signature-symbol">:</span> <a href="../types/lib_cluster.RedisClusterClientOptions.html" class="tsd-signature-type tsd-kind-type-alias">RedisClusterClientOptions</a><span class="tsd-signature-symbol">[]</span></div>
@@ -102,20 +102,20 @@ Useful when the cluster is running on another network</p>
the &quot;cluster topology&quot;. We recommend including details for at least 3 nodes here.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/cluster/index.ts#L26">packages/client/lib/cluster/index.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/cluster/index.ts#L26">packages/client/lib/cluster/index.ts:26</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="scripts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>scripts</span><a href="#scripts" 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"><span class="tsd-kind-property">scripts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type tsd-kind-type-parameter">S</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisExtensions.html">RedisExtensions</a>.<a href="lib_commands.RedisExtensions.html#scripts">scripts</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/commands/index.ts#L88">packages/client/lib/commands/index.ts:88</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/commands/index.ts#L88">packages/client/lib/commands/index.ts:88</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="useReplicas" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>use<wbr/>Replicas</span><a href="#useReplicas" 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"><span class="tsd-kind-property">use<wbr/>Replicas</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>When <code>true</code>, distribute load by executing readonly commands (such as <code>GET</code>, <code>GEOSEARCH</code>, etc.) across all cluster nodes. When <code>false</code>, only use master nodes.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0298c1a/packages/client/lib/cluster/index.ts#L40">packages/client/lib/cluster/index.ts:40</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/454617b/packages/client/lib/cluster/index.ts#L40">packages/client/lib/cluster/index.ts:40</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">