You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-09 00:22:08 +03:00
172 lines
110 KiB
HTML
172 lines
110 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RedisTlsSocketOptions | @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_socket.html">lib/client/socket</a></li><li><a href="lib_client_socket.RedisTlsSocketOptions.html">RedisTlsSocketOptions</a></li></ul><h1>Interface RedisTlsSocketOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">ConnectionOptions</span><ul class="tsd-hierarchy"><li><span class="target">RedisTlsSocketOptions</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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ALPNProtocols" class="tsd-kind-icon">ALPNProtocols</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#SNICallback" class="tsd-kind-icon">SNICallback</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ca" class="tsd-kind-icon">ca</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#cert" class="tsd-kind-icon">cert</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#checkServerIdentity" class="tsd-kind-icon">check<wbr/>Server<wbr/>Identity</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ciphers" class="tsd-kind-icon">ciphers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#clientCertEngine" class="tsd-kind-icon">client<wbr/>Cert<wbr/>Engine</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#crl" class="tsd-kind-icon">crl</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#dhparam" class="tsd-kind-icon">dhparam</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ecdhCurve" class="tsd-kind-icon">ecdh<wbr/>Curve</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#enableTrace" class="tsd-kind-icon">enable<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#honorCipherOrder" class="tsd-kind-icon">honor<wbr/>Cipher<wbr/>Order</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#host" class="tsd-kind-icon">host</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#lookup" class="tsd-kind-icon">lookup</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#maxVersion" class="tsd-kind-icon">max<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#minDHSize" class="tsd-kind-icon">minDHSize</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#minVersion" class="tsd-kind-icon">min<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#path" class="tsd-kind-icon">path</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#pfx" class="tsd-kind-icon">pfx</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#port" class="tsd-kind-icon">port</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#privateKeyEngine" class="tsd-kind-icon">private<wbr/>Key<wbr/>Engine</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#privateKeyIdentifier" class="tsd-kind-icon">private<wbr/>Key<wbr/>Identifier</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#rejectUnauthorized" class="tsd-kind-icon">reject<wbr/>Unauthorized</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#requestCert" class="tsd-kind-icon">request<wbr/>Cert</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#secureContext" class="tsd-kind-icon">secure<wbr/>Context</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#secureOptions" class="tsd-kind-icon">secure<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#secureProtocol" class="tsd-kind-icon">secure<wbr/>Protocol</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#servername" class="tsd-kind-icon">servername</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#sessionIdContext" class="tsd-kind-icon">session<wbr/>Id<wbr/>Context</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#sessionTimeout" class="tsd-kind-icon">session<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#sigalgs" class="tsd-kind-icon">sigalgs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#socket" class="tsd-kind-icon">socket</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ticketKeys" class="tsd-kind-icon">ticket<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#timeout" class="tsd-kind-icon">timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="lib_client_socket.RedisTlsSocketOptions.html#tls" class="tsd-kind-icon">tls</a></li></ul></section><section class="tsd-index-section tsd-is-inherited tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#pskCallback" class="tsd-kind-icon">psk<wbr/>Callback</a></li></ul></section></div></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-interface tsd-is-inherited tsd-is-external"><a id="ALPNProtocols" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ALPNProtocols<a href="#ALPNProtocols" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ALPNProtocols<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Uint8Array</span><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">Uint8Array</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.ALPNProtocols</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:447</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An array of strings or a Buffer naming possible ALPN protocols.
|
|
(Protocols should be ordered by their priority.)</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="SNICallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> SNICallback<a href="#SNICallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">SNICallback<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>servername<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span>, ctx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SecureContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.SNICallback</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:457</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-interface"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>servername<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cb<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span>, ctx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SecureContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</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"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>SNICallback(servername, cb) <Function> A function that will be
|
|
called if the client supports SNI TLS extension. Two arguments
|
|
will be passed when called: servername and cb. SNICallback should
|
|
invoke cb(null, ctx), where ctx is a SecureContext instance.
|
|
(tls.createSecureContext(...) can be used to get a proper
|
|
SecureContext.) If SNICallback wasn't provided the default callback
|
|
with high-level API will be used (see below).</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>servername: <span class="tsd-signature-type">string</span></h5></li><li><h5>cb: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span>, ctx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SecureContext</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </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"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span>, ctx<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SecureContext</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>err: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Error</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> ctx: <span class="tsd-signature-type">SecureContext</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 <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="ca" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ca<a href="#ca" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ca<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</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">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.ca</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:656</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optionally override the trusted CA certificates. Default is to trust
|
|
the well-known CAs curated by Mozilla. Mozilla's CAs are completely
|
|
replaced when CAs are explicitly specified using this option.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="cert" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> cert<a href="#cert" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">cert<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</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">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.cert</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:668</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p> Cert chains in PEM format. One cert chain should be provided per
|
|
private key. Each cert chain should consist of the PEM formatted
|
|
certificate for a provided private key, followed by the PEM
|
|
formatted intermediate certificates (if any), in order, and not
|
|
including the root CA (the root CA must be pre-known to the peer,
|
|
see ca). When providing multiple cert chains, they do not have to
|
|
be in the same order as their private keys in key. If the
|
|
intermediate certificates are not provided, the peer will not be
|
|
able to validate the certificate, and the handshake will fail.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="checkServerIdentity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr/>Server<wbr/>Identity<a href="#checkServerIdentity" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">check<wbr/>Server<wbr/>Identity<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span>hostname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PeerCertificate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.checkServerIdentity</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:521</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-interface"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hostname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cert<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PeerCertificate</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Verifies the certificate <code>cert</code> is issued to <code>hostname</code>.</p>
|
|
</div><div><p>Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a> object, populating it with <code>reason</code>, <code>host</code>, and <code>cert</code> on
|
|
failure. On success, returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Undefined_type">undefined</a>.</p>
|
|
<p>This function can be overwritten by providing alternative function as part of
|
|
the <code>options.checkServerIdentity</code> option passed to <code>tls.connect()</code>. The
|
|
overwriting function can call <code>tls.checkServerIdentity()</code> of course, to augment
|
|
the checks done with additional verification.</p>
|
|
<p>This function is only called if the certificate passed all other checks, such as
|
|
being issued by trusted CA (<code>options.ca</code>).</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.8.4</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hostname: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The host name or IP address to verify the certificate against.</p>
|
|
</div></div></li><li><h5>cert: <span class="tsd-signature-type">PeerCertificate</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A <code>certificate object</code> representing the peer's certificate.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h4></li></ul></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="ciphers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ciphers<a href="#ciphers" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ciphers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.ciphers</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:682</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Cipher suite specification, replacing the default. For more
|
|
information, see modifying the default cipher suite. Permitted
|
|
ciphers can be obtained via tls.getCiphers(). Cipher names must be
|
|
uppercased in order for OpenSSL to accept them.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="clientCertEngine" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr/>Cert<wbr/>Engine<a href="#clientCertEngine" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">client<wbr/>Cert<wbr/>Engine<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.clientCertEngine</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:686</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Name of an OpenSSL engine which can provide the client certificate.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="crl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> crl<a href="#crl" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">crl<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</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">Buffer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.crl</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:690</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PEM formatted CRLs (Certificate Revocation Lists).</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="dhparam" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> dhparam<a href="#dhparam" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">dhparam<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.dhparam</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:699</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Diffie Hellman parameters, required for Perfect Forward Secrecy. Use
|
|
openssl dhparam to create the parameters. The key length must be
|
|
greater than or equal to 1024 bits or else an error will be thrown.
|
|
Although 1024 bits is permissible, use 2048 bits or larger for
|
|
stronger security. If omitted or invalid, the parameters are
|
|
silently discarded and DHE ciphers will not be available.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="ecdhCurve" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ecdh<wbr/>Curve<a href="#ecdhCurve" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ecdh<wbr/>Curve<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.ecdhCurve</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:709</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A string describing a named curve or a colon separated list of curve
|
|
NIDs or names, for example P-521:P-384:P-256, to use for ECDH key
|
|
agreement. Set to auto to select the curve automatically. Use
|
|
crypto.getCurves() to obtain a list of available curve names. On
|
|
recent releases, openssl ecparam -list_curves will also display the
|
|
name and description of each available elliptic curve. Default:
|
|
tls.DEFAULT_ECDH_CURVE.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="enableTrace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> enable<wbr/>Trace<a href="#enableTrace" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">enable<wbr/>Trace<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.enableTrace</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:436</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>When enabled, TLS packet trace information is written to <code>stderr</code>. This can be
|
|
used to debug TLS connection problems.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="honorCipherOrder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> honor<wbr/>Cipher<wbr/>Order<a href="#honorCipherOrder" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">honor<wbr/>Cipher<wbr/>Order<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.honorCipherOrder</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:715</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Attempt to use the server's cipher suite preferences instead of the
|
|
client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be
|
|
set in secureOptions</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="host" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> host<a href="#host" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.host</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:517</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="key" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> key<a href="#key" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</span><span class="tsd-signature-symbol"> | </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">KeyObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.key</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:726</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Private keys in PEM format. PEM allows the option of private keys
|
|
being encrypted. Encrypted keys will be decrypted with
|
|
options.passphrase. Multiple keys using different algorithms can be
|
|
provided either as an array of unencrypted key strings or buffers,
|
|
or an array of objects in the form {pem: <string|buffer>[,
|
|
passphrase: <string>]}. The object form can only occur in an array.
|
|
object.passphrase is optional. Encrypted keys will be decrypted with
|
|
object.passphrase if provided, or options.passphrase if it is not.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="lookup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> lookup<a href="#lookup" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">lookup<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LookupFunction</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.lookup</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:525</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="maxVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Version<a href="#maxVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SecureVersion</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.maxVersion</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:746</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optionally set the maximum TLS version to allow. One
|
|
of <code>'TLSv1.3'</code>, <code>'TLSv1.2'</code>, <code>'TLSv1.1'</code>, or <code>'TLSv1'</code>. Cannot be specified along with the
|
|
<code>secureProtocol</code> option, use one or the other.
|
|
<strong>Default:</strong> <code>'TLSv1.3'</code>, unless changed using CLI options. Using
|
|
<code>--tls-max-v1.2</code> sets the default to <code>'TLSv1.2'</code>. Using <code>--tls-max-v1.3</code> sets the default to
|
|
<code>'TLSv1.3'</code>. If multiple of the options are provided, the highest maximum is used.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="minDHSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> minDHSize<a href="#minDHSize" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">minDHSize<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.minDHSize</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:524</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="minVersion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> min<wbr/>Version<a href="#minVersion" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">min<wbr/>Version<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SecureVersion</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.minVersion</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:757</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optionally set the minimum TLS version to allow. One
|
|
of <code>'TLSv1.3'</code>, <code>'TLSv1.2'</code>, <code>'TLSv1.1'</code>, or <code>'TLSv1'</code>. Cannot be specified along with the
|
|
<code>secureProtocol</code> option, use one or the other. It is not recommended to use
|
|
less than TLSv1.2, but it may be required for interoperability.
|
|
<strong>Default:</strong> <code>'TLSv1.2'</code>, unless changed using CLI options. Using
|
|
<code>--tls-v1.0</code> sets the default to <code>'TLSv1'</code>. Using <code>--tls-v1.1</code> sets the default to
|
|
<code>'TLSv1.1'</code>. Using <code>--tls-min-v1.3</code> sets the default to
|
|
'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="passphrase" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> passphrase<a href="#passphrase" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">passphrase<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.passphrase</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:761</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Shared passphrase used for a single private key and/or a PFX.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="path" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> path<a href="#path" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.path</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:519</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="pfx" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> pfx<a href="#pfx" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">pfx<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Buffer</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">Buffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PxfObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.pfx</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:772</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>PFX or PKCS12 encoded private key and certificate chain. pfx is an
|
|
alternative to providing key and cert individually. PFX is usually
|
|
encrypted, if it is, passphrase will be used to decrypt it. Multiple
|
|
PFX can be provided either as an array of unencrypted PFX buffers,
|
|
or an array of objects in the form {buf: <string|buffer>[,
|
|
passphrase: <string>]}. The object form can only occur in an array.
|
|
object.passphrase is optional. Encrypted PFX will be decrypted with
|
|
object.passphrase if provided, or options.passphrase if it is not.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="port" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> port<a href="#port" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.port</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:518</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="privateKeyEngine" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> private<wbr/>Key<wbr/>Engine<a href="#privateKeyEngine" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">private<wbr/>Key<wbr/>Engine<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.privateKeyEngine</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:731</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Name of an OpenSSL engine to get private key from. Should be used
|
|
together with privateKeyIdentifier.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="privateKeyIdentifier" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> private<wbr/>Key<wbr/>Identifier<a href="#privateKeyIdentifier" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">private<wbr/>Key<wbr/>Identifier<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.privateKeyIdentifier</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:737</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Identifier of a private key managed by an OpenSSL engine. Should be
|
|
used together with privateKeyEngine. Should not be set together with
|
|
key, because both options define a private key in different ways.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="rejectUnauthorized" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> reject<wbr/>Unauthorized<a href="#rejectUnauthorized" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">reject<wbr/>Unauthorized<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.rejectUnauthorized</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:464</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true the server will reject any connection which is not
|
|
authorized with the list of supplied CAs. This option only has an
|
|
effect if requestCert is true.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>true</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="requestCert" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr/>Cert<a href="#requestCert" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">request<wbr/>Cert<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.requestCert</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:442</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If true the server will request a certificate from clients that
|
|
connect and attempt to verify that certificate. Defaults to
|
|
false.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="secureContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> secure<wbr/>Context<a href="#secureContext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">secure<wbr/>Context<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">SecureContext</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.secureContext</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:430</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An optional TLS context object from tls.createSecureContext()</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="secureOptions" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> secure<wbr/>Options<a href="#secureOptions" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">secure<wbr/>Options<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.secureOptions</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:778</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optionally affect the OpenSSL protocol behavior, which is not
|
|
usually necessary. This should be used carefully if at all! Value is
|
|
a numeric bitmask of the SSL_OP_* options from OpenSSL Options</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="secureProtocol" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> secure<wbr/>Protocol<a href="#secureProtocol" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">secure<wbr/>Protocol<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.secureProtocol</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:790</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Legacy mechanism to select the TLS protocol version to use, it does
|
|
not support independent control of the minimum and maximum version,
|
|
and does not support limiting the protocol to TLSv1.3. Use
|
|
minVersion and maxVersion instead. The possible values are listed as
|
|
SSL_METHODS, use the function names as strings. For example, use
|
|
'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow
|
|
any TLS protocol version up to TLSv1.3. It is not recommended to use
|
|
TLS versions less than 1.2, but it may be required for
|
|
interoperability. Default: none, see minVersion.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="servername" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> servername<a href="#servername" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">servername<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.servername</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:522</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="session" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> session<a href="#session" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Buffer</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.session</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:523</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="sessionIdContext" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> session<wbr/>Id<wbr/>Context<a href="#sessionIdContext" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">session<wbr/>Id<wbr/>Context<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.sessionIdContext</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:795</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Opaque identifier used by servers to ensure session state is not
|
|
shared between applications. Unused by clients.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="sessionTimeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> session<wbr/>Timeout<a href="#sessionTimeout" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">session<wbr/>Timeout<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.sessionTimeout</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:806</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The number of seconds after which a TLS session created by the
|
|
server will no longer be resumable. See Session Resumption for more
|
|
information. Default: 300.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="sigalgs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> sigalgs<a href="#sigalgs" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">sigalgs<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.sigalgs</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:675</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p> Colon-separated list of supported signature algorithms. The list
|
|
can contain digest algorithms (SHA256, MD5 etc.), public key
|
|
algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g
|
|
'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="socket" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> socket<a href="#socket" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">socket<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Duplex</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.socket</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:520</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="ticketKeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> ticket<wbr/>Keys<a href="#ticketKeys" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">ticket<wbr/>Keys<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Buffer</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.ticketKeys</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:800</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>48-bytes of cryptographically strong pseudo-random data.
|
|
See Session Resumption for more information.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="timeout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> timeout<a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.timeout</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:526</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="tls" class="tsd-anchor"></a><h3 class="tsd-anchor-link">tls<a href="#tls" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/8160fa7/packages/client/lib/client/socket.ts#L21">packages/client/lib/client/socket.ts:21</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a id="pskCallback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> psk<wbr/>Callback<a href="#pskCallback" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">psk<wbr/>Callback<span class="tsd-signature-symbol">(</span>hint<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><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">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PSKCallbackNegotation</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from tls.ConnectionOptions.pskCallback</p><ul><li>Defined in node_modules/@types/node/tls.d.ts:544</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>When negotiating TLS-PSK (pre-shared keys), this function is called
|
|
with optional identity <code>hint</code> provided by the server or <code>null</code>
|
|
in case of TLS 1.3 where <code>hint</code> was removed.
|
|
It will be necessary to provide a custom <code>tls.checkServerIdentity()</code>
|
|
for the connection as the default one will try to check hostname/IP
|
|
of the server against the certificate but that's not applicable for PSK
|
|
because there won't be a certificate present.
|
|
More information can be found in the RFC 4279.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hint: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>message sent from the server to help client
|
|
decide which identity to use during negotiation.
|
|
Always <code>null</code> if TLS 1.3 is used.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">PSKCallbackNegotation</span></h4><div><p>Return <code>null</code> to stop the negotiation process. <code>psk</code> must be
|
|
compatible with the selected cipher's digest.
|
|
<code>identity</code> must use UTF-8 encoding.</p>
|
|
</div></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=" 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="current 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_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_utils.html">lib/utils</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="lib_client_socket.RedisTlsSocketOptions.html" class="tsd-kind-icon">Redis<wbr/>Tls<wbr/>Socket<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ALPNProtocols" class="tsd-kind-icon">ALPNProtocols</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#SNICallback" class="tsd-kind-icon">SNICallback</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ca" class="tsd-kind-icon">ca</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#cert" class="tsd-kind-icon">cert</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#checkServerIdentity" class="tsd-kind-icon">check<wbr/>Server<wbr/>Identity</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ciphers" class="tsd-kind-icon">ciphers</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#clientCertEngine" class="tsd-kind-icon">client<wbr/>Cert<wbr/>Engine</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#crl" class="tsd-kind-icon">crl</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#dhparam" class="tsd-kind-icon">dhparam</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ecdhCurve" class="tsd-kind-icon">ecdh<wbr/>Curve</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#enableTrace" class="tsd-kind-icon">enable<wbr/>Trace</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#honorCipherOrder" class="tsd-kind-icon">honor<wbr/>Cipher<wbr/>Order</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#host" class="tsd-kind-icon">host</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#key" class="tsd-kind-icon">key</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#lookup" class="tsd-kind-icon">lookup</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#maxVersion" class="tsd-kind-icon">max<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#minDHSize" class="tsd-kind-icon">minDHSize</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#minVersion" class="tsd-kind-icon">min<wbr/>Version</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#passphrase" class="tsd-kind-icon">passphrase</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#path" class="tsd-kind-icon">path</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#pfx" class="tsd-kind-icon">pfx</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#port" class="tsd-kind-icon">port</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#privateKeyEngine" class="tsd-kind-icon">private<wbr/>Key<wbr/>Engine</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#privateKeyIdentifier" class="tsd-kind-icon">private<wbr/>Key<wbr/>Identifier</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#rejectUnauthorized" class="tsd-kind-icon">reject<wbr/>Unauthorized</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#requestCert" class="tsd-kind-icon">request<wbr/>Cert</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#secureContext" class="tsd-kind-icon">secure<wbr/>Context</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#secureOptions" class="tsd-kind-icon">secure<wbr/>Options</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#secureProtocol" class="tsd-kind-icon">secure<wbr/>Protocol</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#servername" class="tsd-kind-icon">servername</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#session" class="tsd-kind-icon">session</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#sessionIdContext" class="tsd-kind-icon">session<wbr/>Id<wbr/>Context</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#sessionTimeout" class="tsd-kind-icon">session<wbr/>Timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#sigalgs" class="tsd-kind-icon">sigalgs</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#socket" class="tsd-kind-icon">socket</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#ticketKeys" class="tsd-kind-icon">ticket<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#timeout" class="tsd-kind-icon">timeout</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="lib_client_socket.RedisTlsSocketOptions.html#tls" class="tsd-kind-icon">tls</a></li><li class="tsd-kind-method tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="lib_client_socket.RedisTlsSocketOptions.html#pskCallback" class="tsd-kind-icon">psk<wbr/>Callback</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-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><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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> |