1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-11 22:42:42 +03:00
This commit is contained in:
documentation-bot
2022-12-26 10:23:37 +00:00
parent 99eff69176
commit 6e93f4fb8c
2024 changed files with 2695 additions and 2695 deletions

View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">default</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L64">packages/client/lib/cluster/multi-command.ts:64</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L64">packages/client/lib/cluster/multi-command.ts:64</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -64,24 +64,24 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> firstKey: <a href="../types/lib_commands.RedisCommandArgument.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArgument</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="lib_cluster_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L85">packages/client/lib/cluster/multi-command.ts:85</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L85">packages/client/lib/cluster/multi-command.ts:85</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_executor" 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>#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/5a41d6d/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/9dccd9a/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 tsd-is-private"><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/5a41d6d/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/9dccd9a/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 tsd-is-private"><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/5a41d6d/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/9dccd9a/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>
@@ -99,7 +99,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/5a41d6d/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/9dccd9a/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>
@@ -133,7 +133,7 @@
<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_cluster_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L96">packages/client/lib/cluster/multi-command.ts:96</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L96">packages/client/lib/cluster/multi-command.ts:96</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="commandsExecutor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>commands<wbr/>Executor</span><a href="#commandsExecutor" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -148,7 +148,7 @@
<h5>args: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="lib_cluster_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L90">packages/client/lib/cluster/multi-command.ts:90</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L90">packages/client/lib/cluster/multi-command.ts:90</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="exec-1" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>exec</span><a href="#exec-1" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -161,7 +161,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><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L118">packages/client/lib/cluster/multi-command.ts:118</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L118">packages/client/lib/cluster/multi-command.ts:118</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="execAsPipeline" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>exec<wbr/>As<wbr/>Pipeline</span><a href="#execAsPipeline" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -169,7 +169,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><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><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L133">packages/client/lib/cluster/multi-command.ts:133</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L133">packages/client/lib/cluster/multi-command.ts:133</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="functionsExecutor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>functions<wbr/>Executor</span><a href="#functionsExecutor" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -186,7 +186,7 @@
<h5>name: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="lib_cluster_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L106">packages/client/lib/cluster/multi-command.ts:106</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L106">packages/client/lib/cluster/multi-command.ts:106</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="scriptsExecutor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>scripts<wbr/>Executor</span><a href="#scriptsExecutor" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -201,7 +201,7 @@
<h5>args: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="lib_cluster_multi_command.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L112">packages/client/lib/cluster/multi-command.ts:112</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L112">packages/client/lib/cluster/multi-command.ts:112</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="extend" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>extend</span><a href="#extend" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -223,7 +223,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> extensions: <a href="../interfaces/lib_commands.RedisExtensions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisExtensions</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></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <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></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/5a41d6d/packages/client/lib/cluster/multi-command.ts#L69">packages/client/lib/cluster/multi-command.ts:69</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9dccd9a/packages/client/lib/cluster/multi-command.ts#L69">packages/client/lib/cluster/multi-command.ts:69</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">