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

Updates

Browse Source
This commit is contained in:
documentation-bot
2022-08-22 22:25:54 +00:00
parent 561f8dabb6
commit 190804e653
1982 changed files with 9378 additions and 6376 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -19,7 +19,9 @@
<ul class="tsd-hierarchy">
<li><a href="lib_commands.RedisCommand.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisCommand</a>
<ul class="tsd-hierarchy">
<li><span class="target">RedisFunction</span></li></ul></li></ul></section>
<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/35be671/packages/client/lib/commands/index.ts#L62">packages/client/lib/commands/index.ts:62</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">
@@ -27,14 +29,14 @@
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<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>
<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>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="lib_commands.RedisFunction.html#transformArguments" class="tsd-index-link tsd-kind-method 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="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-2048-path"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)" id="icon-2048-text"></path></svg><span>transform<wbr/>Arguments</span></a>
<a href="lib_commands.RedisFunction.html#transformReply" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><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><span>transform<wbr/>Reply</span></a>
<a href="lib_commands.RedisFunction.html#transformReply" class="tsd-index-link tsd-kind-method tsd-parent-kind-interface tsd-is-inherited"><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><span>transform<wbr/>Reply?</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
@@ -43,25 +45,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/942de1f/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/35be671/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/942de1f/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/35be671/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/942de1f/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/35be671/packages/client/lib/commands/index.ts#L63">packages/client/lib/commands/index.ts:63</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>
<h3 class="tsd-anchor-link"><span>transform<wbr/>Arguments</span><a href="#transformArguments" 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">
<li class="tsd-signature" id="transformArguments.transformArguments-1">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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">: </span><a href="../types/lib_commands.RedisCommandArguments.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments.transformArguments-1">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>this<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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">: </span><a href="../types/lib_commands.RedisCommandArguments.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a><a href="#transformArguments.transformArguments-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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -71,12 +72,13 @@
<li>
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<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></aside></li></ul></section>
<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/35be671/packages/client/lib/commands/index.ts#L14">packages/client/lib/commands/index.ts:14</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">
<li class="tsd-signature" id="transformReply.transformReply-1">transform<wbr/>Reply<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">: </span><span class="tsd-signature-type">any</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply.transformReply-1">transform<wbr/>Reply<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">: </span><span class="tsd-signature-type">any</span><a href="#transformReply.transformReply-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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -88,7 +90,9 @@
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> preserved: <span class="tsd-signature-type">any</span></h5></li></ul></div>
<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></aside></li></ul></section></section></div>
<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/35be671/packages/client/lib/commands/index.ts#L15">packages/client/lib/commands/index.ts:15</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">
@@ -462,11 +466,11 @@
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module"><a href="lib_commands.RedisFunction.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Redis<wbr/>Function</span></a>
<ul>
<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#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-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>
<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">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
<div class="overlay"></div><script src="../assets/main.js"></script></body></html>