1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-10 11:43:01 +03:00
This commit is contained in:
documentation-bot
2023-01-25 16:31:23 +00:00
parent a7c796ca18
commit bbe4ce4a3a
2065 changed files with 18112 additions and 3239 deletions

View File

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">RedisScriptConfig</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/lua-script.ts#L4">packages/client/lib/lua-script.ts:4</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/lua-script.ts#L4">packages/client/lib/lua-script.ts:4</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">
@@ -49,29 +49,29 @@
<div class="tsd-signature">FIRST_<wbr/>KEY_<wbr/>INDEX<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-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </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><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><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisCommand.html">RedisCommand</a>.<a href="lib_commands.RedisCommand.html#FIRST_KEY_INDEX">FIRST_KEY_INDEX</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/index.ts#L12">packages/client/lib/commands/index.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/index.ts#L12">packages/client/lib/commands/index.ts:12</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="IS_READ_ONLY" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>IS_<wbr/>READ_<wbr/>ONLY</span><a href="#IS_READ_ONLY" 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/>READ_<wbr/>ONLY<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisCommand.html">RedisCommand</a>.<a href="lib_commands.RedisCommand.html#IS_READ_ONLY">IS_READ_ONLY</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/index.ts#L13">packages/client/lib/commands/index.ts:13</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/index.ts#L13">packages/client/lib/commands/index.ts:13</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="NUMBER_OF_KEYS" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>NUMBER_<wbr/>OF_<wbr/>KEYS</span><a href="#NUMBER_OF_KEYS" 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">NUMBER_<wbr/>OF_<wbr/>KEYS<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/e75a5db/packages/client/lib/lua-script.ts#L6">packages/client/lib/lua-script.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/lua-script.ts#L6">packages/client/lib/lua-script.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SCRIPT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>SCRIPT</span><a href="#SCRIPT" 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">SCRIPT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/lua-script.ts#L5">packages/client/lib/lua-script.ts:5</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/lua-script.ts#L5">packages/client/lib/lua-script.ts:5</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="TRANSFORM_LEGACY_REPLY" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>TRANSFORM_<wbr/>LEGACY_<wbr/>REPLY</span><a href="#TRANSFORM_LEGACY_REPLY" 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">TRANSFORM_<wbr/>LEGACY_<wbr/>REPLY<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisCommand.html">RedisCommand</a>.<a href="lib_commands.RedisCommand.html#TRANSFORM_LEGACY_REPLY">TRANSFORM_LEGACY_REPLY</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/index.ts#L14">packages/client/lib/commands/index.ts:14</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/index.ts#L14">packages/client/lib/commands/index.ts:14</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-interface tsd-is-inherited"><a id="transformArguments" class="tsd-anchor"></a>
@@ -89,7 +89,7 @@
<h4 class="tsd-returns-title">Returns <a href="../types/lib_commands.RedisCommandArguments.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisCommand.html">RedisCommand</a>.<a href="lib_commands.RedisCommand.html#transformArguments">transformArguments</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/index.ts#L15">packages/client/lib/commands/index.ts:15</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/index.ts#L15">packages/client/lib/commands/index.ts:15</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a id="transformReply" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>transform<wbr/>Reply</span><a href="#transformReply" 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-interface tsd-is-inherited">
@@ -107,7 +107,7 @@
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisCommand.html">RedisCommand</a>.<a href="lib_commands.RedisCommand.html#transformReply">transformReply</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e75a5db/packages/client/lib/commands/index.ts#L16">packages/client/lib/commands/index.ts:16</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/3b1bad2/packages/client/lib/commands/index.ts#L16">packages/client/lib/commands/index.ts:16</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">
@@ -139,6 +139,7 @@
<li class="tsd-kind-module"><a href="../modules/lib_client_commands.html">lib/client/commands</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_commands_queue.html">lib/client/commands-<wbr/>queue</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_multi_command.html">lib/client/multi-<wbr/>command</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_pub_sub.html">lib/client/pub-<wbr/>sub</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_client_socket.html">lib/client/socket</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_cluster.html">lib/cluster</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_cluster_cluster_slots.html">lib/cluster/cluster-<wbr/>slots</a></li>
@@ -355,6 +356,7 @@
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_CHANNELS.html">lib/commands/PUBSUB_<wbr/>CHANNELS</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_NUMPAT.html">lib/commands/PUBSUB_<wbr/>NUMPAT</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_NUMSUB.html">lib/commands/PUBSUB_<wbr/>NUMSUB</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_PUBSUB_SHARDCHANNELS.html">lib/commands/PUBSUB_<wbr/>SHARDCHANNELS</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_RANDOMKEY.html">lib/commands/RANDOMKEY</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_READONLY.html">lib/commands/READONLY</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_READWRITE.html">lib/commands/READWRITE</a></li>
@@ -396,6 +398,7 @@
<li class="tsd-kind-module"><a href="../modules/lib_commands_SORT_RO.html">lib/commands/SORT_<wbr/>RO</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SORT_STORE.html">lib/commands/SORT_<wbr/>STORE</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SPOP.html">lib/commands/SPOP</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SPUBLISH.html">lib/commands/SPUBLISH</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SRANDMEMBER.html">lib/commands/SRANDMEMBER</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SRANDMEMBER_COUNT.html">lib/commands/SRANDMEMBER_<wbr/>COUNT</a></li>
<li class="tsd-kind-module"><a href="../modules/lib_commands_SREM.html">lib/commands/SREM</a></li>