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

Updates

Browse Source
This commit is contained in:
documentation-bot
2023-09-19 20:22:59 +00:00
parent 26311eb750
commit 0a5fcc658b
2100 changed files with 3183 additions and 2900 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
documentation/client/classes/lib_client_multi_command.default.html
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/6848f3d/packages/client/lib/client/multi-command.ts#L67">packages/client/lib/client/multi-command.ts:67</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L67">packages/client/lib/client/multi-command.ts:67</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">
@@ -69,24 +69,24 @@
<h5><span class="tsd-kind-parameter">legacyMode</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="lib_client_multi_command.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L89">packages/client/lib/client/multi-command.ts:89</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L89">packages/client/lib/client/multi-command.ts:89</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-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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#executor</span><span class="tsd-signature-symbol">:</span> <a href="../types/lib_client_multi_command.RedisClientMultiExecutor.html" class="tsd-signature-type tsd-kind-type-alias">RedisClientMultiExecutor</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/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/4ec97be/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-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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#multi</span><span class="tsd-signature-symbol">:</span> <a href="lib_multi_command.default.html" class="tsd-signature-type 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/6848f3d/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/4ec97be/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-is-private"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">#selectedDB</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/6848f3d/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/4ec97be/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"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">EXEC</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">execAsPipeline</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><a href="../types/lib_commands.RedisCommandRawReply.html" class="tsd-signature-type 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>
@@ -104,7 +104,7 @@
<h5><span class="tsd-kind-parameter">execAsPipeline</span>: <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 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/6848f3d/packages/client/lib/client/multi-command.ts#L182">packages/client/lib/client/multi-command.ts:182</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L182">packages/client/lib/client/multi-command.ts:182</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">select</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">db</span>, <span class="tsd-kind-parameter">transformReply</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 tsd-kind-class">default</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> = ...</span></div>
@@ -139,12 +139,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 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/6848f3d/packages/client/lib/client/multi-command.ts#L151">packages/client/lib/client/multi-command.ts:151</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L151">packages/client/lib/client/multi-command.ts:151</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">v4</span><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/6848f3d/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/4ec97be/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-is-private"><a id="_defineLegacyCommand" class="tsd-anchor"></a>
@@ -163,7 +163,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">command</span>: <a href="../interfaces/lib_commands.RedisCommand.html" class="tsd-signature-type tsd-kind-interface">RedisCommand</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L126">packages/client/lib/client/multi-command.ts:126</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L126">packages/client/lib/client/multi-command.ts:126</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_legacyMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#legacy<wbr/>Mode</span><a href="#_legacyMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-private">
@@ -171,7 +171,7 @@
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L96">packages/client/lib/client/multi-command.ts:96</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L96">packages/client/lib/client/multi-command.ts:96</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="SELECT-1" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>SELECT</span><a href="#SELECT-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -201,7 +201,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_client_multi_command.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L146">packages/client/lib/client/multi-command.ts:146</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L146">packages/client/lib/client/multi-command.ts:146</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="addCommand" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Command</span><a href="#addCommand" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -231,7 +231,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_client_multi_command.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L153">packages/client/lib/client/multi-command.ts:153</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L153">packages/client/lib/client/multi-command.ts:153</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -246,7 +246,7 @@
<h5><span class="tsd-kind-parameter">args</span>: <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_client_multi_command.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L139">packages/client/lib/client/multi-command.ts:139</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L139">packages/client/lib/client/multi-command.ts:139</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -259,7 +259,7 @@
<h5><span class="tsd-kind-parameter">execAsPipeline</span>: <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 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/6848f3d/packages/client/lib/client/multi-command.ts#L168">packages/client/lib/client/multi-command.ts:168</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L168">packages/client/lib/client/multi-command.ts:168</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -267,7 +267,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 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/6848f3d/packages/client/lib/client/multi-command.ts#L184">packages/client/lib/client/multi-command.ts:184</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L184">packages/client/lib/client/multi-command.ts:184</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -284,7 +284,7 @@
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="lib_client_multi_command.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L158">packages/client/lib/client/multi-command.ts:158</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L158">packages/client/lib/client/multi-command.ts:158</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -299,7 +299,7 @@
<h5><span class="tsd-kind-parameter">args</span>: <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_client_multi_command.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/6848f3d/packages/client/lib/client/multi-command.ts#L163">packages/client/lib/client/multi-command.ts:163</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L163">packages/client/lib/client/multi-command.ts:163</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><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 viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
@@ -321,7 +321,7 @@
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">extensions</span>: <a href="../interfaces/lib_commands.RedisExtensions.html" class="tsd-signature-type tsd-kind-interface">RedisExtensions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">InstantiableRedisMultiCommand</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">F</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type 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/6848f3d/packages/client/lib/client/multi-command.ts#L68">packages/client/lib/client/multi-command.ts:68</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/4ec97be/packages/client/lib/client/multi-command.ts#L68">packages/client/lib/client/multi-command.ts:68</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">