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
2023-01-18 18:04:16 +00:00
parent c69ab7f1aa
commit 3ebc064005
2030 changed files with 3155 additions and 2704 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/client/interfaces/lib_commands.RedisFunction.html
View File

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">RedisFunction</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/e895fa1/packages/client/lib/commands/index.ts#L62">packages/client/lib/commands/index.ts:62</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/aa75ee4/packages/client/lib/commands/index.ts#L63">packages/client/lib/commands/index.ts:63</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">
@@ -34,6 +34,7 @@
<div class="tsd-index-list"><a href="lib_commands.RedisFunction.html#FIRST_KEY_INDEX" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>FIRST_<wbr/>KEY_<wbr/>INDEX?</span></a>
<a href="lib_commands.RedisFunction.html#IS_READ_ONLY" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>IS_<wbr/>READ_<wbr/>ONLY?</span></a>
<a href="lib_commands.RedisFunction.html#NUMBER_OF_KEYS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>NUMBER_<wbr/>OF_<wbr/>KEYS?</span></a>
<a href="lib_commands.RedisFunction.html#TRANSFORM_LEGACY_REPLY" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>TRANSFORM_<wbr/>LEGACY_<wbr/>REPLY?</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
@@ -47,18 +48,24 @@
<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/e895fa1/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/aa75ee4/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/e895fa1/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/aa75ee4/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/e895fa1/packages/client/lib/commands/index.ts#L63">packages/client/lib/commands/index.ts:63</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/aa75ee4/packages/client/lib/commands/index.ts#L64">packages/client/lib/commands/index.ts:64</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/aa75ee4/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>
@@ -76,7 +83,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/e895fa1/packages/client/lib/commands/index.ts#L14">packages/client/lib/commands/index.ts:14</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/aa75ee4/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">
@@ -94,7 +101,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/e895fa1/packages/client/lib/commands/index.ts#L15">packages/client/lib/commands/index.ts:15</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/aa75ee4/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">
@@ -471,6 +478,7 @@
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="lib_commands.RedisFunction.html#FIRST_KEY_INDEX" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>FIRST_<wbr/>KEY_<wbr/>INDEX?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="lib_commands.RedisFunction.html#IS_READ_ONLY" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>IS_<wbr/>READ_<wbr/>ONLY?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="lib_commands.RedisFunction.html#NUMBER_OF_KEYS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>NUMBER_<wbr/>OF_<wbr/>KEYS?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="lib_commands.RedisFunction.html#TRANSFORM_LEGACY_REPLY" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>TRANSFORM_<wbr/>LEGACY_<wbr/>REPLY?</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="lib_commands.RedisFunction.html#transformArguments" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>transform<wbr/>Arguments</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><a href="lib_commands.RedisFunction.html#transformReply" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-2048-path"></use><use href="#icon-2048-text"></use></svg>transform<wbr/>Reply?</a></li></ul></li></ul></nav></div></div>
<div class="container tsd-generator">