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

Updates

Browse Source
This commit is contained in:
documentation-bot
2023-11-20 18:50:28 +00:00
parent be903babd5
commit ad0655cea9
2106 changed files with 3052 additions and 2919 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
documentation/client/classes/lib_client_socket.default.html
View File

@@ -23,7 +23,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">default</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L48">packages/client/lib/client/socket.ts:48</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L48">packages/client/lib/client/socket.ts:48</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">
@@ -113,49 +113,49 @@
<h4 class="tsd-returns-title">Returns <a href="lib_client_socket.default.html" class="tsd-signature-type tsd-kind-class">default</a></h4><aside class="tsd-sources">
<p>Overrides EventEmitter.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L95">packages/client/lib/client/socket.ts:95</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L95">packages/client/lib/client/socket.ts:95</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="_initiator" 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>#initiator</span><a href="#_initiator" 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">#initiator</span><span class="tsd-signature-symbol">:</span> <a href="../types/lib_client_socket.RedisSocketInitiator.html" class="tsd-signature-type tsd-kind-type-alias">RedisSocketInitiator</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L67">packages/client/lib/client/socket.ts:67</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L67">packages/client/lib/client/socket.ts:67</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_isCorked" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Corked</span><a href="#_isCorked" 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">#is<wbr/>Corked</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L285">packages/client/lib/client/socket.ts:285</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L285">packages/client/lib/client/socket.ts:285</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_isOpen" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Open</span><a href="#_isOpen" 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">#is<wbr/>Open</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L73">packages/client/lib/client/socket.ts:73</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L73">packages/client/lib/client/socket.ts:73</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_isReady" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Ready</span><a href="#_isReady" 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">#is<wbr/>Ready</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L79">packages/client/lib/client/socket.ts:79</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L79">packages/client/lib/client/socket.ts:79</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_isSocketUnrefed" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Socket<wbr/>Unrefed</span><a href="#_isSocketUnrefed" 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">#is<wbr/>Socket<wbr/>Unrefed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L93">packages/client/lib/client/socket.ts:93</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L93">packages/client/lib/client/socket.ts:93</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_options" 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>#options</span><a href="#_options" 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">#options</span><span class="tsd-signature-symbol">:</span> <a href="../types/lib_client_socket.RedisSocketOptions.html" class="tsd-signature-type tsd-kind-type-alias">RedisSocketOptions</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L69">packages/client/lib/client/socket.ts:69</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L69">packages/client/lib/client/socket.ts:69</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_socket" 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>#socket</span><a href="#_socket" 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">#socket</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type ">Socket</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">TLSSocket</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L71">packages/client/lib/client/socket.ts:71</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L71">packages/client/lib/client/socket.ts:71</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_writableNeedDrain" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#writable<wbr/>Need<wbr/>Drain</span><a href="#_writableNeedDrain" 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">#writable<wbr/>Need<wbr/>Drain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L87">packages/client/lib/client/socket.ts:87</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L87">packages/client/lib/client/socket.ts:87</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" 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">capture<wbr/>Rejection<wbr/>Symbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="lib_client.default.html#captureRejectionSymbol" class="tsd-signature-type tsd-kind-property">captureRejectionSymbol</a></div>
@@ -233,7 +233,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L75">packages/client/lib/client/socket.ts:75</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L75">packages/client/lib/client/socket.ts:75</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="isReady" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>is<wbr/>Ready</span><a href="#isReady" 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">
@@ -241,7 +241,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L81">packages/client/lib/client/socket.ts:81</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L81">packages/client/lib/client/socket.ts:81</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="writableNeedDrain" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>writable<wbr/>Need<wbr/>Drain</span><a href="#writableNeedDrain" 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">
@@ -249,7 +249,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L89">packages/client/lib/client/socket.ts:89</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L89">packages/client/lib/client/socket.ts:89</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_connect" class="tsd-anchor"></a>
@@ -259,7 +259,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</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/0ee3278/packages/client/lib/client/socket.ts#L147">packages/client/lib/client/socket.ts:147</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L147">packages/client/lib/client/socket.ts:147</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_createNetSocket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#create<wbr/>Net<wbr/>Socket</span><a href="#_createNetSocket" 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">
@@ -267,7 +267,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">CreateSocketReturn</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Socket</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/0ee3278/packages/client/lib/client/socket.ts#L217">packages/client/lib/client/socket.ts:217</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L217">packages/client/lib/client/socket.ts:217</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_createSocket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#create<wbr/>Socket</span><a href="#_createSocket" 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">
@@ -275,7 +275,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Socket</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">TLSSocket</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/0ee3278/packages/client/lib/client/socket.ts#L177">packages/client/lib/client/socket.ts:177</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L177">packages/client/lib/client/socket.ts:177</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_createTlsSocket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#create<wbr/>Tls<wbr/>Socket</span><a href="#_createTlsSocket" 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">
@@ -283,7 +283,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">CreateSocketReturn</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">TLSSocket</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/0ee3278/packages/client/lib/client/socket.ts#L224">packages/client/lib/client/socket.ts:224</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L224">packages/client/lib/client/socket.ts:224</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_disconnect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#disconnect</span><a href="#_disconnect" 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">
@@ -291,7 +291,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<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/0ee3278/packages/client/lib/client/socket.ts#L263">packages/client/lib/client/socket.ts:263</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L263">packages/client/lib/client/socket.ts:263</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_onSocketError" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#on<wbr/>Socket<wbr/>Error</span><a href="#_onSocketError" 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">
@@ -304,7 +304,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></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/0ee3278/packages/client/lib/client/socket.ts#L231">packages/client/lib/client/socket.ts:231</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L231">packages/client/lib/client/socket.ts:231</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_reconnectStrategy" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#reconnect<wbr/>Strategy</span><a href="#_reconnectStrategy" 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">
@@ -319,7 +319,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h5><span class="tsd-kind-parameter">cause</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L102">packages/client/lib/client/socket.ts:102</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L102">packages/client/lib/client/socket.ts:102</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_shouldReconnect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#should<wbr/>Reconnect</span><a href="#_shouldReconnect" 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">
@@ -334,7 +334,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<h5><span class="tsd-kind-parameter">cause</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L123">packages/client/lib/client/socket.ts:123</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L123">packages/client/lib/client/socket.ts:123</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" 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-inherited tsd-is-external">
@@ -374,7 +374,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</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/0ee3278/packages/client/lib/client/socket.ts#L138">packages/client/lib/client/socket.ts:138</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L138">packages/client/lib/client/socket.ts:138</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="cork" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>cork</span><a href="#cork" 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">
@@ -382,7 +382,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<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/0ee3278/packages/client/lib/client/socket.ts#L287">packages/client/lib/client/socket.ts:287</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L287">packages/client/lib/client/socket.ts:287</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="disconnect" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>disconnect</span><a href="#disconnect" 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">
@@ -390,7 +390,7 @@ regular <code>&#39;error&#39;</code> listener is installed.</p>
<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/0ee3278/packages/client/lib/client/socket.ts#L254">packages/client/lib/client/socket.ts:254</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L254">packages/client/lib/client/socket.ts:254</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" 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-inherited tsd-is-external">
@@ -733,7 +733,7 @@ listener is removed, and then invoked.</p>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</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/0ee3278/packages/client/lib/client/socket.ts#L274">packages/client/lib/client/socket.ts:274</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L274">packages/client/lib/client/socket.ts:274</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>raw<wbr/>Listeners</span><a href="#rawListeners" 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-inherited tsd-is-external">
@@ -763,7 +763,7 @@ including any wrappers (such as those created by <code>.once()</code>).</p>
<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/0ee3278/packages/client/lib/client/socket.ts#L301">packages/client/lib/client/socket.ts:301</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L301">packages/client/lib/client/socket.ts:301</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" 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-inherited tsd-is-external">
@@ -871,7 +871,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
<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/0ee3278/packages/client/lib/client/socket.ts#L306">packages/client/lib/client/socket.ts:306</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L306">packages/client/lib/client/socket.ts:306</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="writeCommand" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>write<wbr/>Command</span><a href="#writeCommand" 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">
@@ -884,7 +884,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
<h5><span class="tsd-kind-parameter">args</span>: <a href="../types/lib_commands.RedisCommandArguments.html" class="tsd-signature-type tsd-kind-type-alias">RedisCommandArguments</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/0ee3278/packages/client/lib/client/socket.ts#L244">packages/client/lib/client/socket.ts:244</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L244">packages/client/lib/client/socket.ts:244</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_initiateOptions" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>#initiate<wbr/>Options</span><a href="#_initiateOptions" 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">
@@ -897,7 +897,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <a href="../types/lib_client_socket.RedisSocketOptions.html" class="tsd-signature-type tsd-kind-type-alias">RedisSocketOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../types/lib_client_socket.RedisSocketOptions.html" class="tsd-signature-type tsd-kind-type-alias">RedisSocketOptions</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L49">packages/client/lib/client/socket.ts:49</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L49">packages/client/lib/client/socket.ts:49</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-private"><a id="_isTlsSocket" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>#is<wbr/>Tls<wbr/>Socket</span><a href="#_isTlsSocket" 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">
@@ -910,7 +910,7 @@ modified for this specific <code>EventEmitter</code> instance. The value can be
<h5><span class="tsd-kind-parameter">options</span>: <a href="../types/lib_client_socket.RedisSocketOptions.html" class="tsd-signature-type tsd-kind-type-alias">RedisSocketOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol"> is </span><a href="../interfaces/lib_client_socket.RedisTlsSocketOptions.html" class="tsd-signature-type tsd-kind-interface">RedisTlsSocketOptions</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/0ee3278/packages/client/lib/client/socket.ts#L63">packages/client/lib/client/socket.ts:63</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/9ed9cb5/packages/client/lib/client/socket.ts#L63">packages/client/lib/client/socket.ts:63</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addAbortListener" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>add<wbr/>Abort<wbr/>Listener</span><a href="#addAbortListener" 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-inherited tsd-is-external">