redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-12-15 23:55:38 +03:00
Code Activity

Updates

Browse Source
This commit is contained in:
documentation-bot
2022-07-28 17:35:40 +00:00
parent c0eec25b22
commit d0728aff9d
552 changed files with 899 additions and 899 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
documentation/client/classes/lib_client.default.html
View File

@@ -156,32 +156,32 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#isolation<wbr/>Pool</span><a href="#_isolationPool" 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<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pool</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/lib_client.RedisClientType.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L157">packages/client/lib/client/index.ts:157</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L157">packages/client/lib/client/index.ts:157</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_options" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#options</span><a href="#_options" 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">#options<span class="tsd-signature-symbol">?:</span> <a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L154">packages/client/lib/client/index.ts:154</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L154">packages/client/lib/client/index.ts:154</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_queue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#queue</span><a href="#_queue" 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">#queue<span class="tsd-signature-symbol">:</span> <a href="lib_client_commands_queue.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L156">packages/client/lib/client/index.ts:156</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L156">packages/client/lib/client/index.ts:156</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_selectedDB" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#selectedDB</span><a href="#_selectedDB" 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">#selectedDB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L159">packages/client/lib/client/index.ts:159</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L159">packages/client/lib/client/index.ts:159</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_socket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</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="lib_client_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L155">packages/client/lib/client/index.ts:155</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L155">packages/client/lib/client/index.ts:155</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_v4" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#v4</span><a href="#_v4" 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">#v4<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L158">packages/client/lib/client/index.ts:158</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L158">packages/client/lib/client/index.ts:158</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="commandOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>command<wbr/>Options</span><a href="#commandOptions" 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">command<wbr/>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../types/lib_command_options.CommandOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = RedisClient.commandOptions</span></div>
@@ -205,7 +205,7 @@
<h5>options: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../types/lib_command_options.CommandOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L83">packages/client/lib/client/index.ts:83</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L83">packages/client/lib/client/index.ts:83</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pSubscribe" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>p<wbr/>Subscribe</span><a href="#pSubscribe" 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">p<wbr/>Subscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../types/lib_client_commands_queue.PubSubListener.html" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -233,7 +233,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L525">packages/client/lib/client/index.ts:525</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L525">packages/client/lib/client/index.ts:525</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pUnsubscribe" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>p<wbr/>Unsubscribe</span><a href="#pUnsubscribe" 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">p<wbr/>Unsubscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../types/lib_client_commands_queue.PubSubListener.html" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -261,7 +261,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L566">packages/client/lib/client/index.ts:566</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L566">packages/client/lib/client/index.ts:566</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="quit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>quit</span><a href="#quit" 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">quit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -275,7 +275,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L581">packages/client/lib/client/index.ts:581</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L581">packages/client/lib/client/index.ts:581</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="select" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>select</span><a href="#select" 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">select<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><span class="tsd-signature-symbol">(</span>db<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../types/lib_command_options.CommandOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span>, db<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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -304,7 +304,7 @@
<h5>db: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L479">packages/client/lib/client/index.ts:479</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L479">packages/client/lib/client/index.ts:479</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="subscribe" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>subscribe</span><a href="#subscribe" 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">subscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../types/lib_client_commands_queue.PubSubListener.html" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -332,7 +332,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L510">packages/client/lib/client/index.ts:510</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L510">packages/client/lib/client/index.ts:510</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="unsubscribe" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>unsubscribe</span><a href="#unsubscribe" 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">unsubscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../types/lib_client_commands_queue.PubSubListener.html" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -360,7 +360,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/index.ts#L551">packages/client/lib/client/index.ts:551</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/index.ts#L551">packages/client/lib/client/index.ts:551</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" 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">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="lib_client.default.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources">

2
documentation/client/classes/lib_client_RESP2_composers_buffer.default.html
View File

@@ -56,7 +56,7 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>chunks</span><a href="#chunks" 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">chunks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Buffer</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/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/composers/buffer.ts#L4">packages/client/lib/client/RESP2/composers/buffer.ts:4</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/composers/buffer.ts#L4">packages/client/lib/client/RESP2/composers/buffer.ts:4</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-class"><a id="end" class="tsd-anchor"></a>

4
documentation/client/classes/lib_client_RESP2_composers_string.default.html
View File

@@ -57,12 +57,12 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>decoder</span><a href="#decoder" 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">decoder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">StringDecoder</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/composers/string.ts#L5">packages/client/lib/client/RESP2/composers/string.ts:5</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/composers/string.ts#L5">packages/client/lib/client/RESP2/composers/string.ts:5</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="string" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>string</span><a href="#string" 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">string<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = &#39;&#39;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/composers/string.ts#L7">packages/client/lib/client/RESP2/composers/string.ts:7</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/composers/string.ts#L7">packages/client/lib/client/RESP2/composers/string.ts:7</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-class"><a id="end" class="tsd-anchor"></a>

22
documentation/client/classes/lib_client_RESP2_decoder.default.html
View File

@@ -75,57 +75,57 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>array<wbr/>Item<wbr/>Type</span><a href="#arrayItemType" 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">array<wbr/>Item<wbr/>Type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Types</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L192">packages/client/lib/client/RESP2/decoder.ts:192</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L192">packages/client/lib/client/RESP2/decoder.ts:192</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="arraysInProcess" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>arrays<wbr/>In<wbr/>Process</span><a href="#arraysInProcess" 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">arrays<wbr/>In<wbr/>Process<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ArrayInProcess</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/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L188">packages/client/lib/client/RESP2/decoder.ts:188</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L188">packages/client/lib/client/RESP2/decoder.ts:188</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="bufferComposer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>buffer<wbr/>Composer</span><a href="#bufferComposer" 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">buffer<wbr/>Composer<span class="tsd-signature-symbol">:</span> <a href="lib_client_RESP2_composers_buffer.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L48">packages/client/lib/client/RESP2/decoder.ts:48</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L48">packages/client/lib/client/RESP2/decoder.ts:48</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="bulkStringRemainingLength" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>bulk<wbr/>String<wbr/>Remaining<wbr/>Length</span><a href="#bulkStringRemainingLength" 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">bulk<wbr/>String<wbr/>Remaining<wbr/>Length<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/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L159">packages/client/lib/client/RESP2/decoder.ts:159</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L159">packages/client/lib/client/RESP2/decoder.ts:159</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="currentStringComposer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>current<wbr/>String<wbr/>Composer</span><a href="#currentStringComposer" 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">current<wbr/>String<wbr/>Composer<span class="tsd-signature-symbol">:</span> <a href="lib_client_RESP2_composers_buffer.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> | </span><a href="lib_client_RESP2_composers_string.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L52">packages/client/lib/client/RESP2/decoder.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L52">packages/client/lib/client/RESP2/decoder.ts:52</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="cursor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>cursor</span><a href="#cursor" 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">cursor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L44">packages/client/lib/client/RESP2/decoder.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L44">packages/client/lib/client/RESP2/decoder.ts:44</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="initializeArray" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>initialize<wbr/>Array</span><a href="#initializeArray" 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">initialize<wbr/>Array<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L190">packages/client/lib/client/RESP2/decoder.ts:190</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L190">packages/client/lib/client/RESP2/decoder.ts:190</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="integer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>integer</span><a href="#integer" 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">integer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L135">packages/client/lib/client/RESP2/decoder.ts:135</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L135">packages/client/lib/client/RESP2/decoder.ts:135</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="isNegativeInteger" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>is<wbr/>Negative<wbr/>Integer</span><a href="#isNegativeInteger" 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">is<wbr/>Negative<wbr/>Integer<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/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L137">packages/client/lib/client/RESP2/decoder.ts:137</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L137">packages/client/lib/client/RESP2/decoder.ts:137</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="stringComposer" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>string<wbr/>Composer</span><a href="#stringComposer" 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">string<wbr/>Composer<span class="tsd-signature-symbol">:</span> <a href="lib_client_RESP2_composers_string.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L50">packages/client/lib/client/RESP2/decoder.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L50">packages/client/lib/client/RESP2/decoder.ts:50</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>type</span><a href="#type" 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">type<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Types</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/RESP2/decoder.ts#L46">packages/client/lib/client/RESP2/decoder.ts:46</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/RESP2/decoder.ts#L46">packages/client/lib/client/RESP2/decoder.ts:46</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-class"><a id="compose" class="tsd-anchor"></a>

14
documentation/client/classes/lib_client_commands_queue.default.html
View File

@@ -73,17 +73,17 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#chain<wbr/>In<wbr/>Execution</span><a href="#_chainInExecution" 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">#chain<wbr/>In<wbr/>Execution<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/commands-queue.ts#L107">packages/client/lib/client/commands-queue.ts:107</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/commands-queue.ts#L107">packages/client/lib/client/commands-queue.ts:107</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_decoder" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#decoder</span><a href="#_decoder" 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">#decoder<span class="tsd-signature-symbol">:</span> <a href="lib_client_RESP2_decoder.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/commands-queue.ts#L109">packages/client/lib/client/commands-queue.ts:109</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/commands-queue.ts#L109">packages/client/lib/client/commands-queue.ts:109</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_maxLength" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#max<wbr/>Length</span><a href="#_maxLength" 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">#max<wbr/>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><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/redis/node-redis/blob/c1fd867/packages/client/lib/client/commands-queue.ts#L83">packages/client/lib/client/commands-queue.ts:83</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/commands-queue.ts#L83">packages/client/lib/client/commands-queue.ts:83</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_pubSubState" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#pub<wbr/>Sub<wbr/>State</span><a href="#_pubSubState" 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">#pub<wbr/>Sub<wbr/>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>isActive<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>listeners<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>subscribed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>subscribing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>unsubscribing<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></div>
@@ -106,17 +106,17 @@
<li class="tsd-parameter">
<h5>unsubscribing<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/commands-queue.ts#L87">packages/client/lib/client/commands-queue.ts:87</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/commands-queue.ts#L87">packages/client/lib/client/commands-queue.ts:87</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_waitingForReply" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#waiting<wbr/>For<wbr/>Reply</span><a href="#_waitingForReply" 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">#waiting<wbr/>For<wbr/>Reply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Yallist</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">CommandWaitingForReply</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/commands-queue.ts#L85">packages/client/lib/client/commands-queue.ts:85</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/commands-queue.ts#L85">packages/client/lib/client/commands-queue.ts:85</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_waitingToBeSent" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#waiting<wbr/>To<wbr/>Be<wbr/>Sent</span><a href="#_waitingToBeSent" 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">#waiting<wbr/>To<wbr/>Be<wbr/>Sent<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Yallist</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">CommandWaitingToBeSent</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/commands-queue.ts#L84">packages/client/lib/client/commands-queue.ts:84</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/commands-queue.ts#L84">packages/client/lib/client/commands-queue.ts:84</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_PUB_SUB_MESSAGES" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#PUB_<wbr/>SUB_<wbr/>MESSAGES</span><a href="#_PUB_SUB_MESSAGES" 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">#PUB_<wbr/>SUB_<wbr/>MESSAGES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>pMessage<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>pSubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>pUnsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>subscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol">; </span>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -136,7 +136,7 @@
<li class="tsd-parameter">
<h5>unsubscribe<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></h5></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/commands-queue.ts#L98">packages/client/lib/client/commands-queue.ts:98</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/commands-queue.ts#L98">packages/client/lib/client/commands-queue.ts:98</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-class"><a id="_handlePubSubReply" class="tsd-anchor"></a>

12
documentation/client/classes/lib_client_multi_command.default.html
View File

@@ -71,17 +71,17 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#executor</span><a href="#_executor" 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">#executor<span class="tsd-signature-symbol">:</span> <a href="../types/lib_client_multi_command.RedisClientMultiExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientMultiExecutor</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/multi-command.ts#L85">packages/client/lib/client/multi-command.ts:85</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/multi-command.ts#L85">packages/client/lib/client/multi-command.ts:85</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_multi" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#multi</span><a href="#_multi" 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">#multi<span class="tsd-signature-symbol">:</span> <a href="lib_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/multi-command.ts#L84">packages/client/lib/client/multi-command.ts:84</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/multi-command.ts#L84">packages/client/lib/client/multi-command.ts:84</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_selectedDB" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>#selectedDB</span><a href="#_selectedDB" 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">#selectedDB<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/redis/node-redis/blob/c1fd867/packages/client/lib/client/multi-command.ts#L87">packages/client/lib/client/multi-command.ts:87</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/multi-command.ts#L87">packages/client/lib/client/multi-command.ts:87</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="EXEC" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>EXEC</span><a href="#EXEC" 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">EXEC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>execAsPipeline<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/lib_commands.RedisCommandRawReply.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -100,7 +100,7 @@
<h5>execAsPipeline: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/lib_commands.RedisCommandRawReply.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/multi-command.ts#L181">packages/client/lib/client/multi-command.ts:181</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/multi-command.ts#L181">packages/client/lib/client/multi-command.ts:181</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="select" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>select</span><a href="#select" 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">select<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>db<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, transformReply<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span>, reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, preserved<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="lib_client_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -137,12 +137,12 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="lib_client_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/multi-command.ts#L147">packages/client/lib/client/multi-command.ts:147</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/multi-command.ts#L147">packages/client/lib/client/multi-command.ts:147</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="v4" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>v4</span><a href="#v4" 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">v4<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/multi-command.ts#L86">packages/client/lib/client/multi-command.ts:86</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/multi-command.ts#L86">packages/client/lib/client/multi-command.ts:86</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-class"><a id="_defineLegacyCommand" class="tsd-anchor"></a>

16
documentation/client/classes/lib_client_socket.default.html
View File

@@ -111,42 +111,42 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#initiator</span><a href="#_initiator" 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">#initiator<span class="tsd-signature-symbol">:</span> <a href="../types/lib_client_socket.RedisSocketInitiator.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisSocketInitiator</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L55">packages/client/lib/client/socket.ts:55</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L55">packages/client/lib/client/socket.ts:55</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_isCorked" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Corked</span><a href="#_isCorked" 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">#is<wbr/>Corked<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L227">packages/client/lib/client/socket.ts:227</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L227">packages/client/lib/client/socket.ts:227</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_isOpen" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Open</span><a href="#_isOpen" 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">#is<wbr/>Open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L61">packages/client/lib/client/socket.ts:61</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L61">packages/client/lib/client/socket.ts:61</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_isReady" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Ready</span><a href="#_isReady" 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">#is<wbr/>Ready<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L67">packages/client/lib/client/socket.ts:67</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L67">packages/client/lib/client/socket.ts:67</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_isSocketUnrefed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Socket<wbr/>Unrefed</span><a href="#_isSocketUnrefed" 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">#is<wbr/>Socket<wbr/>Unrefed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L81">packages/client/lib/client/socket.ts:81</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L81">packages/client/lib/client/socket.ts:81</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_options" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#options</span><a href="#_options" 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">#options<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><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L57">packages/client/lib/client/socket.ts:57</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L57">packages/client/lib/client/socket.ts:57</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_socket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <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> <span class="tsd-signature-type">Socket</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">TLSSocket</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L59">packages/client/lib/client/socket.ts:59</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L59">packages/client/lib/client/socket.ts:59</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_writableNeedDrain" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#writable<wbr/>Need<wbr/>Drain</span><a href="#_writableNeedDrain" 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">#writable<wbr/>Need<wbr/>Drain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/client/socket.ts#L75">packages/client/lib/client/socket.ts:75</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/client/socket.ts#L75">packages/client/lib/client/socket.ts:75</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" 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">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="lib_client.default.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources">

6
documentation/client/classes/lib_cluster.default.html
View File

@@ -117,17 +117,17 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#<wbr/>Multi</span><a href="#_Multi" 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">#<wbr/>Multi<span class="tsd-signature-symbol">:</span> <a href="../types/lib_cluster_multi_command.InstantiableRedisClusterMultiCommandType.html" class="tsd-signature-type" data-tsd-kind="Type alias">InstantiableRedisClusterMultiCommandType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/index.ts#L74">packages/client/lib/cluster/index.ts:74</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/index.ts#L74">packages/client/lib/cluster/index.ts:74</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_options" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#options</span><a href="#_options" 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">#options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/lib_cluster.RedisClusterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClusterOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/index.ts#L72">packages/client/lib/cluster/index.ts:72</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/index.ts#L72">packages/client/lib/cluster/index.ts:72</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_slots" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#slots</span><a href="#_slots" 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">#slots<span class="tsd-signature-symbol">:</span> <a href="lib_cluster_cluster_slots.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/index.ts#L73">packages/client/lib/cluster/index.ts:73</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/index.ts#L73">packages/client/lib/cluster/index.ts:73</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" 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">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="lib_client.default.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources">

14
documentation/client/classes/lib_cluster_cluster_slots.default.html
View File

@@ -99,37 +99,37 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#<wbr/>Client</span><a href="#_Client" 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">#<wbr/>Client<span class="tsd-signature-symbol">:</span> <a href="../types/lib_client.InstantiableRedisClient.html" class="tsd-signature-type" data-tsd-kind="Type alias">InstantiableRedisClient</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/cluster-slots.ts#L48">packages/client/lib/cluster/cluster-slots.ts:48</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/cluster-slots.ts#L48">packages/client/lib/cluster/cluster-slots.ts:48</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_nodeByAddress" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#node<wbr/>By<wbr/>Address</span><a href="#_nodeByAddress" 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">#node<wbr/>By<wbr/>Address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="../interfaces/lib_cluster_cluster_slots.ClusterNode.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterNode</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/cluster-slots.ts#L50">packages/client/lib/cluster/cluster-slots.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/cluster-slots.ts#L50">packages/client/lib/cluster/cluster-slots.ts:50</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_onError" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#on<wbr/>Error</span><a href="#_onError" 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">#on<wbr/>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">OnError</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/cluster-slots.ts#L49">packages/client/lib/cluster/cluster-slots.ts:49</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/cluster-slots.ts#L49">packages/client/lib/cluster/cluster-slots.ts:49</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_options" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#options</span><a href="#_options" 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">#options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/lib_cluster.RedisClusterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClusterOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/cluster-slots.ts#L47">packages/client/lib/cluster/cluster-slots.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/cluster-slots.ts#L47">packages/client/lib/cluster/cluster-slots.ts:47</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_randomClientIterator" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>#random<wbr/>Client<wbr/>Iterator</span><a href="#_randomClientIterator" 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">#random<wbr/>Client<wbr/>Iterator<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">IterableIterator</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_cluster_cluster_slots.ClusterNode.html" class="tsd-signature-type" data-tsd-kind="Interface">ClusterNode</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/cluster-slots.ts#L223">packages/client/lib/cluster/cluster-slots.ts:223</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/cluster-slots.ts#L223">packages/client/lib/cluster/cluster-slots.ts:223</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_runningRediscoverPromise" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagOptional">Optional</code> <span>#running<wbr/>Rediscover<wbr/>Promise</span><a href="#_runningRediscoverPromise" 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">#running<wbr/>Rediscover<wbr/>Promise<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/cluster-slots.ts#L85">packages/client/lib/cluster/cluster-slots.ts:85</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/cluster-slots.ts#L85">packages/client/lib/cluster/cluster-slots.ts:85</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_slots" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#slots</span><a href="#_slots" 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">#slots<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SlotNodes</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</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/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/cluster-slots.ts#L51">packages/client/lib/cluster/cluster-slots.ts:51</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/cluster-slots.ts#L51">packages/client/lib/cluster/cluster-slots.ts:51</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-class"><a id="_clientOptionsDefaults" class="tsd-anchor"></a>

8
documentation/client/classes/lib_cluster_multi_command.default.html
View File

@@ -66,17 +66,17 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#executor</span><a href="#_executor" 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">#executor<span class="tsd-signature-symbol">:</span> <a href="../types/lib_cluster_multi_command.RedisClusterMultiExecutor.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClusterMultiExecutor</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/multi-command.ts#L66">packages/client/lib/cluster/multi-command.ts:66</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/multi-command.ts#L66">packages/client/lib/cluster/multi-command.ts:66</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_firstKey" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#first<wbr/>Key</span><a href="#_firstKey" 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">#first<wbr/>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/lib_commands.RedisCommandArgument.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArgument</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/multi-command.ts#L67">packages/client/lib/cluster/multi-command.ts:67</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/multi-command.ts#L67">packages/client/lib/cluster/multi-command.ts:67</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="_multi" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#multi</span><a href="#_multi" 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">#multi<span class="tsd-signature-symbol">:</span> <a href="lib_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/multi-command.ts#L65">packages/client/lib/cluster/multi-command.ts:65</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/multi-command.ts#L65">packages/client/lib/cluster/multi-command.ts:65</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="EXEC" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>EXEC</span><a href="#EXEC" 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">EXEC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>execAsPipeline<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/lib_commands.RedisCommandRawReply.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -95,7 +95,7 @@
<h5>execAsPipeline: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/lib_commands.RedisCommandRawReply.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/cluster/multi-command.ts#L131">packages/client/lib/cluster/multi-command.ts:131</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/cluster/multi-command.ts#L131">packages/client/lib/cluster/multi-command.ts:131</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-class"><a id="addCommand" class="tsd-anchor"></a>

4
documentation/client/classes/lib_errors.ReconnectStrategyError.html
View File

@@ -78,12 +78,12 @@
<h3 class="tsd-anchor-link"><span>original<wbr/>Error</span><a href="#originalError" 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">original<wbr/>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/errors.ts#L44">packages/client/lib/errors.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/errors.ts#L44">packages/client/lib/errors.ts:44</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="socketError" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>socket<wbr/>Error</span><a href="#socketError" 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<wbr/>Error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/errors.ts#L45">packages/client/lib/errors.ts:45</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/errors.ts#L45">packages/client/lib/errors.ts:45</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="stack" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>stack</span><a href="#stack" 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">stack<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">

4
documentation/client/classes/lib_multi_command.default.html
View File

@@ -57,12 +57,12 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>queue</span><a href="#queue" 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">queue<span class="tsd-signature-symbol">:</span> <a href="../interfaces/lib_multi_command.RedisMultiQueuedCommand.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisMultiQueuedCommand</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/redis/node-redis/blob/c1fd867/packages/client/lib/multi-command.ts#L15">packages/client/lib/multi-command.ts:15</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/multi-command.ts#L15">packages/client/lib/multi-command.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="scriptsInUse" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>scripts<wbr/>In<wbr/>Use</span><a href="#scriptsInUse" 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<wbr/>In<wbr/>Use<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/c1fd867/packages/client/lib/multi-command.ts#L17">packages/client/lib/multi-command.ts:17</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/60ad6aa/packages/client/lib/multi-command.ts#L17">packages/client/lib/multi-command.ts:17</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-class"><a id="addCommand" class="tsd-anchor"></a>