1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-11 22:42:42 +03:00
This commit is contained in:
documentation-bot
2023-01-25 18:25:23 +00:00
parent 2f3f888689
commit f33d41f16d
2062 changed files with 2860 additions and 2860 deletions

View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">RedisSocketCommonOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/b06f92a/packages/client/lib/client/socket.ts#L8">packages/client/lib/client/socket.ts:8</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f3ed246/packages/client/lib/client/socket.ts#L8">packages/client/lib/client/socket.ts:8</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">
@@ -42,21 +42,21 @@
<div class="tsd-comment tsd-typography"><p>Connection Timeout (in milliseconds)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/b06f92a/packages/client/lib/client/socket.ts#L12">packages/client/lib/client/socket.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f3ed246/packages/client/lib/client/socket.ts#L12">packages/client/lib/client/socket.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="keepAlive" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>keep<wbr/>Alive</span><a href="#keepAlive" 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">keep<wbr/>Alive<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span></div>
<div class="tsd-comment tsd-typography"><p>Toggle <a href="https://nodejs.org/api/net.html#net_socket_setkeepalive_enable_initialdelay"><code>keep-alive</code></a></p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/b06f92a/packages/client/lib/client/socket.ts#L20">packages/client/lib/client/socket.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f3ed246/packages/client/lib/client/socket.ts#L20">packages/client/lib/client/socket.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="noDelay" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>no<wbr/>Delay</span><a href="#noDelay" 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">no<wbr/>Delay<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Toggle <a href="https://nodejs.org/api/net.html#net_socket_setnodelay_nodelay"><code>Nagle&#39;s algorithm</code></a></p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/b06f92a/packages/client/lib/client/socket.ts#L16">packages/client/lib/client/socket.ts:16</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f3ed246/packages/client/lib/client/socket.ts#L16">packages/client/lib/client/socket.ts:16</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="reconnectStrategy" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>reconnect<wbr/>Strategy</span><a href="#reconnectStrategy" 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">reconnect<wbr/>Strategy<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>retries<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, cause<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol">)</span></div>
@@ -69,7 +69,7 @@ Defaults to <code>retries =&gt; Math.min(retries * 50, 500)</code></li>
</ol>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/b06f92a/packages/client/lib/client/socket.ts#L28">packages/client/lib/client/socket.ts:28</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f3ed246/packages/client/lib/client/socket.ts#L28">packages/client/lib/client/socket.ts:28</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">