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-01-18 18:21:52 +00:00
parent 1b96b22e4e
commit c77875b676
2029 changed files with 2704 additions and 2704 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
documentation/client/interfaces/lib_client.RedisClientOptions.html
View File

@@ -32,7 +32,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">RedisClientOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/client/index.ts#L18">packages/client/lib/client/index.ts:18</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L18">packages/client/lib/client/index.ts:18</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">
@@ -62,80 +62,80 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>commands<wbr/>Queue<wbr/>Max<wbr/>Length</span><a href="#commandsQueueMaxLength" 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"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>
<div class="tsd-signature">commands<wbr/>Queue<wbr/>Max<wbr/>Length<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/a1dfa22/packages/client/lib/client/index.ts#L29">packages/client/lib/client/index.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L29">packages/client/lib/client/index.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="database" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>database</span><a href="#database" 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">database<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/a1dfa22/packages/client/lib/client/index.ts#L28">packages/client/lib/client/index.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L28">packages/client/lib/client/index.ts:28</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="disableOfflineQueue" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>disable<wbr/>Offline<wbr/>Queue</span><a href="#disableOfflineQueue" 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">disable<wbr/>Offline<wbr/>Queue<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/client/index.ts#L30">packages/client/lib/client/index.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L30">packages/client/lib/client/index.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="functions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>functions</span><a href="#functions" 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">functions<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">F</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisExtensions.html">RedisExtensions</a>.<a href="lib_commands.RedisExtensions.html#functions">functions</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/commands/index.ts#L87">packages/client/lib/commands/index.ts:87</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/commands/index.ts#L87">packages/client/lib/commands/index.ts:87</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="isolationPoolOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>isolation<wbr/>Pool<wbr/>Options</span><a href="#isolationPoolOptions" 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">isolation<wbr/>Pool<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Options</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/client/index.ts#L33">packages/client/lib/client/index.ts:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L33">packages/client/lib/client/index.ts:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="legacyMode" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>legacy<wbr/>Mode</span><a href="#legacyMode" 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">legacy<wbr/>Mode<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/client/index.ts#L32">packages/client/lib/client/index.ts:32</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L32">packages/client/lib/client/index.ts:32</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="modules" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>modules</span><a href="#modules" 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">modules<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisExtensions.html">RedisExtensions</a>.<a href="lib_commands.RedisExtensions.html#modules">modules</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/commands/index.ts#L86">packages/client/lib/commands/index.ts:86</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/commands/index.ts#L86">packages/client/lib/commands/index.ts:86</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="name" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>name</span><a href="#name" 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">name<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/a1dfa22/packages/client/lib/client/index.ts#L27">packages/client/lib/client/index.ts:27</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L27">packages/client/lib/client/index.ts:27</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="password" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>password</span><a href="#password" 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">password<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/a1dfa22/packages/client/lib/client/index.ts#L26">packages/client/lib/client/index.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L26">packages/client/lib/client/index.ts:26</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pingInterval" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>ping<wbr/>Interval</span><a href="#pingInterval" 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">ping<wbr/>Interval<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/a1dfa22/packages/client/lib/client/index.ts#L34">packages/client/lib/client/index.ts:34</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L34">packages/client/lib/client/index.ts:34</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="readonly" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>readonly</span><a href="#readonly" 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">readonly<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/client/index.ts#L31">packages/client/lib/client/index.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L31">packages/client/lib/client/index.ts:31</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="scripts" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>scripts</span><a href="#scripts" 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">scripts<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span></div><aside class="tsd-sources">
<p>Inherited from <a href="lib_commands.RedisExtensions.html">RedisExtensions</a>.<a href="lib_commands.RedisExtensions.html#scripts">scripts</a></p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/commands/index.ts#L88">packages/client/lib/commands/index.ts:88</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/commands/index.ts#L88">packages/client/lib/commands/index.ts:88</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="socket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>socket</span><a href="#socket" 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">socket<span class="tsd-signature-symbol">?:</span> <a href="../types/lib_client_socket.RedisSocketOptions.html" class="tsd-signature-type" data-tsd-kind="Type alias">RedisSocketOptions</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/a1dfa22/packages/client/lib/client/index.ts#L24">packages/client/lib/client/index.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L24">packages/client/lib/client/index.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="url" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>url</span><a href="#url" 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">url<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/a1dfa22/packages/client/lib/client/index.ts#L23">packages/client/lib/client/index.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L23">packages/client/lib/client/index.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="username" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>username</span><a href="#username" 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">username<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/a1dfa22/packages/client/lib/client/index.ts#L25">packages/client/lib/client/index.ts:25</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/2042a67/packages/client/lib/client/index.ts#L25">packages/client/lib/client/index.ts:25</a></li></ul></aside></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">