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

Updates

Browse Source
This commit is contained in:
documentation-bot
2023-01-28 23:46:58 +00:00
parent b2a75a9b35
commit 657dcd20b9
2062 changed files with 2860 additions and 2860 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
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/f1e951d/packages/client/lib/client/index.ts#L20">packages/client/lib/client/index.ts:20</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L20">packages/client/lib/client/index.ts:20</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">
@@ -64,14 +64,14 @@
<div class="tsd-comment tsd-typography"><p>Maximum length of the client&#39;s internal command queue</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L53">packages/client/lib/client/index.ts:53</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L53">packages/client/lib/client/index.ts:53</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">database<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
<div class="tsd-comment tsd-typography"><p>Redis database number (see <a href="https://redis.io/commands/select"><code>SELECT</code></a> command)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L49">packages/client/lib/client/index.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L49">packages/client/lib/client/index.ts:49</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">disable<wbr/>Offline<wbr/>Queue<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
@@ -79,43 +79,43 @@
When <code>false</code>, commands are queued for execution after reconnection.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L58">packages/client/lib/client/index.ts:58</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L58">packages/client/lib/client/index.ts:58</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="functions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>functions</span><a href="#functions" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">functions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-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/f1e951d/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/7a0334f/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 tsd-kind-property tsd-parent-kind-interface"><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 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">isolation<wbr/>Pool<wbr/>Options<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/f1e951d/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/7a0334f/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-kind-property tsd-parent-kind-interface"><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 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">legacy<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/redis/node-redis/blob/f1e951d/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/7a0334f/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-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="modules" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>modules</span><a href="#modules" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">modules<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-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/f1e951d/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/7a0334f/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 tsd-kind-property tsd-parent-kind-interface"><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 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">name<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>Client name (<a href="https://redis.io/commands/client-setname">see <code>CLIENT SETNAME</code></a>)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L45">packages/client/lib/client/index.ts:45</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L45">packages/client/lib/client/index.ts:45</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">password<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>ACL password or the old &quot;--requirepass&quot; password</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L41">packages/client/lib/client/index.ts:41</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L41">packages/client/lib/client/index.ts:41</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">ping<wbr/>Interval<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
@@ -123,27 +123,27 @@ When <code>false</code>, commands are queued for execution after reconnection.</
Useful with Redis deployments that do not use TCP Keep-Alive.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L69">packages/client/lib/client/index.ts:69</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L69">packages/client/lib/client/index.ts:69</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">readonly<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div>
<div class="tsd-comment tsd-typography"><p>Connect in <a href="https://redis.io/commands/readonly"><code>READONLY</code></a> mode</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L62">packages/client/lib/client/index.ts:62</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L62">packages/client/lib/client/index.ts:62</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="scripts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>scripts</span><a href="#scripts" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">scripts<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-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/f1e951d/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/7a0334f/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 tsd-kind-property tsd-parent-kind-interface"><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 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">socket<span class="tsd-signature-symbol">?:</span> <a href="../types/lib_client_socket.RedisSocketOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisSocketOptions</a></div>
<div class="tsd-comment tsd-typography"><p>Socket connection properties</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L33">packages/client/lib/client/index.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L33">packages/client/lib/client/index.ts:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -151,14 +151,14 @@ Useful with Redis deployments that do not use TCP Keep-Alive.</p>
See <a href="https://www.iana.org/assignments/uri-schemes/prov/redis"><code>redis</code></a> and <a href="https://www.iana.org/assignments/uri-schemes/prov/rediss"><code>rediss</code></a> IANA registration for more details</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L29">packages/client/lib/client/index.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L29">packages/client/lib/client/index.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><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 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">username<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>ACL username (<a href="https://redis.io/topics/acl">see ACL guide</a>)</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/client/lib/client/index.ts#L37">packages/client/lib/client/index.ts:37</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/client/lib/client/index.ts#L37">packages/client/lib/client/index.ts:37</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">