redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-14 21:21:31 +03:00
Code Activity

Updates

Browse Source
This commit is contained in:
documentation-bot
2023-11-20 18:50:28 +00:00
parent be903babd5
commit ad0655cea9
2106 changed files with 3052 additions and 2919 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
documentation/client/interfaces/lib_client.RedisClientOptions.html
View File

@@ -32,7 +32,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">RedisClientOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L21">packages/client/lib/client/index.ts:21</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L21">packages/client/lib/client/index.ts:21</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">
@@ -67,7 +67,7 @@
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L78">packages/client/lib/client/index.ts:78</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L78">packages/client/lib/client/index.ts:78</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="commandsQueueMaxLength" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>commands<wbr/>Queue<wbr/>Max<wbr/>Length</span><a href="#commandsQueueMaxLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">commands<wbr/>Queue<wbr/>Max<wbr/>Length</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -75,7 +75,7 @@
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L54">packages/client/lib/client/index.ts:54</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L54">packages/client/lib/client/index.ts:54</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="database" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>database</span><a href="#database" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">database</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -83,7 +83,7 @@
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L50">packages/client/lib/client/index.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L50">packages/client/lib/client/index.ts:50</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="disableClientInfo" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>disable<wbr/>Client<wbr/>Info</span><a href="#disableClientInfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">disable<wbr/>Client<wbr/>Info</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -91,7 +91,7 @@
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L74">packages/client/lib/client/index.ts:74</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L74">packages/client/lib/client/index.ts:74</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="disableOfflineQueue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>disable<wbr/>Offline<wbr/>Queue</span><a href="#disableOfflineQueue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">disable<wbr/>Offline<wbr/>Queue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -100,29 +100,29 @@ When <code>false</code>, commands are queued for execution after reconnection.</
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L59">packages/client/lib/client/index.ts:59</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L59">packages/client/lib/client/index.ts:59</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 viewBox="0 0 24 24"><use href="#icon-anchor"></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/0ee3278/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/9ed9cb5/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="isolationPoolOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>isolation<wbr/>Pool<wbr/>Options</span><a href="#isolationPoolOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">isolation<wbr/>Pool<wbr/>Options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Options</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L65">packages/client/lib/client/index.ts:65</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L65">packages/client/lib/client/index.ts:65</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="legacyMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>legacy<wbr/>Mode</span><a href="#legacyMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">legacy<wbr/>Mode</span><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/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L64">packages/client/lib/client/index.ts:64</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L64">packages/client/lib/client/index.ts:64</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 viewBox="0 0 24 24"><use href="#icon-anchor"></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/0ee3278/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/9ed9cb5/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="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -130,7 +130,7 @@ When <code>false</code>, commands are queued for execution after reconnection.</
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L46">packages/client/lib/client/index.ts:46</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L46">packages/client/lib/client/index.ts:46</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="password" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>password</span><a href="#password" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">password</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -138,7 +138,7 @@ When <code>false</code>, commands are queued for execution after reconnection.</
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L42">packages/client/lib/client/index.ts:42</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L42">packages/client/lib/client/index.ts:42</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="pingInterval" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ping<wbr/>Interval</span><a href="#pingInterval" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">ping<wbr/>Interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -147,7 +147,7 @@ Useful with Redis deployments that do not use TCP Keep-Alive.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L70">packages/client/lib/client/index.ts:70</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L70">packages/client/lib/client/index.ts:70</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="readonly" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>readonly</span><a href="#readonly" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">readonly</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -155,13 +155,13 @@ Useful with Redis deployments that do not use TCP Keep-Alive.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L63">packages/client/lib/client/index.ts:63</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L63">packages/client/lib/client/index.ts:63</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 viewBox="0 0 24 24"><use href="#icon-anchor"></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/0ee3278/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/9ed9cb5/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="socket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>socket</span><a href="#socket" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">socket</span><span class="tsd-signature-symbol">?:</span> <a href="../types/lib_client_socket.RedisSocketOptions.html" class="tsd-signature-type tsd-kind-type-alias">RedisSocketOptions</a></div>
@@ -169,7 +169,7 @@ Useful with Redis deployments that do not use TCP Keep-Alive.</p>
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L34">packages/client/lib/client/index.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L34">packages/client/lib/client/index.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url</span><a href="#url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -178,7 +178,7 @@ See <a href="https://www.iana.org/assignments/uri-schemes/prov/redis"><code>redi
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L30">packages/client/lib/client/index.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L30">packages/client/lib/client/index.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="username" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>username</span><a href="#username" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">username</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -186,7 +186,7 @@ See <a href="https://www.iana.org/assignments/uri-schemes/prov/redis"><code>redi
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/index.ts#L38">packages/client/lib/client/index.ts:38</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/index.ts#L38">packages/client/lib/client/index.ts:38</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">