-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
ClusterOptions.html
80 lines (80 loc) 路 43.1 KB
/
ClusterOptions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ClusterOptions | ioredis</title><meta name="description" content="Documentation for ioredis"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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="../index.html" class="title">ioredis</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">ioredis</a></li><li><a href="ClusterOptions.html">ClusterOptions</a></li></ul><h1>Interface ClusterOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
<p>Options for Cluster constructor</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">CommanderOptions</span><ul class="tsd-hierarchy"><li><span class="target">ClusterOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#autoPipeliningIgnoredCommands" class="tsd-kind-icon">auto<wbr/>Pipelining<wbr/>Ignored<wbr/>Commands</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#dnsLookup" class="tsd-kind-icon">dns<wbr/>Lookup</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#enableAutoPipelining" class="tsd-kind-icon">enable<wbr/>Auto<wbr/>Pipelining</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#enableOfflineQueue" class="tsd-kind-icon">enable<wbr/>Offline<wbr/>Queue</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#enableReadyCheck" class="tsd-kind-icon">enable<wbr/>Ready<wbr/>Check</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ClusterOptions.html#keyPrefix" class="tsd-kind-icon">key<wbr/>Prefix</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#lazyConnect" class="tsd-kind-icon">lazy<wbr/>Connect</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#maxRedirections" class="tsd-kind-icon">max<wbr/>Redirections</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#natMap" class="tsd-kind-icon">nat<wbr/>Map</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#redisOptions" class="tsd-kind-icon">redis<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#resolveSrv" class="tsd-kind-icon">resolve<wbr/>Srv</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnClusterDown" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Cluster<wbr/>Down</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnFailover" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Failover</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnMoved" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Moved</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnTryAgain" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Try<wbr/>Again</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#scaleReads" class="tsd-kind-icon">scale<wbr/>Reads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#scripts" class="tsd-kind-icon">scripts</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ClusterOptions.html#showFriendlyErrorStack" class="tsd-kind-icon">show<wbr/>Friendly<wbr/>Error<wbr/>Stack</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#slotsRefreshInterval" class="tsd-kind-icon">slots<wbr/>Refresh<wbr/>Interval</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#slotsRefreshTimeout" class="tsd-kind-icon">slots<wbr/>Refresh<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#useSRVRecords" class="tsd-kind-icon">useSRVRecords</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ClusterOptions.html#clusterRetryStrategy" class="tsd-kind-icon">cluster<wbr/>Retry<wbr/>Strategy</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="autoPipeliningIgnoredCommands" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> auto<wbr/>Pipelining<wbr/>Ignored<wbr/>Commands<a href="#autoPipeliningIgnoredCommands" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">auto<wbr/>Pipelining<wbr/>Ignored<wbr/>Commands<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L190">cluster/ClusterOptions.ts:190</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See Redis class.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>[]</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="dnsLookup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> dns<wbr/>Lookup<a href="#dnsLookup" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">dns<wbr/>Lookup<span class="tsd-signature-symbol">?:</span> <a href="../index.html#DNSLookupFunction" class="tsd-signature-type" data-tsd-kind="Type alias">DNSLookupFunction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L175">cluster/ClusterOptions.ts:175</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Hostnames will be resolved to IP addresses via this function.
This is needed when the addresses of startup nodes are hostnames instead
of IPs.</p>
</div><div><p>You may provide a custom <code>lookup</code> function when you want to customize
the cache behavior of the default function.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>require('dns').lookup</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="enableAutoPipelining" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Auto<wbr/>Pipelining<a href="#enableAutoPipelining" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Auto<wbr/>Pipelining<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L183">cluster/ClusterOptions.ts:183</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See Redis class.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="enableOfflineQueue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Offline<wbr/>Queue<a href="#enableOfflineQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Offline<wbr/>Queue<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L45">cluster/ClusterOptions.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See Redis class.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>true</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="enableReadyCheck" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Ready<wbr/>Check<a href="#enableReadyCheck" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Ready<wbr/>Check<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L53">cluster/ClusterOptions.ts:53</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>When enabled, ioredis only emits "ready" event when <code>CLUSTER INFO</code>
command reporting the cluster is ready for handling commands.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>true</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="keyPrefix" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> key<wbr/>Prefix<a href="#keyPrefix" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">key<wbr/>Prefix<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from CommanderOptions.keyPrefix</p><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/utils/Commander.ts#L12">utils/Commander.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="lazyConnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> lazy<wbr/>Connect<a href="#lazyConnect" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">lazy<wbr/>Connect<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L146">cluster/ClusterOptions.ts:146</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>By default, When a new Cluster instance is created,
it will connect to the Redis cluster automatically.
If you want to keep the instance disconnected until the first command is called,
set this option to <code>true</code>.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="maxRedirections" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Redirections<a href="#maxRedirections" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Redirections<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L69">cluster/ClusterOptions.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>When a MOVED or ASK error is received, client will redirect the
command to another node.
This option limits the max redirections allowed to send a command.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>16</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="natMap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> nat<wbr/>Map<a href="#natMap" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">nat<wbr/>Map<span class="tsd-signature-symbol">?:</span> <a href="NatMap.html" class="tsd-signature-type" data-tsd-kind="Interface">NatMap</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L176">cluster/ClusterOptions.ts:176</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="redisOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> redis<wbr/>Options<a href="#redisOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">redis<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><a href="../index.html#RedisOptions" class="tsd-signature-type" data-tsd-kind="Type alias">RedisOptions</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"port"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"host"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"path"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"retryStrategy"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"readOnly"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"enableOfflineQueue"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sentinels"</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L127">cluster/ClusterOptions.ts:127</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Passed to the constructor of <code>Redis</code></p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>null</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="resolveSrv" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> resolve<wbr/>Srv<a href="#resolveSrv" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">resolve<wbr/>Srv<span class="tsd-signature-symbol">?:</span> <a href="../index.html#DNSResolveSrvFunction" class="tsd-signature-type" data-tsd-kind="Type alias">DNSResolveSrvFunction</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L163">cluster/ClusterOptions.ts:163</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>SRV records will be resolved via this function.</p>
</div><div><p>You may provide a custom <code>resolveSrv</code> function when you want to customize
the cache behavior of the default function.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>require('dns').resolveSrv</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="retryDelayOnClusterDown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> retry<wbr/>Delay<wbr/>On<wbr/>Cluster<wbr/>Down<a href="#retryDelayOnClusterDown" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Cluster<wbr/>Down<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L86">cluster/ClusterOptions.ts:86</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>When a CLUSTERDOWN error is received, client will retry
if <code>retryDelayOnClusterDown</code> is valid delay time (in ms).</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>100</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="retryDelayOnFailover" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> retry<wbr/>Delay<wbr/>On<wbr/>Failover<a href="#retryDelayOnFailover" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Failover<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L78">cluster/ClusterOptions.ts:78</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>When an error is received when sending a command (e.g.
"Connection is closed." when the target Redis node is down), client will retry
if <code>retryDelayOnFailover</code> is valid delay time (in ms).</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>100</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="retryDelayOnMoved" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> retry<wbr/>Delay<wbr/>On<wbr/>Moved<a href="#retryDelayOnMoved" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Moved<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L105">cluster/ClusterOptions.ts:105</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>By default, this value is 0, which means when a <code>MOVED</code> error is received,
the client will resend the command instantly to the node returned together with
the <code>MOVED</code> error. However, sometimes it takes time for a cluster to become
state stabilized after a failover, so adding a delay before resending can
prevent a ping pong effect.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>0</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="retryDelayOnTryAgain" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> retry<wbr/>Delay<wbr/>On<wbr/>Try<wbr/>Again<a href="#retryDelayOnTryAgain" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Try<wbr/>Again<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L94">cluster/ClusterOptions.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>When a TRYAGAIN error is received, client will retry
if <code>retryDelayOnTryAgain</code> is valid delay time (in ms).</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>100</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="scaleReads" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> scale<wbr/>Reads<a href="#scaleReads" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">scale<wbr/>Reads<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> | </span><a href="../index.html#NodeRole" class="tsd-signature-type" data-tsd-kind="Type alias">NodeRole</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L60">cluster/ClusterOptions.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Scale reads to the node with the specified role.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>"master"</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="scripts" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> scripts<a href="#scripts" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">scripts<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">{ </span>lua<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>numberOfKeys<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>readOnly<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L195">cluster/ClusterOptions.ts:195</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Custom LUA commands</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="showFriendlyErrorStack" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> show<wbr/>Friendly<wbr/>Error<wbr/>Stack<a href="#showFriendlyErrorStack" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">show<wbr/>Friendly<wbr/>Error<wbr/>Stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from CommanderOptions.showFriendlyErrorStack</p><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/utils/Commander.ts#L13">utils/Commander.ts:13</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="slotsRefreshInterval" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> slots<wbr/>Refresh<wbr/>Interval<a href="#slotsRefreshInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">slots<wbr/>Refresh<wbr/>Interval<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L120">cluster/ClusterOptions.ts:120</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The milliseconds between every automatic slots refresh.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>5000</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="slotsRefreshTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> slots<wbr/>Refresh<wbr/>Timeout<a href="#slotsRefreshTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">slots<wbr/>Refresh<wbr/>Timeout<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/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L113">cluster/ClusterOptions.ts:113</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The milliseconds before a timeout occurs while refreshing
slots from the cluster.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>1000</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="useSRVRecords" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> useSRVRecords<a href="#useSRVRecords" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">useSRVRecords<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L153">cluster/ClusterOptions.ts:153</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Discover nodes using SRV records</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
</dd></dl></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="clusterRetryStrategy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> cluster<wbr/>Retry<wbr/>Strategy<a href="#clusterRetryStrategy" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">cluster<wbr/>Retry<wbr/>Strategy<span class="tsd-signature-symbol">(</span>times<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, reason<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/cluster/ClusterOptions.ts#L35">cluster/ClusterOptions.ts:35</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>See "Quick Start" section.</p>
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>(times) => Math.min(100 + times * 2, 2000)</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>times: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> reason: <span class="tsd-signature-type">Error</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="ClusterOptions.html" class="tsd-kind-icon">Cluster<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#autoPipeliningIgnoredCommands" class="tsd-kind-icon">auto<wbr/>Pipelining<wbr/>Ignored<wbr/>Commands</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#dnsLookup" class="tsd-kind-icon">dns<wbr/>Lookup</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#enableAutoPipelining" class="tsd-kind-icon">enable<wbr/>Auto<wbr/>Pipelining</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#enableOfflineQueue" class="tsd-kind-icon">enable<wbr/>Offline<wbr/>Queue</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#enableReadyCheck" class="tsd-kind-icon">enable<wbr/>Ready<wbr/>Check</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ClusterOptions.html#keyPrefix" class="tsd-kind-icon">key<wbr/>Prefix</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#lazyConnect" class="tsd-kind-icon">lazy<wbr/>Connect</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#maxRedirections" class="tsd-kind-icon">max<wbr/>Redirections</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#natMap" class="tsd-kind-icon">nat<wbr/>Map</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#redisOptions" class="tsd-kind-icon">redis<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#resolveSrv" class="tsd-kind-icon">resolve<wbr/>Srv</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnClusterDown" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Cluster<wbr/>Down</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnFailover" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Failover</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnMoved" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Moved</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#retryDelayOnTryAgain" class="tsd-kind-icon">retry<wbr/>Delay<wbr/>On<wbr/>Try<wbr/>Again</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#scaleReads" class="tsd-kind-icon">scale<wbr/>Reads</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#scripts" class="tsd-kind-icon">scripts</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="ClusterOptions.html#showFriendlyErrorStack" class="tsd-kind-icon">show<wbr/>Friendly<wbr/>Error<wbr/>Stack</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#slotsRefreshInterval" class="tsd-kind-icon">slots<wbr/>Refresh<wbr/>Interval</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#slotsRefreshTimeout" class="tsd-kind-icon">slots<wbr/>Refresh<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="ClusterOptions.html#useSRVRecords" class="tsd-kind-icon">useSRVRecords</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="ClusterOptions.html#clusterRetryStrategy" class="tsd-kind-icon">cluster<wbr/>Retry<wbr/>Strategy</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>