-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
SentinelConnectionOptions.html
5 lines (5 loc) 路 31.9 KB
/
SentinelConnectionOptions.html
1
2
3
4
5
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SentinelConnectionOptions | 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="SentinelConnectionOptions.html">SentinelConnectionOptions</a></li></ul><h1>Interface SentinelConnectionOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">SentinelConnectionOptions</span></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="SentinelConnectionOptions.html#connectTimeout" class="tsd-kind-icon">connect<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#disconnectTimeout" class="tsd-kind-icon">disconnect<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#enableTLSForSentinelMode" class="tsd-kind-icon">enableTLSFor<wbr/>Sentinel<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#failoverDetector" class="tsd-kind-icon">failover<wbr/>Detector</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#natMap" class="tsd-kind-icon">nat<wbr/>Map</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#preferredSlaves" class="tsd-kind-icon">preferred<wbr/>Slaves</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#role" class="tsd-kind-icon">role</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelCommandTimeout" class="tsd-kind-icon">sentinel<wbr/>Command<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelMaxConnections" class="tsd-kind-icon">sentinel<wbr/>Max<wbr/>Connections</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelPassword" class="tsd-kind-icon">sentinel<wbr/>Password</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelTLS" class="tsd-kind-icon">sentinelTLS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelUsername" class="tsd-kind-icon">sentinel<wbr/>Username</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinels" class="tsd-kind-icon">sentinels</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#tls" class="tsd-kind-icon">tls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#updateSentinels" class="tsd-kind-icon">update<wbr/>Sentinels</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="SentinelConnectionOptions.html#sentinelReconnectStrategy" class="tsd-kind-icon">sentinel<wbr/>Reconnect<wbr/>Strategy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelRetryStrategy" class="tsd-kind-icon">sentinel<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="connectTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> connect<wbr/>Timeout<a href="#connectTimeout" 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">connect<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/connectors/SentinelConnector/index.ts#L50">connectors/SentinelConnector/index.ts:50</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="disconnectTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> disconnect<wbr/>Timeout<a href="#disconnectTimeout" 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">disconnect<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/connectors/SentinelConnector/index.ts#L51">connectors/SentinelConnector/index.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="enableTLSForSentinelMode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> enableTLSFor<wbr/>Sentinel<wbr/>Mode<a href="#enableTLSForSentinelMode" 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">enableTLSFor<wbr/>Sentinel<wbr/>Mode<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/connectors/SentinelConnector/index.ts#L53">connectors/SentinelConnector/index.ts:53</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="failoverDetector" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> failover<wbr/>Detector<a href="#failoverDetector" 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">failover<wbr/>Detector<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/connectors/SentinelConnector/index.ts#L61">connectors/SentinelConnector/index.ts:61</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> name<a href="#name" 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">name<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/luin/ioredis/blob/e41c3dc/lib/connectors/SentinelConnector/index.ts#L38">connectors/SentinelConnector/index.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Master group name of the Sentinel</p>
</div></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/connectors/SentinelConnector/index.ts#L55">connectors/SentinelConnector/index.ts:55</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="preferredSlaves" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> preferred<wbr/>Slaves<a href="#preferredSlaves" 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">preferred<wbr/>Slaves<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PreferredSlaves</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/connectors/SentinelConnector/index.ts#L49">connectors/SentinelConnector/index.ts:49</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="role" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> role<a href="#role" 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">role<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"master"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"slave"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/connectors/SentinelConnector/index.ts#L42">connectors/SentinelConnector/index.ts:42</a></li></ul></aside><div class="tsd-comment tsd-typography"><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="sentinelCommandTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinel<wbr/>Command<wbr/>Timeout<a href="#sentinelCommandTimeout" 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">sentinel<wbr/>Command<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/connectors/SentinelConnector/index.ts#L52">connectors/SentinelConnector/index.ts:52</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sentinelMaxConnections" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinel<wbr/>Max<wbr/>Connections<a href="#sentinelMaxConnections" 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">sentinel<wbr/>Max<wbr/>Connections<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/connectors/SentinelConnector/index.ts#L60">connectors/SentinelConnector/index.ts:60</a></li></ul></aside><div class="tsd-comment tsd-typography"><dl class="tsd-comment-tags"><dt>default</dt><dd><p>10</p>
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sentinelPassword" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinel<wbr/>Password<a href="#sentinelPassword" 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">sentinel<wbr/>Password<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/luin/ioredis/blob/e41c3dc/lib/connectors/SentinelConnector/index.ts#L45">connectors/SentinelConnector/index.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sentinelTLS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinelTLS<a href="#sentinelTLS" 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">sentinelTLS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ConnectionOptions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/connectors/SentinelConnector/index.ts#L54">connectors/SentinelConnector/index.ts:54</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sentinelUsername" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinel<wbr/>Username<a href="#sentinelUsername" 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">sentinel<wbr/>Username<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/luin/ioredis/blob/e41c3dc/lib/connectors/SentinelConnector/index.ts#L44">connectors/SentinelConnector/index.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sentinels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinels<a href="#sentinels" 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">sentinels<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a href="SentinelAddress.html" class="tsd-signature-type" data-tsd-kind="Interface">SentinelAddress</a><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/connectors/SentinelConnector/index.ts#L46">connectors/SentinelConnector/index.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> tls<a href="#tls" 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">tls<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">ConnectionOptions</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/luin/ioredis/blob/e41c3dc/lib/connectors/SentinelConnector/index.ts#L43">connectors/SentinelConnector/index.ts:43</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="updateSentinels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> update<wbr/>Sentinels<a href="#updateSentinels" 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">update<wbr/>Sentinels<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/connectors/SentinelConnector/index.ts#L56">connectors/SentinelConnector/index.ts:56</a></li></ul></aside></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="sentinelReconnectStrategy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinel<wbr/>Reconnect<wbr/>Strategy<a href="#sentinelReconnectStrategy" 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">sentinel<wbr/>Reconnect<wbr/>Strategy<span class="tsd-signature-symbol">(</span>retryAttempts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/connectors/SentinelConnector/index.ts#L48">connectors/SentinelConnector/index.ts:48</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>retryAttempts: <span class="tsd-signature-type">number</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 class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="sentinelRetryStrategy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sentinel<wbr/>Retry<wbr/>Strategy<a href="#sentinelRetryStrategy" 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">sentinel<wbr/>Retry<wbr/>Strategy<span class="tsd-signature-symbol">(</span>retryAttempts<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/connectors/SentinelConnector/index.ts#L47">connectors/SentinelConnector/index.ts:47</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>retryAttempts: <span class="tsd-signature-type">number</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="SentinelConnectionOptions.html" class="tsd-kind-icon">Sentinel<wbr/>Connection<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#connectTimeout" class="tsd-kind-icon">connect<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#disconnectTimeout" class="tsd-kind-icon">disconnect<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#enableTLSForSentinelMode" class="tsd-kind-icon">enableTLSFor<wbr/>Sentinel<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#failoverDetector" class="tsd-kind-icon">failover<wbr/>Detector</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#name" class="tsd-kind-icon">name</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#natMap" class="tsd-kind-icon">nat<wbr/>Map</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#preferredSlaves" class="tsd-kind-icon">preferred<wbr/>Slaves</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#role" class="tsd-kind-icon">role</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelCommandTimeout" class="tsd-kind-icon">sentinel<wbr/>Command<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelMaxConnections" class="tsd-kind-icon">sentinel<wbr/>Max<wbr/>Connections</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelPassword" class="tsd-kind-icon">sentinel<wbr/>Password</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelTLS" class="tsd-kind-icon">sentinelTLS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelUsername" class="tsd-kind-icon">sentinel<wbr/>Username</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinels" class="tsd-kind-icon">sentinels</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#tls" class="tsd-kind-icon">tls</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#updateSentinels" class="tsd-kind-icon">update<wbr/>Sentinels</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelReconnectStrategy" class="tsd-kind-icon">sentinel<wbr/>Reconnect<wbr/>Strategy</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="SentinelConnectionOptions.html#sentinelRetryStrategy" class="tsd-kind-icon">sentinel<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>