redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-09 00:22:08 +03:00
Code Activity
Files
4e1a9af035ac76c81da32079c6c4b535b01f4b4b
node-redis/documentation/client/classes/lib_client.default.html
documentation-bot 4e1a9af035 Updates
2021-12-13 20:40:39 +00:00

205 lines
282 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | @node-redis/client</title><meta name="description" content="Documentation for @node-redis/client"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@node-redis/client</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@node-redis/client</a></li><li><a href="../modules/lib_client.html">lib/client</a></li><li><a href="lib_client.default.html">default</a></li></ul><h1>Class default&lt;M, S&gt;</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-type-parameters"><h3>Type parameters</h3><ul class="tsd-type-parameters"><li><h4>M<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisModules.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisModules</a></h4></li><li><h4>S<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisScripts.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisScripts</a></h4></li></ul></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">EventEmitter</span><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="lib_client.default.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_isolationPool" class="tsd-kind-icon">#isolation<wbr/>Pool</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_options" class="tsd-kind-icon">#options</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_queue" class="tsd-kind-icon">#queue</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_selectedDB" class="tsd-kind-icon">#selectedDB</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_socket" class="tsd-kind-icon">#socket</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_v4" class="tsd-kind-icon">#v4</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#pSubscribe" class="tsd-kind-icon">p<wbr/>Subscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#pUnsubscribe" class="tsd-kind-icon">p<wbr/>Unsubscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#quit" class="tsd-kind-icon">quit</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#select" class="tsd-kind-icon">select</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#subscribe" class="tsd-kind-icon">subscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</a></li></ul></section><section class="tsd-index-section "><h3>Accessors</h3><ul class="tsd-index-list"><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="lib_client.default.html#isOpen" class="tsd-kind-icon">is<wbr/>Open</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="lib_client.default.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="lib_client.default.html#v4" class="tsd-kind-icon">v4</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_defineLegacyCommand" class="tsd-kind-icon">#define<wbr/>Legacy<wbr/>Command</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_destroyIsolationPool" class="tsd-kind-icon">#destroy<wbr/>Isolation<wbr/>Pool</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_initiateOptions" class="tsd-kind-icon">#initiate<wbr/>Options</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_initiateQueue" class="tsd-kind-icon">#initiate<wbr/>Queue</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_initiateSocket" class="tsd-kind-icon">#initiate<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_legacyMode" class="tsd-kind-icon">#legacy<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="lib_client.default.html#_sendCommand" class="tsd-kind-icon">#send<wbr/>Command</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="lib_client.default.html#_subscribe" class="tsd-kind-icon">#subscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_tick" class="tsd-kind-icon">#tick</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="lib_client.default.html#_unsubscribe" class="tsd-kind-icon">#unsubscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#PSUBSCRIBE" class="tsd-kind-icon">PSUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#PUNSUBSCRIBE" class="tsd-kind-icon">PUNSUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#QUIT" class="tsd-kind-icon">QUIT</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#SELECT" class="tsd-kind-icon">SELECT</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#SUBSCRIBE" class="tsd-kind-icon">SUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#UNSUBSCRIBE" class="tsd-kind-icon">UNSUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#commandsExecutor" class="tsd-kind-icon">commands<wbr/>Executor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#disconnect" class="tsd-kind-icon">disconnect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#duplicate" class="tsd-kind-icon">duplicate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#executeIsolated" class="tsd-kind-icon">execute<wbr/>Isolated</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#executeScript" class="tsd-kind-icon">execute<wbr/>Script</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#hScanIterator" class="tsd-kind-icon">h<wbr/>Scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#multi" class="tsd-kind-icon">multi</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#multiExecutor" class="tsd-kind-icon">multi<wbr/>Executor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#sScanIterator" class="tsd-kind-icon">s<wbr/>Scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#scanIterator" class="tsd-kind-icon">scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#scriptsExecutor" class="tsd-kind-icon">scripts<wbr/>Executor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#sendCommand" class="tsd-kind-icon">send<wbr/>Command</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#zScanIterator" class="tsd-kind-icon">z<wbr/>Scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="lib_client.default.html#commandOptions" class="tsd-kind-icon">command<wbr/>Options</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="lib_client.default.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="lib_client.default.html#extend" class="tsd-kind-icon">extend</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#getEventListeners" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#on-1" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#once-1" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="lib_client.default.html#parseURL" class="tsd-kind-icon">parseURL</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides EventEmitter.constructor</p><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L148">packages/client/lib/client/index.ts:148</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>M<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisModules.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisModules</a></h4></li><li><h4>S<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisScripts.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisScripts</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_isolationPool" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> #isolation<wbr/>Pool</h3><div class="tsd-signature tsd-kind-icon">#isolation<wbr/>Pool<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Pool</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L128">packages/client/lib/client/index.ts:128</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_options" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> #options</h3><div class="tsd-signature tsd-kind-icon">#options<span class="tsd-signature-symbol">?:</span> <a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L125">packages/client/lib/client/index.ts:125</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_queue" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> #queue</h3><div class="tsd-signature tsd-kind-icon">#queue<span class="tsd-signature-symbol">:</span> <a href="lib_client_commands_queue.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L127">packages/client/lib/client/index.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_selectedDB" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #selectedDB</h3><div class="tsd-signature tsd-kind-icon">#selectedDB<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L130">packages/client/lib/client/index.ts:130</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_socket" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> #socket</h3><div class="tsd-signature tsd-kind-icon">#socket<span class="tsd-signature-symbol">:</span> <a href="lib_client_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L126">packages/client/lib/client/index.ts:126</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"><a id="_v4" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> #v4</h3><div class="tsd-signature tsd-kind-icon">#v4<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L129">packages/client/lib/client/index.ts:129</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pSubscribe" class="tsd-anchor"></a><h3>p<wbr/>Subscribe</h3><div class="tsd-signature tsd-kind-icon">p<wbr/>Subscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><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><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L447">packages/client/lib/client/index.ts:447</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>patterns: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="pUnsubscribe" class="tsd-anchor"></a><h3>p<wbr/>Unsubscribe</h3><div class="tsd-signature tsd-kind-icon">p<wbr/>Unsubscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><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><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L488">packages/client/lib/client/index.ts:488</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> patterns: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="quit" class="tsd-anchor"></a><h3>quit</h3><div class="tsd-signature tsd-kind-icon">quit<span class="tsd-signature-symbol">:</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">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L503">packages/client/lib/client/index.ts:503</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><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></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="select" class="tsd-anchor"></a><h3>select</h3><div class="tsd-signature tsd-kind-icon">select<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><span class="tsd-signature-symbol">(</span>db<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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/lib_command_options.html#CommandOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span>, db<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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L401">packages/client/lib/client/index.ts:401</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>db<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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/lib_command_options.html#CommandOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span>, db<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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>db: <span class="tsd-signature-type">number</span></h5></li></ul><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></li><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../modules/lib_command_options.html#CommandOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>db: <span class="tsd-signature-type">number</span></h5></li></ul><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></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="subscribe" class="tsd-anchor"></a><h3>subscribe</h3><div class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><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><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L432">packages/client/lib/client/index.ts:432</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>channels: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="unsubscribe" class="tsd-anchor"></a><h3>unsubscribe</h3><div class="tsd-signature tsd-kind-icon">unsubscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><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><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L473">packages/client/lib/client/index.ts:473</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> channels: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> capture<wbr/>Rejection<wbr/>Symbol</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="lib_client.default.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources"><p>Inherited from EventEmitter.captureRejectionSymbol</p><ul><li>Defined in node_modules/@types/node/events.d.ts:273</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Rejections</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from EventEmitter.captureRejections</p><ul><li>Defined in node_modules/@types/node/events.d.ts:278</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Sets or gets the default captureRejection value for all emitters.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="defaultMaxListeners" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> default<wbr/>Max<wbr/>Listeners</h3><div class="tsd-signature tsd-kind-icon">default<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from EventEmitter.defaultMaxListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:279</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="errorMonitor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error<wbr/>Monitor</h3><div class="tsd-signature tsd-kind-icon">error<wbr/>Monitor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="lib_client.default.html#errorMonitor" class="tsd-signature-type" data-tsd-kind="Property">errorMonitor</a></div><aside class="tsd-sources"><p>Inherited from EventEmitter.errorMonitor</p><ul><li>Defined in node_modules/@types/node/events.d.ts:272</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>This symbol shall be used to install a listener for only monitoring <code>&#39;error&#39;</code>
events. Listeners installed using this symbol are called before the regular
<code>&#39;error&#39;</code> listeners are called.</p>
</div><div><p>Installing a listener using this symbol does not change the behavior once an
<code>&#39;error&#39;</code> event is emitted, therefore the process will still crash if no
regular <code>&#39;error&#39;</code> listener is installed.</p>
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="isOpen" class="tsd-anchor"></a><h3>is<wbr/>Open</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> isOpen<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L136">packages/client/lib/client/index.ts:136</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="options" class="tsd-anchor"></a><h3>options</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> options<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L132">packages/client/lib/client/index.ts:132</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"><a id="v4" class="tsd-anchor"></a><h3>v4</h3><ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> v4<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L140">packages/client/lib/client/index.ts:140</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></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-class tsd-is-private"><a id="_defineLegacyCommand" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #define<wbr/>Legacy<wbr/>Command</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">#define<wbr/>Legacy<wbr/>Command<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L306">packages/client/lib/client/index.ts:306</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>name: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_destroyIsolationPool" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #destroy<wbr/>Isolation<wbr/>Pool</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">#destroy<wbr/>Isolation<wbr/>Pool<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L595">packages/client/lib/client/index.ts:595</a></li></ul></aside><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_initiateOptions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #initiate<wbr/>Options</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">#initiate<wbr/>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L166">packages/client/lib/client/index.ts:166</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_initiateQueue" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #initiate<wbr/>Queue</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">#initiate<wbr/>Queue<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client_commands_queue.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L255">packages/client/lib/client/index.ts:255</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="lib_client_commands_queue.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_initiateSocket" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #initiate<wbr/>Socket</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">#initiate<wbr/>Socket<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L183">packages/client/lib/client/index.ts:183</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="lib_client_socket.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_legacyMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #legacy<wbr/>Mode</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">#legacy<wbr/>Mode<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L259">packages/client/lib/client/index.ts:259</a></li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a id="_sendCommand" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #send<wbr/>Command</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><li class="tsd-signature tsd-kind-icon">#send<wbr/>Command<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="../modules/lib_commands.html#RedisCommandArguments" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L338">packages/client/lib/client/index.ts:338</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <a href="../modules/lib_commands.html#RedisCommandArguments" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type">boolean</span></h5></li></ul><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" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a id="_subscribe" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #subscribe</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><li class="tsd-signature tsd-kind-icon">#subscribe<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="../enums/lib_client_commands_queue.PubSubSubscribeCommands.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PubSubSubscribeCommands</a>, channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L403">packages/client/lib/client/index.ts:403</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="../enums/lib_client_commands_queue.PubSubSubscribeCommands.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PubSubSubscribeCommands</a></h5></li><li><h5>channels: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="_tick" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #tick</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"><li class="tsd-signature tsd-kind-icon">#tick<span class="tsd-signature-symbol">(</span>force<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L505">packages/client/lib/client/index.ts:505</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>force: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a id="_unsubscribe" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagPrivate">Private</span> #unsubscribe</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><li class="tsd-signature tsd-kind-icon">#unsubscribe<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="../enums/lib_client_commands_queue.PubSubUnsubscribeCommands.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PubSubUnsubscribeCommands</a>, channels<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L449">packages/client/lib/client/index.ts:449</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="../enums/lib_client_commands_queue.PubSubUnsubscribeCommands.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PubSubUnsubscribeCommands</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> channels: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="PSUBSCRIBE" class="tsd-anchor"></a><h3>PSUBSCRIBE</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">PSUBSCRIBE<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L434">packages/client/lib/client/index.ts:434</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>patterns: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="PUNSUBSCRIBE" class="tsd-anchor"></a><h3>PUNSUBSCRIBE</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">PUNSUBSCRIBE<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>patterns<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L475">packages/client/lib/client/index.ts:475</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> patterns: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="QUIT" class="tsd-anchor"></a><h3>QUIT</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">QUIT<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L490">packages/client/lib/client/index.ts:490</a></li></ul></aside><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="SELECT" class="tsd-anchor"></a><h3>SELECT</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">SELECT<span class="tsd-signature-symbol">(</span>db<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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">SELECT<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/lib_command_options.html#CommandOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span>, db<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-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L389">packages/client/lib/client/index.ts:389</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>db: <span class="tsd-signature-type">number</span></h5></li></ul><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></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L390">packages/client/lib/client/index.ts:390</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../modules/lib_command_options.html#CommandOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5>db: <span class="tsd-signature-type">number</span></h5></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="SUBSCRIBE" class="tsd-anchor"></a><h3>SUBSCRIBE</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">SUBSCRIBE<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L419">packages/client/lib/client/index.ts:419</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>channels: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="UNSUBSCRIBE" class="tsd-anchor"></a><h3>UNSUBSCRIBE</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">UNSUBSCRIBE<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>channels<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, listener<span class="tsd-signature-symbol">?: </span><a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L460">packages/client/lib/client/index.ts:460</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> = <span class="tsd-signature-type">false</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> channels: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> listener: <a href="../modules/lib_client_commands_queue.html#PubSubListener" class="tsd-signature-type" data-tsd-kind="Type alias">PubSubListener</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> ? </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> : </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li></ul><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.addListener</p><ul><li>Defined in node_modules/@types/node/events.d.ts:299</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Alias for <code>emitter.on(eventName, listener)</code>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <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">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="commandsExecutor" class="tsd-anchor"></a><h3>commands<wbr/>Executor</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">commands<wbr/>Executor<span class="tsd-signature-symbol">(</span>command<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisCommand.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisCommand</a>, args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L323">packages/client/lib/client/index.ts:323</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>command: <a href="../interfaces/lib_commands.RedisCommand.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisCommand</a></h5></li><li><h5>args: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="connect" class="tsd-anchor"></a><h3>connect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L319">packages/client/lib/client/index.ts:319</a></li></ul></aside><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="disconnect" class="tsd-anchor"></a><h3>disconnect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">disconnect<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><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></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L589">packages/client/lib/client/index.ts:589</a></li></ul></aside><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></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="duplicate" class="tsd-anchor"></a><h3>duplicate</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">duplicate<span class="tsd-signature-symbol">(</span>overrides<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L312">packages/client/lib/client/index.ts:312</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> overrides: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">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">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.emit</p><ul><li>Defined in node_modules/@types/node/events.d.ts:555</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
to each.</p>
</div><div><p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">EventEmitter</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;events&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// First listener</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">firstListener</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;Helloooo! first listener&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Second listener</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">secondListener</span><span class="hl-1">(</span><span class="hl-6">arg1</span><span class="hl-1">, </span><span class="hl-6">arg2</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">`event with parameters </span><span class="hl-0">${</span><span class="hl-6">arg1</span><span class="hl-0">}</span><span class="hl-4">, </span><span class="hl-0">${</span><span class="hl-6">arg2</span><span class="hl-0">}</span><span class="hl-4"> in second listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-5">// Third listener</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">thirdListener</span><span class="hl-1">(...</span><span class="hl-6">args</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">parameters</span><span class="hl-1"> = </span><span class="hl-6">args</span><span class="hl-1">.</span><span class="hl-3">join</span><span class="hl-1">(</span><span class="hl-4">&#39;, &#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">`event with parameters </span><span class="hl-0">${</span><span class="hl-6">parameters</span><span class="hl-0">}</span><span class="hl-4"> in third listener`</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">listeners</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">));</span><br/><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-7">1</span><span class="hl-1">, </span><span class="hl-7">2</span><span class="hl-1">, </span><span class="hl-7">3</span><span class="hl-1">, </span><span class="hl-7">4</span><span class="hl-1">, </span><span class="hl-7">5</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// [</span><br/><span class="hl-5">// [Function: firstListener],</span><br/><span class="hl-5">// [Function: secondListener],</span><br/><span class="hl-5">// [Function: thirdListener]</span><br/><span class="hl-5">// ]</span><br/><span class="hl-5">// Helloooo! first listener</span><br/><span class="hl-5">// event with parameters 1, 2 in second listener</span><br/><span class="hl-5">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a><h3>event<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">event<wbr/>Names<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.eventNames</p><ul><li>Defined in node_modules/@types/node/events.d.ts:614</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
</div><div><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">EventEmitter</span><span class="hl-1"> = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;events&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEE</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {});</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;bar&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {});</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">sym</span><span class="hl-1"> = </span><span class="hl-8">Symbol</span><span class="hl-1">(</span><span class="hl-4">&#39;symbol&#39;</span><span class="hl-1">);</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-6">sym</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {});</span><br/><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">eventNames</span><span class="hl-1">());</span><br/><span class="hl-5">// Prints: [ &#39;foo&#39;, &#39;bar&#39;, Symbol(symbol) ]</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.0.0</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="executeIsolated" class="tsd-anchor"></a><h3>execute<wbr/>Isolated</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">execute<wbr/>Isolated<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L520">packages/client/lib/client/index.ts:520</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>fn: <span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>client<span class="tsd-signature-symbol">: </span><a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>client: <a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></li></ul><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" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="executeScript" class="tsd-anchor"></a><h3>execute<wbr/>Script</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">execute<wbr/>Script<span class="tsd-signature-symbol">(</span>script<span class="tsd-signature-symbol">: </span><a href="../modules/lib_commands.html#RedisScript" class="tsd-signature-type" data-tsd-kind="Type alias">RedisScript</a>, args<span class="tsd-signature-symbol">: </span><a href="../modules/lib_commands.html#RedisCommandArguments" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L367">packages/client/lib/client/index.ts:367</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>script: <a href="../modules/lib_commands.html#RedisScript" class="tsd-signature-type" data-tsd-kind="Type alias">RedisScript</a></h5></li><li><h5>args: <a href="../modules/lib_commands.html#RedisCommandArguments" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a><h3>get<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.getMaxListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:471</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the current max listener value for the <code>EventEmitter</code> which is either
set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="lib_client.default.html#defaultMaxListeners">defaultMaxListeners</a>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v1.0.0</p>
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="hScanIterator" class="tsd-anchor"></a><h3>h<wbr/>Scan<wbr/>Iterator</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">h<wbr/>Scan<wbr/>Iterator<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_commands_generic_transformers.ScanOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_commands_HSCAN.HScanTuple.html" class="tsd-signature-type" data-tsd-kind="Interface">HScanTuple</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L556">packages/client/lib/client/index.ts:556</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_commands_generic_transformers.ScanOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_commands_HSCAN.HScanTuple.html" class="tsd-signature-type" data-tsd-kind="Interface">HScanTuple</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a><h3>listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.listenerCount</p><ul><li>Defined in node_modules/@types/node/events.d.ts:561</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns the number of listeners listening to the event named <code>eventName</code>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v3.2.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event being listened for</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a><h3>listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.listeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:484</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
</div><div><pre><code class="language-js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;someone connected!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">util</span><span class="hl-1">.</span><span class="hl-3">inspect</span><span class="hl-1">(</span><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">listeners</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">)));</span><br/><span class="hl-5">// Prints: [ [Function] ]</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="multi" class="tsd-anchor"></a><h3>multi</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">multi<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/lib_client_multi_command.html#RedisClientMultiCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientMultiCommandType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L524">packages/client/lib/client/index.ts:524</a></li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../modules/lib_client_multi_command.html#RedisClientMultiCommandType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientMultiCommandType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="multiExecutor" class="tsd-anchor"></a><h3>multi<wbr/>Executor</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">multi<wbr/>Executor<span class="tsd-signature-symbol">(</span>commands<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_multi_command.RedisMultiQueuedCommand.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisMultiQueuedCommand</a><span class="tsd-signature-symbol">[]</span>, chainId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L531">packages/client/lib/client/index.ts:531</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>commands: <a href="../interfaces/lib_multi_command.RedisMultiQueuedCommand.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisMultiQueuedCommand</a><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> chainId: <span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.off</p><ul><li>Defined in node_modules/@types/node/events.d.ts:444</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Alias for <code>emitter.removeListener()</code>.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v10.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <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">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.on</p><ul><li>Defined in node_modules/@types/node/events.d.ts:330</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds the <code>listener</code> function to the end of the listeners array for the
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
times.</p>
</div><div><pre><code class="language-js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;someone connected!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependListener()</code> method can be used as an alternative to add the
event listener to the beginning of the listeners array.</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEE</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;a&#39;</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">prependListener</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;b&#39;</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.101</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event.</p>
</div></div></li><li><h5>listener: <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">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a><h3>once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.once</p><ul><li>Defined in node_modules/@types/node/events.d.ts:359</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
</div><div><pre><code class="language-js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;Ah, we have our first user!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
event listener to the beginning of the listeners array.</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEE</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;a&#39;</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">prependOnceListener</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;b&#39;</span><span class="hl-1">));</span><br/><span class="hl-6">myEE</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.3.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event.</p>
</div></div></li><li><h5>listener: <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">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prependListener" class="tsd-anchor"></a><h3>prepend<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.prependListener</p><ul><li>Defined in node_modules/@types/node/events.d.ts:579</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
times.</p>
</div><div><pre><code class="language-js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">prependListener</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;someone connected!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event.</p>
</div></div></li><li><h5>listener: <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">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="prependOnceListener" class="tsd-anchor"></a><h3>prepend<wbr/>Once<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.prependOnceListener</p><ul><li>Defined in node_modules/@types/node/events.d.ts:595</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the_beginning_ of the listeners array. The next time <code>eventName</code> is triggered, this
listener is removed, and then invoked.</p>
</div><div><pre><code class="language-js"><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">prependOnceListener</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">, (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;Ah, we have our first user!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code></pre>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.0.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event.</p>
</div></div></li><li><h5>listener: <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">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The callback function</p>
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a><h3>raw<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">raw<wbr/>Listeners<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.rawListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:514</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
including any wrappers (such as those created by <code>.once()</code>).</p>
</div><div><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">emitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">&#39;log&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;log once&#39;</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-5">// `listener` which contains the original listener bound above</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">listeners</span><span class="hl-1"> = </span><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-3">rawListeners</span><span class="hl-1">(</span><span class="hl-4">&#39;log&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">logFnWrapper</span><span class="hl-1"> = </span><span class="hl-6">listeners</span><span class="hl-1">[</span><span class="hl-7">0</span><span class="hl-1">];</span><br/><br/><span class="hl-5">// Logs &quot;log once&quot; to the console and does not unbind the `once` event</span><br/><span class="hl-6">logFnWrapper</span><span class="hl-1">.</span><span class="hl-3">listener</span><span class="hl-1">();</span><br/><br/><span class="hl-5">// Logs &quot;log once&quot; to the console and removes the listener</span><br/><span class="hl-3">logFnWrapper</span><span class="hl-1">();</span><br/><br/><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;log&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;log persistently&#39;</span><span class="hl-1">));</span><br/><span class="hl-5">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">newListeners</span><span class="hl-1"> = </span><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-3">rawListeners</span><span class="hl-1">(</span><span class="hl-4">&#39;log&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// Logs &quot;log persistently&quot; twice</span><br/><span class="hl-6">newListeners</span><span class="hl-1">[</span><span class="hl-7">0</span><span class="hl-1">]();</span><br/><span class="hl-6">emitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;log&#39;</span><span class="hl-1">);</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v9.4.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a><h3>remove<wbr/>All<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">remove<wbr/>All<wbr/>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.removeAllListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:455</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
</div><div><p>It is bad practice to remove listeners added elsewhere in the code,
particularly when the <code>EventEmitter</code> instance was created by some other
component or module (e.g. sockets or file streams).</p>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a><h3>remove<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<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">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.removeListener</p><ul><li>Defined in node_modules/@types/node/events.d.ts:439</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
</div><div><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callback</span><span class="hl-1"> = (</span><span class="hl-6">stream</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;someone connected!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">, </span><span class="hl-6">callback</span><span class="hl-1">);</span><br/><span class="hl-5">// ...</span><br/><span class="hl-6">server</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-4">&#39;connection&#39;</span><span class="hl-1">, </span><span class="hl-6">callback</span><span class="hl-1">);</span>
</code></pre>
<p><code>removeListener()</code> will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified <code>eventName</code>, then <code>removeListener()</code> must be
called multiple times to remove each instance.</p>
<p>Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and_before_ the last listener finishes execution will
not remove them from<code>emit()</code> in progress. Subsequent events behave as expected.</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">MyEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callbackA</span><span class="hl-1"> = () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;A&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-6">callbackB</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">callbackB</span><span class="hl-1"> = () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;B&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">};</span><br/><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-6">callbackA</span><span class="hl-1">);</span><br/><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, </span><span class="hl-6">callbackB</span><span class="hl-1">);</span><br/><br/><span class="hl-5">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-5">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span><br/><span class="hl-5">// B</span><br/><br/><span class="hl-5">// callbackB is now removed.</span><br/><span class="hl-5">// Internal listener array [callbackA]</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span>
</code></pre>
<p>Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered <em>after</em> the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the <code>emitter.listeners()</code> method will need to be recreated.</p>
<p>When a single function has been added as a handler multiple times for a single
event (as in the example below), <code>removeListener()</code> will remove the most
recently added instance. In the example the <code>once(&#39;ping&#39;)</code>listener is removed:</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">pong</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;pong&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;ping&#39;</span><span class="hl-1">, </span><span class="hl-6">pong</span><span class="hl-1">);</span><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-4">&#39;ping&#39;</span><span class="hl-1">, </span><span class="hl-6">pong</span><span class="hl-1">);</span><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">removeListener</span><span class="hl-1">(</span><span class="hl-4">&#39;ping&#39;</span><span class="hl-1">, </span><span class="hl-6">pong</span><span class="hl-1">);</span><br/><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;ping&#39;</span><span class="hl-1">);</span><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;ping&#39;</span><span class="hl-1">);</span>
</code></pre>
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <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">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><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">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="sScanIterator" class="tsd-anchor"></a><h3>s<wbr/>Scan<wbr/>Iterator</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">s<wbr/>Scan<wbr/>Iterator<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_commands_generic_transformers.ScanOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L567">packages/client/lib/client/index.ts:567</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_commands_generic_transformers.ScanOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="scanIterator" class="tsd-anchor"></a><h3>scan<wbr/>Iterator</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">scan<wbr/>Iterator<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_commands_SCAN.ScanCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanCommandOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L545">packages/client/lib/client/index.ts:545</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_commands_SCAN.ScanCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanCommandOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="scriptsExecutor" class="tsd-anchor"></a><h3>scripts<wbr/>Executor</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">scripts<wbr/>Executor<span class="tsd-signature-symbol">(</span>script<span class="tsd-signature-symbol">: </span><a href="../modules/lib_commands.html#RedisScript" class="tsd-signature-type" data-tsd-kind="Type alias">RedisScript</a>, args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L357">packages/client/lib/client/index.ts:357</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>script: <a href="../modules/lib_commands.html#RedisScript" class="tsd-signature-type" data-tsd-kind="Type alias">RedisScript</a></h5></li><li><h5>args: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a id="sendCommand" class="tsd-anchor"></a><h3>send<wbr/>Command</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">send<wbr/>Command<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><a href="../modules/lib_commands.html#RedisCommandArguments" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a>, bufferMode<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L333">packages/client/lib/client/index.ts:333</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T = <a href="../modules/lib_commands.html#RedisCommandRawReply" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandRawReply</a></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <a href="../modules/lib_commands.html#RedisCommandArguments" class="tsd-signature-type" data-tsd-kind="Type alias">RedisCommandArguments</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> bufferMode: <span class="tsd-signature-type">boolean</span></h5></li></ul><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" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a><h3>set<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span>n<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><a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.setMaxListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:465</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>By default <code>EventEmitter</code>s will print a warning if more than <code>10</code> listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
modified for this specific <code>EventEmitter</code> instance. The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
</div><div><p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.3.5</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="lib_client.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="zScanIterator" class="tsd-anchor"></a><h3>z<wbr/>Scan<wbr/>Iterator</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">z<wbr/>Scan<wbr/>Iterator<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_commands_generic_transformers.ScanOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_commands_generic_transformers.ZMember.html" class="tsd-signature-type" data-tsd-kind="Interface">ZMember</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L578">packages/client/lib/client/index.ts:578</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>key: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_commands_generic_transformers.ScanOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ScanOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_commands_generic_transformers.ZMember.html" class="tsd-signature-type" data-tsd-kind="Interface">ZMember</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="commandOptions" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> command<wbr/>Options</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">command<wbr/>Options<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/lib_command_options.html#CommandOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L62">packages/client/lib/client/index.ts:62</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/lib_command_options.html#CommandOptions" class="tsd-signature-type" data-tsd-kind="Type alias">CommandOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/lib_client.ClientCommandOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ClientCommandOptions</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a id="create" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L82">packages/client/lib/client/index.ts:82</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>M<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisModules.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisModules</a> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span></h4></li><li><h4>S<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisScripts.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisScripts</a> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/lib_client.html#RedisClientType" class="tsd-signature-type" data-tsd-kind="Type alias">RedisClientType</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a id="extend" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> extend</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><li class="tsd-signature tsd-kind-icon">extend<span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span>plugins<span class="tsd-signature-symbol">?: </span><a href="../interfaces/lib_commands.RedisPlugins.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisPlugins</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/lib_client.html#InstantiableRedisClient" class="tsd-signature-type" data-tsd-kind="Type alias">InstantiableRedisClient</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L66">packages/client/lib/client/index.ts:66</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>M<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisModules.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisModules</a> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span></h4></li><li><h4>S<span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_commands.RedisScripts.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisScripts</a> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> plugins: <a href="../interfaces/lib_commands.RedisPlugins.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisPlugins</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/lib_client.html#InstantiableRedisClient" class="tsd-signature-type" data-tsd-kind="Type alias">InstantiableRedisClient</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">M</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">S</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Event<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Event<wbr/>Listeners<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DOMEventTarget</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.getEventListeners</p><ul><li>Defined in node_modules/@types/node/events.d.ts:262</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
</div><div><p>For <code>EventEmitter</code>s this behaves exactly the same as calling <code>.listeners</code> on
the emitter.</p>
<p>For <code>EventTarget</code>s this is the only way to get the event listeners for the
event target. This is useful for debugging and diagnostic purposes.</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">getEventListeners</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;events&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">listener</span><span class="hl-1"> = () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;Events are fun&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, </span><span class="hl-6">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">getEventListeners</span><span class="hl-1">(</span><span class="hl-6">ee</span><span class="hl-1">, </span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-1">}</span><br/><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">et</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventTarget</span><span class="hl-1">();</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-3">listener</span><span class="hl-1"> = () </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;Events are fun&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">et</span><span class="hl-1">.</span><span class="hl-3">addEventListener</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, </span><span class="hl-6">listener</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-3">getEventListeners</span><span class="hl-1">(</span><span class="hl-6">et</span><span class="hl-1">, </span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-1">}</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v15.2.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">EventEmitter</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DOMEventTarget</span></h5></li><li><h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="listenerCount-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.listenerCount</p><ul><li>Defined in node_modules/@types/node/events.d.ts:234</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
</div><div><pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">listenerCount</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;events&#39;</span><span class="hl-1">);</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">myEmitter</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {});</span><br/><span class="hl-6">myEmitter</span><span class="hl-1">.</span><span class="hl-3">on</span><span class="hl-1">(</span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">, () </span><span class="hl-0">=&gt;</span><span class="hl-1"> {});</span><br/><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-3">listenerCount</span><span class="hl-1">(</span><span class="hl-6">myEmitter</span><span class="hl-1">, </span><span class="hl-4">&#39;event&#39;</span><span class="hl-1">));</span><br/><span class="hl-5">// Prints: 2</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.12</p>
</dd><dt>deprecated</dt><dd><p>Since v3.2.0 - Use <code>listenerCount</code> instead.</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The emitter to query</p>
</div></div></li><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The event name</p>
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="on-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EventEmitter</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.on</p><ul><li>Defined in node_modules/@types/node/events.d.ts:217</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>```js
const { on, EventEmitter } = require(&#39;events&#39;);</p>
</div><div><p>(async () =&gt; {
const ee = new EventEmitter();</p>
<p> // Emit later on
process.nextTick(() =&gt; {
ee.emit(&#39;foo&#39;, &#39;bar&#39;);
ee.emit(&#39;foo&#39;, 42);
});</p>
<p> for await (const event of on(ee, &#39;foo&#39;)) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints [&#39;bar&#39;] [42]
}
// Unreachable here
})();</p>
<pre><code><br/><span class="hl-6">Returns</span><span class="hl-1"> </span><span class="hl-6">an</span><span class="hl-1"> </span><span class="hl-4">`AsyncIterator`</span><span class="hl-1"> </span><span class="hl-6">that</span><span class="hl-1"> </span><span class="hl-6">iterates</span><span class="hl-1"> </span><span class="hl-4">`eventName`</span><span class="hl-1"> </span><span class="hl-6">events</span><span class="hl-1">. </span><span class="hl-6">It</span><span class="hl-1"> </span><span class="hl-6">will</span><span class="hl-1"> </span><span class="hl-9">throw</span><br/><span class="hl-9">if</span><span class="hl-1"> </span><span class="hl-6">the</span><span class="hl-1"> </span><span class="hl-4">`EventEmitter`</span><span class="hl-1"> </span><span class="hl-6">emits</span><span class="hl-1"> </span><span class="hl-4">`&#39;error&#39;`</span><span class="hl-1">. </span><span class="hl-6">It</span><span class="hl-1"> </span><span class="hl-6">removes</span><span class="hl-1"> </span><span class="hl-6">all</span><span class="hl-1"> </span><span class="hl-6">listeners</span><span class="hl-1"> </span><span class="hl-6">when</span><br/><span class="hl-6">exiting</span><span class="hl-1"> </span><span class="hl-6">the</span><span class="hl-1"> </span><span class="hl-6">loop</span><span class="hl-1">. </span><span class="hl-6">The</span><span class="hl-1"> </span><span class="hl-4">`value`</span><span class="hl-1"> </span><span class="hl-6">returned</span><span class="hl-1"> </span><span class="hl-6">by</span><span class="hl-1"> </span><span class="hl-6">each</span><span class="hl-1"> </span><span class="hl-6">iteration</span><span class="hl-1"> </span><span class="hl-6">is</span><span class="hl-1"> </span><span class="hl-6">an</span><span class="hl-1"> </span><span class="hl-6">array</span><br/><span class="hl-6">composed</span><span class="hl-1"> </span><span class="hl-0">of</span><span class="hl-1"> </span><span class="hl-6">the</span><span class="hl-1"> </span><span class="hl-6">emitted</span><span class="hl-1"> </span><span class="hl-6">event</span><span class="hl-1"> </span><span class="hl-0">arguments</span><span class="hl-1">.</span><br/><br/><span class="hl-6">An</span><span class="hl-1"> </span><span class="hl-4">`AbortSignal`</span><span class="hl-1"> </span><span class="hl-6">can</span><span class="hl-1"> </span><span class="hl-6">be</span><span class="hl-1"> </span><span class="hl-6">used</span><span class="hl-1"> </span><span class="hl-6">to</span><span class="hl-1"> </span><span class="hl-6">cancel</span><span class="hl-1"> </span><span class="hl-6">waiting</span><span class="hl-1"> </span><span class="hl-6">on</span><span class="hl-1"> </span><span class="hl-10">events</span><span class="hl-1">:</span><br/><br/><span class="hl-4">```js</span><br/><span class="hl-4">const { on, EventEmitter } = require(&#39;events&#39;);</span><br/><span class="hl-4">const ac = new AbortController();</span><br/><br/><span class="hl-4">(async () =&gt; {</span><br/><span class="hl-4"> const ee = new EventEmitter();</span><br/><br/><span class="hl-4"> // Emit later on</span><br/><span class="hl-4"> process.nextTick(() =&gt; {</span><br/><span class="hl-4"> ee.emit(&#39;foo&#39;, &#39;bar&#39;);</span><br/><span class="hl-4"> ee.emit(&#39;foo&#39;, 42);</span><br/><span class="hl-4"> });</span><br/><br/><span class="hl-4"> for await (const event of on(ee, &#39;foo&#39;, { signal: ac.signal })) {</span><br/><span class="hl-4"> // The execution of this inner block is synchronous and it</span><br/><span class="hl-4"> // processes one event at a time (even with await). Do not use</span><br/><span class="hl-4"> // if concurrent execution is required.</span><br/><span class="hl-4"> console.log(event); // prints [&#39;bar&#39;] [42]</span><br/><span class="hl-4"> }</span><br/><span class="hl-4"> // Unreachable here</span><br/><span class="hl-4">})();</span><br/><br/><span class="hl-4">process.nextTick(() =&gt; ac.abort());</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v13.6.0, v12.16.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">EventEmitter</span></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
<p>The name of the event being listened for</p>
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AsyncIterableIterator</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4><div><p>that iterates <code>eventName</code> events emitted by the <code>emitter</code></p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="once-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">NodeEventTarget</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DOMEventTarget</span>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">StaticEventEmitterOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.once</p><ul><li>Defined in node_modules/@types/node/events.d.ts:157</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Creates a <code>Promise</code> that is fulfilled when the <code>EventEmitter</code> emits the given
event or that is rejected if the <code>EventEmitter</code> emits <code>&#39;error&#39;</code> while waiting.
The <code>Promise</code> will resolve with an array of all the arguments emitted to the
given event.</p>
</div><div><p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>&#39;error&#39;</code> event
semantics and does not listen to the <code>&#39;error&#39;</code> event.</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">once</span><span class="hl-1">, </span><span class="hl-2">EventEmitter</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;events&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">run</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-1"> </span><span class="hl-6">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;myevent&#39;</span><span class="hl-1">, </span><span class="hl-7">42</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> [</span><span class="hl-2">value</span><span class="hl-1">] = </span><span class="hl-9">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-6">ee</span><span class="hl-1">, </span><span class="hl-4">&#39;myevent&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-6">value</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">err</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">(</span><span class="hl-4">&#39;kaboom&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> </span><span class="hl-6">process</span><span class="hl-1">.</span><span class="hl-3">nextTick</span><span class="hl-1">(() </span><span class="hl-0">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;error&#39;</span><span class="hl-1">, </span><span class="hl-6">err</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-9">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-6">ee</span><span class="hl-1">, </span><span class="hl-4">&#39;myevent&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-9">catch</span><span class="hl-1"> (</span><span class="hl-6">err</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;error happened&#39;</span><span class="hl-1">, </span><span class="hl-6">err</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">run</span><span class="hl-1">();</span>
</code></pre>
<p>The special handling of the <code>&#39;error&#39;</code> event is only used when <code>events.once()</code>is used to wait for another event. If <code>events.once()</code> is used to wait for the
&#39;<code>error&#39;</code> event itself, then it is treated as any other kind of event without
special handling:</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">once</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;events&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><br/><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-6">ee</span><span class="hl-1">, </span><span class="hl-4">&#39;error&#39;</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-3">then</span><span class="hl-1">(([</span><span class="hl-6">err</span><span class="hl-1">]) </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;ok&#39;</span><span class="hl-1">, </span><span class="hl-6">err</span><span class="hl-1">.</span><span class="hl-6">message</span><span class="hl-1">))</span><br/><span class="hl-1"> .</span><span class="hl-3">catch</span><span class="hl-1">((</span><span class="hl-6">err</span><span class="hl-1">) </span><span class="hl-0">=&gt;</span><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;error&#39;</span><span class="hl-1">, </span><span class="hl-6">err</span><span class="hl-1">.</span><span class="hl-6">message</span><span class="hl-1">));</span><br/><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;error&#39;</span><span class="hl-1">, </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-8">Error</span><span class="hl-1">(</span><span class="hl-4">&#39;boom&#39;</span><span class="hl-1">));</span><br/><br/><span class="hl-5">// Prints: ok boom</span>
</code></pre>
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
<pre><code class="language-js"><span class="hl-0">const</span><span class="hl-1"> { </span><span class="hl-2">EventEmitter</span><span class="hl-1">, </span><span class="hl-2">once</span><span class="hl-1"> } = </span><span class="hl-3">require</span><span class="hl-1">(</span><span class="hl-4">&#39;events&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ee</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">EventEmitter</span><span class="hl-1">();</span><br/><span class="hl-0">const</span><span class="hl-1"> </span><span class="hl-2">ac</span><span class="hl-1"> = </span><span class="hl-0">new</span><span class="hl-1"> </span><span class="hl-3">AbortController</span><span class="hl-1">();</span><br/><br/><span class="hl-0">async</span><span class="hl-1"> </span><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">foo</span><span class="hl-1">(</span><span class="hl-6">emitter</span><span class="hl-1">, </span><span class="hl-6">event</span><span class="hl-1">, </span><span class="hl-6">signal</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-9">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">await</span><span class="hl-1"> </span><span class="hl-3">once</span><span class="hl-1">(</span><span class="hl-6">emitter</span><span class="hl-1">, </span><span class="hl-6">event</span><span class="hl-1">, { </span><span class="hl-6">signal</span><span class="hl-1"> });</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">log</span><span class="hl-1">(</span><span class="hl-4">&#39;event emitted!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-9">catch</span><span class="hl-1"> (</span><span class="hl-6">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-9">if</span><span class="hl-1"> (</span><span class="hl-6">error</span><span class="hl-1">.</span><span class="hl-6">name</span><span class="hl-1"> === </span><span class="hl-4">&#39;AbortError&#39;</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">(</span><span class="hl-4">&#39;Waiting for the event was canceled!&#39;</span><span class="hl-1">);</span><br/><span class="hl-1"> } </span><span class="hl-9">else</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">console</span><span class="hl-1">.</span><span class="hl-3">error</span><span class="hl-1">(</span><span class="hl-4">&#39;There was an error&#39;</span><span class="hl-1">, </span><span class="hl-6">error</span><span class="hl-1">.</span><span class="hl-6">message</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">foo</span><span class="hl-1">(</span><span class="hl-6">ee</span><span class="hl-1">, </span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">, </span><span class="hl-6">ac</span><span class="hl-1">.</span><span class="hl-6">signal</span><span class="hl-1">);</span><br/><span class="hl-6">ac</span><span class="hl-1">.</span><span class="hl-3">abort</span><span class="hl-1">(); </span><span class="hl-5">// Abort waiting for the event</span><br/><span class="hl-6">ee</span><span class="hl-1">.</span><span class="hl-3">emit</span><span class="hl-1">(</span><span class="hl-4">&#39;foo&#39;</span><span class="hl-1">); </span><span class="hl-5">// Prints: Waiting for the event was canceled!</span>
</code></pre>
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v11.13.0, v10.16.0</p>
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">NodeEventTarget</span></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><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">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from EventEmitter.once</p><ul><li>Defined in node_modules/@types/node/events.d.ts:158</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <span class="tsd-signature-type">DOMEventTarget</span></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-type">StaticEventEmitterOptions</span></h5></li></ul><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">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="parseURL" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> parseURL</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">parseURL<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/32bdec2/packages/client/lib/client/index.ts#L86">packages/client/lib/client/index.ts:86</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>url: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/lib_client.RedisClientOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">RedisClientOptions</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li><li class="current tsd-kind-module"><a href="../modules/lib_client.html">lib/client</a></li><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_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><li class=" tsd-kind-module"><a href="../modules/lib_cluster_commands.html">lib/cluster/commands</a></li><li class=" tsd-kind-module"><a href="../modules/lib_cluster_multi_command.html">lib/cluster/multi-<wbr/>command</a></li><li class=" tsd-kind-module"><a href="../modules/lib_command_options.html">lib/command-<wbr/>options</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commander.html">lib/commander</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands.html">lib/commands</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_CAT.html">lib/commands/ACL_<wbr/>CAT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_DELUSER.html">lib/commands/ACL_<wbr/>DELUSER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_GENPASS.html">lib/commands/ACL_<wbr/>GENPASS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_GETUSER.html">lib/commands/ACL_<wbr/>GETUSER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_LIST.html">lib/commands/ACL_<wbr/>LIST</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_LOAD.html">lib/commands/ACL_<wbr/>LOAD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_LOG.html">lib/commands/ACL_<wbr/>LOG</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_LOG_RESET.html">lib/commands/ACL_<wbr/>LOG_<wbr/>RESET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_SAVE.html">lib/commands/ACL_<wbr/>SAVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_SETUSER.html">lib/commands/ACL_<wbr/>SETUSER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_USERS.html">lib/commands/ACL_<wbr/>USERS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ACL_WHOAMI.html">lib/commands/ACL_<wbr/>WHOAMI</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_APPEND.html">lib/commands/APPEND</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ASKING.html">lib/commands/ASKING</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_AUTH.html">lib/commands/AUTH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BGREWRITEAOF.html">lib/commands/BGREWRITEAOF</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BGSAVE.html">lib/commands/BGSAVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BITCOUNT.html">lib/commands/BITCOUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BITFIELD.html">lib/commands/BITFIELD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BITOP.html">lib/commands/BITOP</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BITPOS.html">lib/commands/BITPOS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BLMOVE.html">lib/commands/BLMOVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BLPOP.html">lib/commands/BLPOP</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BRPOP.html">lib/commands/BRPOP</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BRPOPLPUSH.html">lib/commands/BRPOPLPUSH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BZPOPMAX.html">lib/commands/BZPOPMAX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_BZPOPMIN.html">lib/commands/BZPOPMIN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLIENT_CACHING.html">lib/commands/CLIENT_<wbr/>CACHING</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLIENT_GETNAME.html">lib/commands/CLIENT_<wbr/>GETNAME</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLIENT_GETREDIR.html">lib/commands/CLIENT_<wbr/>GETREDIR</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLIENT_ID.html">lib/commands/CLIENT_<wbr/>ID</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLIENT_INFO.html">lib/commands/CLIENT_<wbr/>INFO</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLIENT_KILL.html">lib/commands/CLIENT_<wbr/>KILL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLIENT_SETNAME.html">lib/commands/CLIENT_<wbr/>SETNAME</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_ADDSLOTS.html">lib/commands/CLUSTER_<wbr/>ADDSLOTS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_FLUSHSLOTS.html">lib/commands/CLUSTER_<wbr/>FLUSHSLOTS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_GETKEYSINSLOT.html">lib/commands/CLUSTER_<wbr/>GETKEYSINSLOT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_INFO.html">lib/commands/CLUSTER_<wbr/>INFO</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_MEET.html">lib/commands/CLUSTER_<wbr/>MEET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_NODES.html">lib/commands/CLUSTER_<wbr/>NODES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_RESET.html">lib/commands/CLUSTER_<wbr/>RESET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_SETSLOT.html">lib/commands/CLUSTER_<wbr/>SETSLOT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CLUSTER_SLOTS.html">lib/commands/CLUSTER_<wbr/>SLOTS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_COMMAND.html">lib/commands/COMMAND</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_COMMAND_COUNT.html">lib/commands/COMMAND_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_COMMAND_GETKEYS.html">lib/commands/COMMAND_<wbr/>GETKEYS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_COMMAND_INFO.html">lib/commands/COMMAND_<wbr/>INFO</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CONFIG_GET.html">lib/commands/CONFIG_<wbr/>GET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CONFIG_RESETSTAT.html">lib/commands/CONFIG_<wbr/>RESETSTAT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CONFIG_REWRITE.html">lib/commands/CONFIG_<wbr/>REWRITE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_CONFIG_SET.html">lib/commands/CONFIG_<wbr/>SET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_COPY.html">lib/commands/COPY</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_DBSIZE.html">lib/commands/DBSIZE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_DECR.html">lib/commands/DECR</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_DECRBY.html">lib/commands/DECRBY</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_DEL.html">lib/commands/DEL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_DISCARD.html">lib/commands/DISCARD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_DUMP.html">lib/commands/DUMP</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ECHO.html">lib/commands/ECHO</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_EVAL.html">lib/commands/EVAL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_EVALSHA.html">lib/commands/EVALSHA</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_EXISTS.html">lib/commands/EXISTS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_EXPIRE.html">lib/commands/EXPIRE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_EXPIREAT.html">lib/commands/EXPIREAT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_FAILOVER.html">lib/commands/FAILOVER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_FLUSHALL.html">lib/commands/FLUSHALL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_FLUSHDB.html">lib/commands/FLUSHDB</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GEOADD.html">lib/commands/GEOADD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GEODIST.html">lib/commands/GEODIST</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GEOHASH.html">lib/commands/GEOHASH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GEOPOS.html">lib/commands/GEOPOS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GEOSEARCH.html">lib/commands/GEOSEARCH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GEOSEARCHSTORE.html">lib/commands/GEOSEARCHSTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GEOSEARCH_WITH.html">lib/commands/GEOSEARCH_<wbr/>WITH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GET.html">lib/commands/GET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GETBIT.html">lib/commands/GETBIT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GETDEL.html">lib/commands/GETDEL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GETEX.html">lib/commands/GETEX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GETRANGE.html">lib/commands/GETRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GETSET.html">lib/commands/GETSET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_GET_BUFFER.html">lib/commands/GET_<wbr/>BUFFER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HDEL.html">lib/commands/HDEL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HELLO.html">lib/commands/HELLO</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HEXISTS.html">lib/commands/HEXISTS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HGET.html">lib/commands/HGET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HGETALL.html">lib/commands/HGETALL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HINCRBY.html">lib/commands/HINCRBY</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HINCRBYFLOAT.html">lib/commands/HINCRBYFLOAT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HKEYS.html">lib/commands/HKEYS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HLEN.html">lib/commands/HLEN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HMGET.html">lib/commands/HMGET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HRANDFIELD.html">lib/commands/HRANDFIELD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HRANDFIELD_COUNT.html">lib/commands/HRANDFIELD_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HRANDFIELD_COUNT_WITHVALUES.html">lib/commands/HRANDFIELD_<wbr/>COUNT_<wbr/>WITHVALUES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HSCAN.html">lib/commands/HSCAN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HSET.html">lib/commands/HSET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HSETNX.html">lib/commands/HSETNX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HSTRLEN.html">lib/commands/HSTRLEN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_HVALS.html">lib/commands/HVALS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_INCR.html">lib/commands/INCR</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_INCRBY.html">lib/commands/INCRBY</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_INCRBYFLOAT.html">lib/commands/INCRBYFLOAT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_INFO.html">lib/commands/INFO</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_KEYS.html">lib/commands/KEYS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LASTSAVE.html">lib/commands/LASTSAVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LINDEX.html">lib/commands/LINDEX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LINSERT.html">lib/commands/LINSERT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LLEN.html">lib/commands/LLEN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LMOVE.html">lib/commands/LMOVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LOLWUT.html">lib/commands/LOLWUT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LPOP.html">lib/commands/LPOP</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LPOP_COUNT.html">lib/commands/LPOP_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LPOS.html">lib/commands/LPOS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LPOS_COUNT.html">lib/commands/LPOS_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LPUSH.html">lib/commands/LPUSH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LPUSHX.html">lib/commands/LPUSHX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LRANGE.html">lib/commands/LRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LREM.html">lib/commands/LREM</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LSET.html">lib/commands/LSET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_LTRIM.html">lib/commands/LTRIM</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MEMORY_DOCTOR.html">lib/commands/MEMORY_<wbr/>DOCTOR</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MEMORY_MALLOC_STATS.html">lib/commands/MEMORY_<wbr/>MALLOC-<wbr/>STATS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MEMORY_PURGE.html">lib/commands/MEMORY_<wbr/>PURGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MEMORY_STATS.html">lib/commands/MEMORY_<wbr/>STATS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MEMORY_USAGE.html">lib/commands/MEMORY_<wbr/>USAGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MGET.html">lib/commands/MGET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MIGRATE.html">lib/commands/MIGRATE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MODULE_LIST.html">lib/commands/MODULE_<wbr/>LIST</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MODULE_LOAD.html">lib/commands/MODULE_<wbr/>LOAD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MODULE_UNLOAD.html">lib/commands/MODULE_<wbr/>UNLOAD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MOVE.html">lib/commands/MOVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MSET.html">lib/commands/MSET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_MSETNX.html">lib/commands/MSETNX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PERSIST.html">lib/commands/PERSIST</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PEXPIRE.html">lib/commands/PEXPIRE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PEXPIREAT.html">lib/commands/PEXPIREAT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PFADD.html">lib/commands/PFADD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PFCOUNT.html">lib/commands/PFCOUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PFMERGE.html">lib/commands/PFMERGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PING.html">lib/commands/PING</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PSETEX.html">lib/commands/PSETEX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PTTL.html">lib/commands/PTTL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_PUBLISH.html">lib/commands/PUBLISH</a></li><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_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><li class=" tsd-kind-module"><a href="../modules/lib_commands_RENAME.html">lib/commands/RENAME</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_RENAMENX.html">lib/commands/RENAMENX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_REPLICAOF.html">lib/commands/REPLICAOF</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_RESTORE_ASKING.html">lib/commands/RESTORE-<wbr/>ASKING</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ROLE.html">lib/commands/ROLE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_RPOP.html">lib/commands/RPOP</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_RPOPLPUSH.html">lib/commands/RPOPLPUSH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_RPOP_COUNT.html">lib/commands/RPOP_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_RPUSH.html">lib/commands/RPUSH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_RPUSHX.html">lib/commands/RPUSHX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SADD.html">lib/commands/SADD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SAVE.html">lib/commands/SAVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SCAN.html">lib/commands/SCAN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SCARD.html">lib/commands/SCARD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SCRIPT_DEBUG.html">lib/commands/SCRIPT_<wbr/>DEBUG</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SCRIPT_EXISTS.html">lib/commands/SCRIPT_<wbr/>EXISTS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SCRIPT_FLUSH.html">lib/commands/SCRIPT_<wbr/>FLUSH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SCRIPT_KILL.html">lib/commands/SCRIPT_<wbr/>KILL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SCRIPT_LOAD.html">lib/commands/SCRIPT_<wbr/>LOAD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SDIFF.html">lib/commands/SDIFF</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SDIFFSTORE.html">lib/commands/SDIFFSTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SET.html">lib/commands/SET</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SETBIT.html">lib/commands/SETBIT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SETEX.html">lib/commands/SETEX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SETNX.html">lib/commands/SETNX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SETRANGE.html">lib/commands/SETRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SHUTDOWN.html">lib/commands/SHUTDOWN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SINTER.html">lib/commands/SINTER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SINTERSTORE.html">lib/commands/SINTERSTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SISMEMBER.html">lib/commands/SISMEMBER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SMEMBERS.html">lib/commands/SMEMBERS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SMISMEMBER.html">lib/commands/SMISMEMBER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SMOVE.html">lib/commands/SMOVE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SORT.html">lib/commands/SORT</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_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><li class=" tsd-kind-module"><a href="../modules/lib_commands_SSCAN.html">lib/commands/SSCAN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_STRLEN.html">lib/commands/STRLEN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SUNION.html">lib/commands/SUNION</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SUNIONSTORE.html">lib/commands/SUNIONSTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_SWAPDB.html">lib/commands/SWAPDB</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_TIME.html">lib/commands/TIME</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_TOUCH.html">lib/commands/TOUCH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_TTL.html">lib/commands/TTL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_TYPE.html">lib/commands/TYPE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_UNLINK.html">lib/commands/UNLINK</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_UNWATCH.html">lib/commands/UNWATCH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_WAIT.html">lib/commands/WAIT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_WATCH.html">lib/commands/WATCH</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XACK.html">lib/commands/XACK</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XADD.html">lib/commands/XADD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XAUTOCLAIM.html">lib/commands/XAUTOCLAIM</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XAUTOCLAIM_JUSTID.html">lib/commands/XAUTOCLAIM_<wbr/>JUSTID</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XCLAIM.html">lib/commands/XCLAIM</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XCLAIM_JUSTID.html">lib/commands/XCLAIM_<wbr/>JUSTID</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XDEL.html">lib/commands/XDEL</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XGROUP_CREATE.html">lib/commands/XGROUP_<wbr/>CREATE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XGROUP_CREATECONSUMER.html">lib/commands/XGROUP_<wbr/>CREATECONSUMER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XGROUP_DELCONSUMER.html">lib/commands/XGROUP_<wbr/>DELCONSUMER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XGROUP_DESTROY.html">lib/commands/XGROUP_<wbr/>DESTROY</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XGROUP_SETID.html">lib/commands/XGROUP_<wbr/>SETID</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XINFO_CONSUMERS.html">lib/commands/XINFO_<wbr/>CONSUMERS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XINFO_GROUPS.html">lib/commands/XINFO_<wbr/>GROUPS</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XINFO_STREAM.html">lib/commands/XINFO_<wbr/>STREAM</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XLEN.html">lib/commands/XLEN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XPENDING.html">lib/commands/XPENDING</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XPENDING_RANGE.html">lib/commands/XPENDING_<wbr/>RANGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XRANGE.html">lib/commands/XRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XREAD.html">lib/commands/XREAD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XREADGROUP.html">lib/commands/XREADGROUP</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XREVRANGE.html">lib/commands/XREVRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_XTRIM.html">lib/commands/XTRIM</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZADD.html">lib/commands/ZADD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZCARD.html">lib/commands/ZCARD</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZCOUNT.html">lib/commands/ZCOUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZDIFF.html">lib/commands/ZDIFF</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZDIFFSTORE.html">lib/commands/ZDIFFSTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZDIFF_WITHSCORES.html">lib/commands/ZDIFF_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZINCRBY.html">lib/commands/ZINCRBY</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZINTER.html">lib/commands/ZINTER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZINTERSTORE.html">lib/commands/ZINTERSTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZINTER_WITHSCORES.html">lib/commands/ZINTER_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZLEXCOUNT.html">lib/commands/ZLEXCOUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZMSCORE.html">lib/commands/ZMSCORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZPOPMAX.html">lib/commands/ZPOPMAX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZPOPMAX_COUNT.html">lib/commands/ZPOPMAX_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZPOPMIN.html">lib/commands/ZPOPMIN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZPOPMIN_COUNT.html">lib/commands/ZPOPMIN_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANDMEMBER.html">lib/commands/ZRANDMEMBER</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANDMEMBER_COUNT.html">lib/commands/ZRANDMEMBER_<wbr/>COUNT</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANDMEMBER_COUNT_WITHSCORES.html">lib/commands/ZRANDMEMBER_<wbr/>COUNT_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANGE.html">lib/commands/ZRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANGEBYLEX.html">lib/commands/ZRANGEBYLEX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANGEBYSCORE.html">lib/commands/ZRANGEBYSCORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANGEBYSCORE_WITHSCORES.html">lib/commands/ZRANGEBYSCORE_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANGESTORE.html">lib/commands/ZRANGESTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANGE_WITHSCORES.html">lib/commands/ZRANGE_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZRANK.html">lib/commands/ZRANK</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZREM.html">lib/commands/ZREM</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZREMRANGEBYLEX.html">lib/commands/ZREMRANGEBYLEX</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZREMRANGEBYRANK.html">lib/commands/ZREMRANGEBYRANK</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZREMRANGEBYSCORE.html">lib/commands/ZREMRANGEBYSCORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZREVRANK.html">lib/commands/ZREVRANK</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZSCAN.html">lib/commands/ZSCAN</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZSCORE.html">lib/commands/ZSCORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZUNION.html">lib/commands/ZUNION</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZUNIONSTORE.html">lib/commands/ZUNIONSTORE</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_ZUNION_WITHSCORES.html">lib/commands/ZUNION_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="../modules/lib_commands_generic_transformers.html">lib/commands/generic-<wbr/>transformers</a></li><li class=" tsd-kind-module"><a href="../modules/lib_errors.html">lib/errors</a></li><li class=" tsd-kind-module"><a href="../modules/lib_lua_script.html">lib/lua-<wbr/>script</a></li><li class=" tsd-kind-module"><a href="../modules/lib_multi_command.html">lib/multi-<wbr/>command</a></li><li class=" tsd-kind-module"><a href="../modules/lib_ts_declarations_cluster_key_slot.html">lib/ts-<wbr/>declarations/cluster-<wbr/>key-<wbr/>slot</a></li><li class=" tsd-kind-module"><a href="../modules/lib_utils.html">lib/utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"><a href="lib_client.default.html" class="tsd-kind-icon">default</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-has-type-parameter tsd-is-overwrite"><a href="lib_client.default.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_isolationPool" class="tsd-kind-icon">#isolation<wbr/>Pool</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_options" class="tsd-kind-icon">#options</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_queue" class="tsd-kind-icon">#queue</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_selectedDB" class="tsd-kind-icon">#selectedDB</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_socket" class="tsd-kind-icon">#socket</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_v4" class="tsd-kind-icon">#v4</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#pSubscribe" class="tsd-kind-icon">p<wbr/>Subscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#pUnsubscribe" class="tsd-kind-icon">p<wbr/>Unsubscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#quit" class="tsd-kind-icon">quit</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#select" class="tsd-kind-icon">select</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#subscribe" class="tsd-kind-icon">subscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="lib_client.default.html#unsubscribe" class="tsd-kind-icon">unsubscribe</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="lib_client.default.html#isOpen" class="tsd-kind-icon">is<wbr/>Open</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="lib_client.default.html#options" class="tsd-kind-icon">options</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="lib_client.default.html#v4" class="tsd-kind-icon">v4</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_defineLegacyCommand" class="tsd-kind-icon">#define<wbr/>Legacy<wbr/>Command</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_destroyIsolationPool" class="tsd-kind-icon">#destroy<wbr/>Isolation<wbr/>Pool</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_initiateOptions" class="tsd-kind-icon">#initiate<wbr/>Options</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_initiateQueue" class="tsd-kind-icon">#initiate<wbr/>Queue</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_initiateSocket" class="tsd-kind-icon">#initiate<wbr/>Socket</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_legacyMode" class="tsd-kind-icon">#legacy<wbr/>Mode</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="lib_client.default.html#_sendCommand" class="tsd-kind-icon">#send<wbr/>Command</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="lib_client.default.html#_subscribe" class="tsd-kind-icon">#subscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="lib_client.default.html#_tick" class="tsd-kind-icon">#tick</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-private"><a href="lib_client.default.html#_unsubscribe" class="tsd-kind-icon">#unsubscribe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#PSUBSCRIBE" class="tsd-kind-icon">PSUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#PUNSUBSCRIBE" class="tsd-kind-icon">PUNSUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#QUIT" class="tsd-kind-icon">QUIT</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#SELECT" class="tsd-kind-icon">SELECT</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#SUBSCRIBE" class="tsd-kind-icon">SUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#UNSUBSCRIBE" class="tsd-kind-icon">UNSUBSCRIBE</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#commandsExecutor" class="tsd-kind-icon">commands<wbr/>Executor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#disconnect" class="tsd-kind-icon">disconnect</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#duplicate" class="tsd-kind-icon">duplicate</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#executeIsolated" class="tsd-kind-icon">execute<wbr/>Isolated</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#executeScript" class="tsd-kind-icon">execute<wbr/>Script</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#hScanIterator" class="tsd-kind-icon">h<wbr/>Scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#multi" class="tsd-kind-icon">multi</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#multiExecutor" class="tsd-kind-icon">multi<wbr/>Executor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#sScanIterator" class="tsd-kind-icon">s<wbr/>Scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#scanIterator" class="tsd-kind-icon">scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#scriptsExecutor" class="tsd-kind-icon">scripts<wbr/>Executor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="lib_client.default.html#sendCommand" class="tsd-kind-icon">send<wbr/>Command</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="lib_client.default.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="lib_client.default.html#zScanIterator" class="tsd-kind-icon">z<wbr/>Scan<wbr/>Iterator</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="lib_client.default.html#commandOptions" class="tsd-kind-icon">command<wbr/>Options</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="lib_client.default.html#create" class="tsd-kind-icon">create</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-static"><a href="lib_client.default.html#extend" class="tsd-kind-icon">extend</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#getEventListeners" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#on-1" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="lib_client.default.html#once-1" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="lib_client.default.html#parseURL" class="tsd-kind-icon">parseURL</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li><li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><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>
View Git Blame Copy Permalink