511 lines
407 KiB
HTML
511 lines
407 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Socket | play-dl</title><meta name="description" content="Documentation for play-dl"/><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">play-dl</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">play-dl</a></li><li><a href="../modules/_internal_.html"><internal></a></li><li><a href="_internal_.Socket.html">Socket</a></li></ul><h1>Class Socket</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>This class is an abstraction of a TCP socket or a streaming <code>IPC</code> endpoint
|
|
(uses named pipes on Windows, and Unix domain sockets otherwise). It is also
|
|
an <code>EventEmitter</code>.</p>
|
|
</div><div><p>A <code>net.Socket</code> can be created by the user and used directly to interact with
|
|
a server. For example, it is returned by {@link createConnection},
|
|
so the user can use it to talk to the server.</p>
|
|
<p>It can also be created by Node.js and passed to the user when a connection
|
|
is received. For example, it is passed to the listeners of a <code>'connection'</code> event emitted on a {@link Server}, so the user can use
|
|
it to interact with the client.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.3.4</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.internal.html" class="tsd-signature-type" data-tsd-kind="Namespace">internal</a><span class="tsd-signature-symbol">.</span><a href="_internal_.internal.Duplex.html" class="tsd-signature-type" data-tsd-kind="Class">Duplex</a><ul class="tsd-hierarchy"><li><span class="target">Socket</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 tsd-is-external"><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#allowHalfOpen" class="tsd-kind-icon">allow<wbr/>Half<wbr/>Open</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#bufferSize" class="tsd-kind-icon">buffer<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#bytesRead" class="tsd-kind-icon">bytes<wbr/>Read</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#bytesWritten" class="tsd-kind-icon">bytes<wbr/>Written</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#connecting" class="tsd-kind-icon">connecting</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#destroyed" class="tsd-kind-icon">destroyed</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#localAddress" class="tsd-kind-icon">local<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#localPort" class="tsd-kind-icon">local<wbr/>Port</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readable" class="tsd-kind-icon">readable</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableAborted" class="tsd-kind-icon">readable<wbr/>Aborted</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableDidRead" class="tsd-kind-icon">readable<wbr/>Did<wbr/>Read</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableEncoding" class="tsd-kind-icon">readable<wbr/>Encoding</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableEnded" class="tsd-kind-icon">readable<wbr/>Ended</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableFlowing" class="tsd-kind-icon">readable<wbr/>Flowing</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableHighWaterMark" class="tsd-kind-icon">readable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableLength" class="tsd-kind-icon">readable<wbr/>Length</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableObjectMode" class="tsd-kind-icon">readable<wbr/>Object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#remoteAddress" class="tsd-kind-icon">remote<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#remoteFamily" class="tsd-kind-icon">remote<wbr/>Family</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#remotePort" class="tsd-kind-icon">remote<wbr/>Port</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writable" class="tsd-kind-icon">writable</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableCorked" class="tsd-kind-icon">writable<wbr/>Corked</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableEnded" class="tsd-kind-icon">writable<wbr/>Ended</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableFinished" class="tsd-kind-icon">writable<wbr/>Finished</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableHighWaterMark" class="tsd-kind-icon">writable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableLength" class="tsd-kind-icon">writable<wbr/>Length</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableObjectMode" class="tsd-kind-icon">writable<wbr/>Object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</a></li></ul></section><section class="tsd-index-section tsd-is-external"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_asyncIterator_" class="tsd-kind-icon">[async<wbr/>Iterator]</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_construct" class="tsd-kind-icon">_construct</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_destroy" class="tsd-kind-icon">_destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_final" class="tsd-kind-icon">_final</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_read" class="tsd-kind-icon">_read</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_write" class="tsd-kind-icon">_write</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_writev" class="tsd-kind-icon">_writev</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#cork" class="tsd-kind-icon">cork</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#end" class="tsd-kind-icon">end</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#isPaused" class="tsd-kind-icon">is<wbr/>Paused</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#pipe" class="tsd-kind-icon">pipe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#push" class="tsd-kind-icon">push</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#read" class="tsd-kind-icon">read</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#ref" class="tsd-kind-icon">ref</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#resume" class="tsd-kind-icon">resume</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#setDefaultEncoding" class="tsd-kind-icon">set<wbr/>Default<wbr/>Encoding</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#setEncoding" class="tsd-kind-icon">set<wbr/>Encoding</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#setKeepAlive" class="tsd-kind-icon">set<wbr/>Keep<wbr/>Alive</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#setNoDelay" class="tsd-kind-icon">set<wbr/>No<wbr/>Delay</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#setTimeout" class="tsd-kind-icon">set<wbr/>Timeout</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#uncork" class="tsd-kind-icon">uncork</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#unpipe" class="tsd-kind-icon">unpipe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#unref" class="tsd-kind-icon">unref</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#unshift" class="tsd-kind-icon">unshift</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#wrap" class="tsd-kind-icon">wrap</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#write" class="tsd-kind-icon">write</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#from" class="tsd-kind-icon">from</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#getEventListeners" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#isDisturbed" class="tsd-kind-icon">is<wbr/>Disturbed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#on-1" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#once-1" class="tsd-kind-icon">once</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">new <wbr/>Socket<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_internal_.SocketConstructorOpts.html" class="tsd-signature-type" data-tsd-kind="Interface">SocketConstructorOpts</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#constructor">constructor</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:76</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_internal_.SocketConstructorOpts.html" class="tsd-signature-type" data-tsd-kind="Interface">SocketConstructorOpts</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="allowHalfOpen" class="tsd-anchor"></a><h3>allow<wbr/>Half<wbr/>Open</h3><div class="tsd-signature tsd-kind-icon">allow<wbr/>Half<wbr/>Open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#allowHalfOpen">allowHalfOpen</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:819</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If <code>false</code> then the stream will automatically end the writable side when the
|
|
readable side ends. Set initially by the <code>allowHalfOpen</code> constructor option,
|
|
which defaults to <code>false</code>.</p>
|
|
</div><div><p>This can be changed manually to change the half-open behavior of an existing<code>Duplex</code> stream instance, but must be changed before the <code>'end'</code> event is
|
|
emitted.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.4</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="bufferSize" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> buffer<wbr/>Size</h3><div class="tsd-signature tsd-kind-icon">buffer<wbr/>Size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:229</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>This property shows the number of characters buffered for writing. The buffer
|
|
may contain strings whose length after encoding is not yet known. So this number
|
|
is only an approximation of the number of bytes in the buffer.</p>
|
|
</div><div><p><code>net.Socket</code> has the property that <code>socket.write()</code> always works. This is to
|
|
help users get up and running quickly. The computer cannot always keep up
|
|
with the amount of data that is written to a socket. The network connection
|
|
simply might be too slow. Node.js will internally queue up the data written to a
|
|
socket and send it out over the wire when it is possible.</p>
|
|
<p>The consequence of this internal buffering is that memory may grow.
|
|
Users who experience large or growing <code>bufferSize</code> should attempt to
|
|
"throttle" the data flows in their program with <code>socket.pause()</code> and <code>socket.resume()</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.3.8</p>
|
|
</dd><dt>deprecated</dt><dd><p>Since v14.6.0 - Use <code>writableLength</code> instead.</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="bytesRead" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> bytes<wbr/>Read</h3><div class="tsd-signature tsd-kind-icon">bytes<wbr/>Read<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:234</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The amount of received bytes.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.5.3</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="bytesWritten" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> bytes<wbr/>Written</h3><div class="tsd-signature tsd-kind-icon">bytes<wbr/>Written<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:239</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The amount of bytes sent.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.5.3</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="connecting" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> connecting</h3><div class="tsd-signature tsd-kind-icon">connecting<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:247</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>If <code>true</code>,<code>socket.connect(options[, connectListener])</code> was
|
|
called and has not yet finished. It will stay <code>true</code> until the socket becomes
|
|
connected, then it is set to <code>false</code> and the <code>'connect'</code> event is emitted. Note
|
|
that the <code>socket.connect(options[, connectListener])</code> callback is a listener for the <code>'connect'</code> event.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.1.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="destroyed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> destroyed</h3><div class="tsd-signature tsd-kind-icon">destroyed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#destroyed">destroyed</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:251</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>See <code>writable.destroyed</code> for further details.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="localAddress" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> local<wbr/>Address</h3><div class="tsd-signature tsd-kind-icon">local<wbr/>Address<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:258</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The string representation of the local IP address the remote client is
|
|
connecting on. For example, in a server listening on <code>'0.0.0.0'</code>, if a client
|
|
connects on <code>'192.168.1.1'</code>, the value of <code>socket.localAddress</code> would be<code>'192.168.1.1'</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.6</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="localPort" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> local<wbr/>Port</h3><div class="tsd-signature tsd-kind-icon">local<wbr/>Port<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:263</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The numeric representation of the local port. For example, <code>80</code> or <code>21</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.6</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readable" class="tsd-anchor"></a><h3>readable</h3><div class="tsd-signature tsd-kind-icon">readable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readable">readable</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:71</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Is <code>true</code> if it is safe to call <code>readable.read()</code>, which means
|
|
the stream has not been destroyed or emitted <code>'error'</code> or <code>'end'</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v11.4.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableAborted" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>Aborted</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Aborted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableAborted">readableAborted</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:65</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns whether the stream was destroyed or errored before emitting <code>'end'</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v16.8.0</p>
|
|
</dd><dt>experimental</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableDidRead" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>Did<wbr/>Read</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Did<wbr/>Read<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableDidRead">readableDidRead</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:77</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns whether <code>'data'</code> has been emitted.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v16.7.0</p>
|
|
</dd><dt>experimental</dt><dd></dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableEncoding" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>Encoding</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Encoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableEncoding">readableEncoding</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:82</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Getter for the property <code>encoding</code> of a given <code>Readable</code> stream. The <code>encoding</code>property can be set using the <code>readable.setEncoding()</code> method.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v12.7.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableEnded" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>Ended</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableEnded">readableEnded</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:87</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Becomes <code>true</code> when <code>'end'</code> event is emitted.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v12.9.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableFlowing" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>Flowing</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Flowing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableFlowing">readableFlowing</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:93</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>This property reflects the current state of a <code>Readable</code> stream as described
|
|
in the <code>Three states</code> section.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v9.4.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableHighWaterMark" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>High<wbr/>Water<wbr/>Mark</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>High<wbr/>Water<wbr/>Mark<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableHighWaterMark">readableHighWaterMark</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:98</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the value of <code>highWaterMark</code> passed when creating this <code>Readable</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v9.3.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableLength" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>Length</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableLength">readableLength</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:105</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>This property contains the number of bytes (or objects) in the queue
|
|
ready to be read. The value provides introspection data regarding
|
|
the status of the <code>highWaterMark</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v9.4.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="readableObjectMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr/>Object<wbr/>Mode</h3><div class="tsd-signature tsd-kind-icon">readable<wbr/>Object<wbr/>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#readableObjectMode">readableObjectMode</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:110</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Getter for the property <code>objectMode</code> of a given <code>Readable</code> stream.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v12.3.0</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="remoteAddress" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> remote<wbr/>Address</h3><div class="tsd-signature tsd-kind-icon">remote<wbr/>Address<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:269</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The string representation of the remote IP address. For example,<code>'74.125.127.100'</code> or <code>'2001:4860:a005::68'</code>. Value may be <code>undefined</code> if
|
|
the socket is destroyed (for example, if the client disconnected).</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.5.10</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="remoteFamily" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> remote<wbr/>Family</h3><div class="tsd-signature tsd-kind-icon">remote<wbr/>Family<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:274</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The string representation of the remote IP family. <code>'IPv4'</code> or <code>'IPv6'</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.11.14</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-external"><a id="remotePort" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> remote<wbr/>Port</h3><div class="tsd-signature tsd-kind-icon">remote<wbr/>Port<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:279</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The numeric representation of the remote port. For example, <code>80</code> or <code>21</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.5.10</p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="writable" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable</h3><div class="tsd-signature tsd-kind-icon">writable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#writable">writable</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:803</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="writableCorked" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr/>Corked</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>Corked<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#writableCorked">writableCorked</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:809</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="writableEnded" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr/>Ended</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#writableEnded">writableEnded</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:804</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="writableFinished" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr/>Finished</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>Finished<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#writableFinished">writableFinished</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:805</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="writableHighWaterMark" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr/>High<wbr/>Water<wbr/>Mark</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>High<wbr/>Water<wbr/>Mark<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#writableHighWaterMark">writableHighWaterMark</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:806</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="writableLength" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr/>Length</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#writableLength">writableLength</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:807</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="writableObjectMode" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr/>Object<wbr/>Mode</h3><div class="tsd-signature tsd-kind-icon">writable<wbr/>Object<wbr/>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#writableObjectMode">writableObjectMode</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:808</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> capture<wbr/>Rejection<wbr/>Symbol</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="_internal_.Readable.html#captureRejectionSymbol" class="tsd-signature-type" data-tsd-kind="Property">captureRejectionSymbol</a></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#captureRejectionSymbol">captureRejectionSymbol</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:273</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> capture<wbr/>Rejections</h3><div class="tsd-signature tsd-kind-icon">capture<wbr/>Rejections<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#captureRejections">captureRejections</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:278</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets or gets the default captureRejection value for all emitters.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="defaultMaxListeners" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> default<wbr/>Max<wbr/>Listeners</h3><div class="tsd-signature tsd-kind-icon">default<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#defaultMaxListeners">defaultMaxListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:279</li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="errorMonitor" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> error<wbr/>Monitor</h3><div class="tsd-signature tsd-kind-icon">error<wbr/>Monitor<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="_internal_.Readable.html#errorMonitor" class="tsd-signature-type" data-tsd-kind="Property">errorMonitor</a></div><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#errorMonitor">errorMonitor</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:272</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>This symbol shall be used to install a listener for only monitoring <code>'error'</code>
|
|
events. Listeners installed using this symbol are called before the regular
|
|
<code>'error'</code> listeners are called.</p>
|
|
</div><div><p>Installing a listener using this symbol does not change the behavior once an
|
|
<code>'error'</code> event is emitted, therefore the process will still crash if no
|
|
regular <code>'error'</code> listener is installed.</p>
|
|
</div></div></section></section><section class="tsd-panel-group tsd-member-group tsd-is-external"><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="_asyncIterator_" class="tsd-anchor"></a><h3>[async<wbr/>Iterator]</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">[async<wbr/>Iterator]<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.AsyncIterableIterator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncIterableIterator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#_asyncIterator_">[asyncIterator]</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:479</li></ul></aside><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.AsyncIterableIterator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncIterableIterator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="_construct" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> _construct</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">_construct<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#_construct">_construct</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:117</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></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></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="_destroy" class="tsd-anchor"></a><h3>_destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">_destroy<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#_destroy">_destroy</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:851</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>error: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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>error: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></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></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="_final" class="tsd-anchor"></a><h3>_final</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">_final<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#_final">_final</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:852</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></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></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="_read" class="tsd-anchor"></a><h3>_read</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">_read<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#_read">_read</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:118</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>size: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="_write" class="tsd-anchor"></a><h3>_write</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">_write<span class="tsd-signature-symbol">(</span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, encoding<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#_write">_write</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:843</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>chunk: <span class="tsd-signature-type">any</span></h5></li><li><h5>encoding: <a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></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></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="_writev" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> _writev</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">_writev<span class="tsd-signature-symbol">(</span>chunks<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>encoding<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span>, callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#_writev">_writev</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:844</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>chunks: <span class="tsd-signature-symbol">{ </span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>encoding<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></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></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="addListener" class="tsd-anchor"></a><h3>add<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"close"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"connect"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"data"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"drain"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"end"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"lookup"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ready"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">add<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"timeout"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:304</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>events.EventEmitter</p>
|
|
<ol>
|
|
<li>close</li>
|
|
<li>connect</li>
|
|
<li>data</li>
|
|
<li>drain</li>
|
|
<li>end</li>
|
|
<li>error</li>
|
|
<li>lookup</li>
|
|
<li>timeout</li>
|
|
</ol>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:305</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"close"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hadError: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:306</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"connect"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:307</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"data"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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>data: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:308</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"drain"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:309</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"end"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:310</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"error"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#addListener">addListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:311</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"lookup"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>address: <span class="tsd-signature-type">string</span></h5></li><li><h5>family: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li><h5>host: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.addListener</p><ul><li>Defined in node_modules/@types/node/net.d.ts:312</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ready"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.addListener</p><ul><li>Defined in node_modules/@types/node/net.d.ts:313</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"timeout"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a id="address" class="tsd-anchor"></a><h3>address</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.AddressInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressInfo</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:197</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the bound <code>address</code>, the address <code>family</code> name and <code>port</code> of the
|
|
socket as reported by the operating system:<code>{ port: 12346, family: 'IPv4', address: '127.0.0.1' }</code></p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.90</p>
|
|
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.AddressInfo.html" class="tsd-signature-type" data-tsd-kind="Interface">AddressInfo</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a id="connect" class="tsd-anchor"></a><h3>connect</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html#SocketConnectOpts" class="tsd-signature-type" data-tsd-kind="Type alias">SocketConnectOpts</a>, connectionListener<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, connectionListener<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, connectionListener<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">connect<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, connectionListener<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:113</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Initiate a connection on a given socket.</p>
|
|
</div><div><p>Possible signatures:</p>
|
|
<ul>
|
|
<li><code>socket.connect(options[, connectListener])</code></li>
|
|
<li><code>socket.connect(path[, connectListener])</code> for <code>IPC</code> connections.</li>
|
|
<li><code>socket.connect(port[, host][, connectListener])</code> for TCP connections.</li>
|
|
<li>Returns: <code>net.Socket</code> The socket itself.</li>
|
|
</ul>
|
|
<p>This function is asynchronous. When the connection is established, the <code>'connect'</code> event will be emitted. If there is a problem connecting,
|
|
instead of a <code>'connect'</code> event, an <code>'error'</code> event will be emitted with
|
|
the error passed to the <code>'error'</code> listener.
|
|
The last parameter <code>connectListener</code>, if supplied, will be added as a listener
|
|
for the <code>'connect'</code> event <strong>once</strong>.</p>
|
|
<p>This function should only be used for reconnecting a socket after<code>'close'</code> has been emitted or otherwise it may lead to undefined
|
|
behavior.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../modules/_internal_.html#SocketConnectOpts" class="tsd-signature-type" data-tsd-kind="Type alias">SocketConnectOpts</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionListener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:114</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>port: <span class="tsd-signature-type">number</span></h5></li><li><h5>host: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionListener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:115</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>port: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionListener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:116</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>path: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> connectionListener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="cork" class="tsd-anchor"></a><h3>cork</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">cork<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#cork">cork</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:859</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="destroy" class="tsd-anchor"></a><h3>destroy</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">destroy<span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#destroy">destroy</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:411</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Destroy the stream. Optionally emit an <code>'error'</code> event, and emit a <code>'close'</code>event (unless <code>emitClose</code> is set to <code>false</code>). After this call, the readable
|
|
stream will release any internal resources and subsequent calls to <code>push()</code>will be ignored.</p>
|
|
</div><div><p>Once <code>destroy()</code> has been called any further calls will be a no-op and no
|
|
further errors except from <code>_destroy()</code> may be emitted as <code>'error'</code>.</p>
|
|
<p>Implementors should not override this method, but instead implement <code>readable._destroy()</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v8.0.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Error which will be passed as payload in <code>'error'</code> event</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="emit" class="tsd-anchor"></a><h3>emit</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"close"</span>, hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"connect"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"data"</span>, data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"drain"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"end"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"lookup"</span>, err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<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">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ready"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-signature tsd-kind-icon">emit<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"timeout"</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:314</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Synchronously calls each of the listeners registered for the event named<code>eventName</code>, in the order they were registered, passing the supplied arguments
|
|
to each.</p>
|
|
</div><div><p>Returns <code>true</code> if the event had listeners, <code>false</code> otherwise.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">EventEmitter</span><span class="hl-0"> = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'events'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">myEmitter</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-5">// First listener</span><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, </span><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">firstListener</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Helloooo! first listener'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-5">// Second listener</span><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, </span><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">secondListener</span><span class="hl-0">(</span><span class="hl-3">arg1</span><span class="hl-0">, </span><span class="hl-3">arg2</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">`event with parameters </span><span class="hl-2">${</span><span class="hl-3">arg1</span><span class="hl-2">}</span><span class="hl-4">, </span><span class="hl-2">${</span><span class="hl-3">arg2</span><span class="hl-2">}</span><span class="hl-4"> in second listener`</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-5">// Third listener</span><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, </span><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">thirdListener</span><span class="hl-0">(...</span><span class="hl-3">args</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">parameters</span><span class="hl-0"> = </span><span class="hl-3">args</span><span class="hl-0">.</span><span class="hl-7">join</span><span class="hl-0">(</span><span class="hl-4">', '</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">`event with parameters </span><span class="hl-2">${</span><span class="hl-3">parameters</span><span class="hl-2">}</span><span class="hl-4"> in third listener`</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">listeners</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">));</span><br/><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, </span><span class="hl-8">1</span><span class="hl-0">, </span><span class="hl-8">2</span><span class="hl-0">, </span><span class="hl-8">3</span><span class="hl-0">, </span><span class="hl-8">4</span><span class="hl-0">, </span><span class="hl-8">5</span><span class="hl-0">);</span><br/><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// [</span><br/><span class="hl-5">// [Function: firstListener],</span><br/><span class="hl-5">// [Function: secondListener],</span><br/><span class="hl-5">// [Function: thirdListener]</span><br/><span class="hl-5">// ]</span><br/><span class="hl-5">// Helloooo! first listener</span><br/><span class="hl-5">// event with parameters 1, 2 in second listener</span><br/><span class="hl-5">// event with parameters 1, 2, 3, 4, 5 in third listener</span>
|
|
</code></pre>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:315</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"close"</span></h5></li><li><h5>hadError: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:316</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"connect"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:317</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"data"</span></h5></li><li><h5>data: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:318</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"drain"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:319</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"end"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:320</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"error"</span></h5></li><li><h5>err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#emit">emit</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:321</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"lookup"</span></h5></li><li><h5>err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>address: <span class="tsd-signature-type">string</span></h5></li><li><h5>family: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li><h5>host: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.emit</p><ul><li>Defined in node_modules/@types/node/net.d.ts:322</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ready"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.emit</p><ul><li>Defined in node_modules/@types/node/net.d.ts:323</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"timeout"</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="end" class="tsd-anchor"></a><h3>end</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-signature tsd-kind-icon">end<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a>, encoding<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">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"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#end">end</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:290</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Half-closes the socket. i.e., it sends a FIN packet. It is possible the
|
|
server will still send some data.</p>
|
|
</div><div><p>See <code>writable.end()</code> for further details.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.90</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional callback for when the socket is finished.</p>
|
|
</div></div><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-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><div><p>The socket itself.</p>
|
|
</div></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#end">end</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:291</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>buffer: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-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><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#end">end</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:292</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>str: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> encoding: <a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-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></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a><h3>event<wbr/>Names</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">event<wbr/>Names<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#eventNames">eventNames</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:614</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns an array listing the events for which the emitter has registered
|
|
listeners. The values in the array are strings or <code>Symbol</code>s.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">EventEmitter</span><span class="hl-0"> = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'events'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">myEE</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'bar'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">sym</span><span class="hl-0"> = </span><span class="hl-9">Symbol</span><span class="hl-0">(</span><span class="hl-4">'symbol'</span><span class="hl-0">);</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-3">sym</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">eventNames</span><span class="hl-0">());</span><br/><span class="hl-5">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v6.0.0</p>
|
|
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a><h3>get<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#getMaxListeners">getMaxListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:471</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the current max listener value for the <code>EventEmitter</code> which is either
|
|
set by <code>emitter.setMaxListeners(n)</code> or defaults to <a href="_internal_.Socket.html#defaultMaxListeners">defaultMaxListeners</a>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v1.0.0</p>
|
|
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="isPaused" class="tsd-anchor"></a><h3>is<wbr/>Paused</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">is<wbr/>Paused<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#isPaused">isPaused</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:278</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The <code>readable.isPaused()</code> method returns the current operating state of the<code>Readable</code>. This is used primarily by the mechanism that underlies the<code>readable.pipe()</code> method. In most
|
|
typical cases, there will be no reason to
|
|
use this method directly.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">readable</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-3">stream</span><span class="hl-0">.</span><span class="hl-7">Readable</span><span class="hl-0">();</span><br/><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">isPaused</span><span class="hl-0">(); </span><span class="hl-5">// === false</span><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">pause</span><span class="hl-0">();</span><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">isPaused</span><span class="hl-0">(); </span><span class="hl-5">// === true</span><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">resume</span><span class="hl-0">();</span><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">isPaused</span><span class="hl-0">(); </span><span class="hl-5">// === false</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.11.14</p>
|
|
</dd></dl></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a><h3>listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#listenerCount">listenerCount</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:561</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns the number of listeners listening to the event named <code>eventName</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v3.2.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The name of the event being listened for</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a><h3>listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">listeners<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Function-1" class="tsd-signature-type" data-tsd-kind="Variable">Function</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#listeners">listeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:484</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">, (</span><span class="hl-3">stream</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">util</span><span class="hl-0">.</span><span class="hl-7">inspect</span><span class="hl-0">(</span><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">listeners</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">)));</span><br/><span class="hl-5">// Prints: [ [Function] ]</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Function-1" class="tsd-signature-type" data-tsd-kind="Variable">Function</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a><h3>off</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">off<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#off">off</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:444</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Alias for <code>emitter.removeListener()</code>.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v10.0.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="on" class="tsd-anchor"></a><h3>on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"close"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"connect"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"data"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"drain"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"end"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"lookup"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ready"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"timeout"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:324</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds the <code>listener</code> function to the end of the listeners array for the
|
|
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
times.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">, (</span><span class="hl-3">stream</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependListener()</code> method can be used as an alternative to add the
|
|
event listener to the beginning of the listeners array.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">myEE</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'a'</span><span class="hl-0">));</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">prependListener</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'b'</span><span class="hl-0">));</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
|
|
</code></pre>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:325</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"close"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hadError: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:326</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"connect"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:327</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"data"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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>data: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:328</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"drain"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:329</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"end"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:330</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"error"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on">on</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:331</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"lookup"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>address: <span class="tsd-signature-type">string</span></h5></li><li><h5>family: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li><h5>host: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.on</p><ul><li>Defined in node_modules/@types/node/net.d.ts:332</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ready"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.on</p><ul><li>Defined in node_modules/@types/node/net.d.ts:333</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"timeout"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="once" class="tsd-anchor"></a><h3>once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"close"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"connect"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"data"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"drain"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"end"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"lookup"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ready"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"timeout"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:334</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code>. The
|
|
next time <code>eventName</code> is triggered, this listener is removed and then invoked.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">, (</span><span class="hl-3">stream</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Ah, we have our first user!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
<p>By default, event listeners are invoked in the order they are added. The<code>emitter.prependOnceListener()</code> method can be used as an alternative to add the
|
|
event listener to the beginning of the listeners array.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">myEE</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'a'</span><span class="hl-0">));</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">prependOnceListener</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'b'</span><span class="hl-0">));</span><br/><span class="hl-3">myEE</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// b</span><br/><span class="hl-5">// a</span>
|
|
</code></pre>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:335</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"close"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hadError: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:336</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"connect"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:337</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"data"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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>data: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:338</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"drain"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:339</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"end"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:340</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"error"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once">once</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:341</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"lookup"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>address: <span class="tsd-signature-type">string</span></h5></li><li><h5>family: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li><h5>host: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.once</p><ul><li>Defined in node_modules/@types/node/net.d.ts:342</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ready"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.once</p><ul><li>Defined in node_modules/@types/node/net.d.ts:343</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"timeout"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="pause" class="tsd-anchor"></a><h3>pause</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">pause<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#pause">pause</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:128</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Pauses the reading of data. That is, <code>'data'</code> events will not be emitted.
|
|
Useful to throttle back an upload.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a id="pipe" class="tsd-anchor"></a><h3>pipe</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">pipe<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>destination<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#pipe">pipe</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:24</li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.WritableStream.html" class="tsd-signature-type" data-tsd-kind="Interface">WritableStream</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>destination: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <span class="tsd-signature-symbol">{ </span>end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-flag ts-flagOptional">Optional</span> end<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="prependListener" class="tsd-anchor"></a><h3>prepend<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"close"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"connect"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"data"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"drain"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"end"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"lookup"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ready"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"timeout"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:344</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds the <code>listener</code> function to the <em>beginning</em> of the listeners array for the
|
|
event named <code>eventName</code>. No checks are made to see if the <code>listener</code> has
|
|
already been added. Multiple calls passing the same combination of <code>eventName</code>and <code>listener</code> will result in the <code>listener</code> being added, and called, multiple
|
|
times.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">prependListener</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">, (</span><span class="hl-3">stream</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:345</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"close"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hadError: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:346</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"connect"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:347</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"data"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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>data: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:348</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"drain"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:349</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"end"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:350</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"error"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependListener">prependListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:351</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"lookup"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>address: <span class="tsd-signature-type">string</span></h5></li><li><h5>family: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li><h5>host: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.prependListener</p><ul><li>Defined in node_modules/@types/node/net.d.ts:352</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ready"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.prependListener</p><ul><li>Defined in node_modules/@types/node/net.d.ts:353</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"timeout"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="prependOnceListener" class="tsd-anchor"></a><h3>prepend<wbr/>Once<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"close"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"connect"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"data"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"drain"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"end"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"lookup"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"ready"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"timeout"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:354</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Adds a <strong>one-time</strong><code>listener</code> function for the event named <code>eventName</code> to the_beginning_ of the listeners array. The next time <code>eventName</code> is triggered, this
|
|
listener is removed, and then invoked.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">prependOnceListener</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">, (</span><span class="hl-3">stream</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Ah, we have our first user!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:355</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"close"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>hadError<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>hadError: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:356</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"connect"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:357</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"data"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a><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>data: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Buffer-1" class="tsd-signature-type" data-tsd-kind="Variable">Buffer</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:358</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"drain"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:359</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"end"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:360</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"error"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#prependOnceListener">prependOnceListener</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:361</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"lookup"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, family<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span>, host<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li><li><h5>address: <span class="tsd-signature-type">string</span></h5></li><li><h5>family: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li><h5>host: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.prependOnceListener</p><ul><li>Defined in node_modules/@types/node/net.d.ts:362</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"ready"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides stream.Duplex.prependOnceListener</p><ul><li>Defined in node_modules/@types/node/net.d.ts:363</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"timeout"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="push" class="tsd-anchor"></a><h3>push</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">push<span class="tsd-signature-symbol">(</span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, encoding<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#push">push</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:398</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>chunk: <span class="tsd-signature-type">any</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> encoding: <a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a><h3>raw<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">raw<wbr/>Listeners<span class="tsd-signature-symbol">(</span>eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Function-1" class="tsd-signature-type" data-tsd-kind="Variable">Function</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#rawListeners">rawListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:514</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>,
|
|
including any wrappers (such as those created by <code>.once()</code>).</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">emitter</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-4">'log'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'log once'</span><span class="hl-0">));</span><br/><br/><span class="hl-5">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-5">// `listener` which contains the original listener bound above</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">listeners</span><span class="hl-0"> = </span><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">rawListeners</span><span class="hl-0">(</span><span class="hl-4">'log'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">logFnWrapper</span><span class="hl-0"> = </span><span class="hl-3">listeners</span><span class="hl-0">[</span><span class="hl-8">0</span><span class="hl-0">];</span><br/><br/><span class="hl-5">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-3">logFnWrapper</span><span class="hl-0">.</span><span class="hl-7">listener</span><span class="hl-0">();</span><br/><br/><span class="hl-5">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-7">logFnWrapper</span><span class="hl-0">();</span><br/><br/><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'log'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'log persistently'</span><span class="hl-0">));</span><br/><span class="hl-5">// Will return a new Array with a single function bound by `.on()` above</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">newListeners</span><span class="hl-0"> = </span><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">rawListeners</span><span class="hl-0">(</span><span class="hl-4">'log'</span><span class="hl-0">);</span><br/><br/><span class="hl-5">// Logs "log persistently" twice</span><br/><span class="hl-3">newListeners</span><span class="hl-0">[</span><span class="hl-8">0</span><span class="hl-0">]();</span><br/><span class="hl-3">emitter</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'log'</span><span class="hl-0">);</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v9.4.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Function-1" class="tsd-signature-type" data-tsd-kind="Variable">Function</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="read" class="tsd-anchor"></a><h3>read</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">read<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#read">read</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:195</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The <code>readable.read()</code> method pulls some data out of the internal buffer and
|
|
returns it. If no data available to be read, <code>null</code> is returned. By default,
|
|
the data will be returned as a <code>Buffer</code> object unless an encoding has been
|
|
specified using the <code>readable.setEncoding()</code> method or the stream is operating
|
|
in object mode.</p>
|
|
</div><div><p>The optional <code>size</code> argument specifies a specific number of bytes to read. If<code>size</code> bytes are not available to be read, <code>null</code> will be returned _unless_the stream has ended, in which
|
|
case all of the data remaining in the internal
|
|
buffer will be returned.</p>
|
|
<p>If the <code>size</code> argument is not specified, all of the data contained in the
|
|
internal buffer will be returned.</p>
|
|
<p>The <code>size</code> argument must be less than or equal to 1 GiB.</p>
|
|
<p>The <code>readable.read()</code> method should only be called on <code>Readable</code> streams
|
|
operating in paused mode. In flowing mode, <code>readable.read()</code> is called
|
|
automatically until the internal buffer is fully drained.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">readable</span><span class="hl-0"> = </span><span class="hl-7">getReadableStreamSomehow</span><span class="hl-0">();</span><br/><br/><span class="hl-5">// 'readable' may be triggered multiple times as data is buffered in</span><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'readable'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-2">let</span><span class="hl-0"> </span><span class="hl-3">chunk</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Stream is readable (new data received in buffer)'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">// Use a loop to make sure we read all currently available data</span><br/><span class="hl-0"> </span><span class="hl-1">while</span><span class="hl-0"> (</span><span class="hl-2">null</span><span class="hl-0"> !== (</span><span class="hl-3">chunk</span><span class="hl-0"> = </span><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">read</span><span class="hl-0">())) {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">`Read </span><span class="hl-2">${</span><span class="hl-3">chunk</span><span class="hl-10">.</span><span class="hl-3">length</span><span class="hl-2">}</span><span class="hl-4"> bytes of data...`</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">// 'end' will be triggered once when there is no more data available</span><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'end'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Reached end of stream.'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
<p>Each call to <code>readable.read()</code> returns a chunk of data, or <code>null</code>. The chunks
|
|
are not concatenated. A <code>while</code> loop is necessary to consume all data
|
|
currently in the buffer. When reading a large file <code>.read()</code> may return <code>null</code>,
|
|
having consumed all buffered content so far, but there is still more data to
|
|
come not yet buffered. In this case a new <code>'readable'</code> event will be emitted
|
|
when there is more data in the buffer. Finally the <code>'end'</code> event will be
|
|
emitted when there is no more data to come.</p>
|
|
<p>Therefore to read a file's whole contents from a <code>readable</code>, it is necessary
|
|
to collect chunks across multiple <code>'readable'</code> events:</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">chunks</span><span class="hl-0"> = [];</span><br/><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'readable'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-2">let</span><span class="hl-0"> </span><span class="hl-3">chunk</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-1">while</span><span class="hl-0"> (</span><span class="hl-2">null</span><span class="hl-0"> !== (</span><span class="hl-3">chunk</span><span class="hl-0"> = </span><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">read</span><span class="hl-0">())) {</span><br/><span class="hl-0"> </span><span class="hl-3">chunks</span><span class="hl-0">.</span><span class="hl-7">push</span><span class="hl-0">(</span><span class="hl-3">chunk</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'end'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">content</span><span class="hl-0"> = </span><span class="hl-3">chunks</span><span class="hl-0">.</span><span class="hl-7">join</span><span class="hl-0">(</span><span class="hl-4">''</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
<p>A <code>Readable</code> stream in object mode will always return a single item from
|
|
a call to <code>readable.read(size)</code>, regardless of the value of the<code>size</code> argument.</p>
|
|
<p>If the <code>readable.read()</code> method returns a chunk of data, a <code>'data'</code> event will
|
|
also be emitted.</p>
|
|
<p>Calling <a href="_internal_.Socket.html#read">read</a> after the <code>'end'</code> event has
|
|
been emitted will return <code>null</code>. No runtime error will be raised.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.4</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> size: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional argument to specify how much data to read.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a id="ref" class="tsd-anchor"></a><h3>ref</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">ref<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:211</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Opposite of <code>unref()</code>, calling <code>ref()</code> on a previously <code>unref</code>ed socket will_not_ let the program exit if it's the only socket left (the default behavior).
|
|
If the socket is <code>ref</code>ed calling <code>ref</code> again will have no effect.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.1</p>
|
|
</dd></dl></div><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a><h3>remove<wbr/>All<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">remove<wbr/>All<wbr/>Listeners<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeAllListeners">removeAllListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:455</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
|
|
</div><div><p>It is bad practice to remove listeners added elsewhere in the code,
|
|
particularly when the <code>EventEmitter</code> instance was created by some other
|
|
component or module (e.g. sockets or file streams).</p>
|
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.26</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a><h3>remove<wbr/>Listener</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"close"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"data"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"end"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"error"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"pause"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"readable"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"resume"</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li><li class="tsd-signature tsd-kind-icon">remove<wbr/>Listener<span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, listener<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:471</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Removes the specified <code>listener</code> from the listener array for the event named<code>eventName</code>.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-7">callback</span><span class="hl-0"> = (</span><span class="hl-3">stream</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">};</span><br/><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">, </span><span class="hl-3">callback</span><span class="hl-0">);</span><br/><span class="hl-5">// ...</span><br/><span class="hl-3">server</span><span class="hl-0">.</span><span class="hl-7">removeListener</span><span class="hl-0">(</span><span class="hl-4">'connection'</span><span class="hl-0">, </span><span class="hl-3">callback</span><span class="hl-0">);</span>
|
|
</code></pre>
|
|
<p><code>removeListener()</code> will remove, at most, one instance of a listener from the
|
|
listener array. If any single listener has been added multiple times to the
|
|
listener array for the specified <code>eventName</code>, then <code>removeListener()</code> must be
|
|
called multiple times to remove each instance.</p>
|
|
<p>Once an event is emitted, all listeners attached to it at the
|
|
time of emitting are called in order. This implies that any<code>removeListener()</code> or <code>removeAllListeners()</code> calls <em>after</em> emitting and_before_ the last listener finishes execution will
|
|
not remove them from<code>emit()</code> in progress. Subsequent events behave as expected.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">myEmitter</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">MyEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-7">callbackA</span><span class="hl-0"> = () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'A'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">removeListener</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, </span><span class="hl-3">callbackB</span><span class="hl-0">);</span><br/><span class="hl-0">};</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-7">callbackB</span><span class="hl-0"> = () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'B'</span><span class="hl-0">);</span><br/><span class="hl-0">};</span><br/><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, </span><span class="hl-3">callbackA</span><span class="hl-0">);</span><br/><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, </span><span class="hl-3">callbackB</span><span class="hl-0">);</span><br/><br/><span class="hl-5">// callbackA removes listener callbackB but it will still be called.</span><br/><span class="hl-5">// Internal listener array at time of emit [callbackA, callbackB]</span><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span><br/><span class="hl-5">// B</span><br/><br/><span class="hl-5">// callbackB is now removed.</span><br/><span class="hl-5">// Internal listener array [callbackA]</span><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">);</span><br/><span class="hl-5">// Prints:</span><br/><span class="hl-5">// A</span>
|
|
</code></pre>
|
|
<p>Because listeners are managed using an internal array, calling this will
|
|
change the position indices of any listener registered <em>after</em> the listener
|
|
being removed. This will not impact the order in which listeners are called,
|
|
but it means that any copies of the listener array as returned by
|
|
the <code>emitter.listeners()</code> method will need to be recreated.</p>
|
|
<p>When a single function has been added as a handler multiple times for a single
|
|
event (as in the example below), <code>removeListener()</code> will remove the most
|
|
recently added instance. In the example the <code>once('ping')</code>listener is removed:</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">pong</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'pong'</span><span class="hl-0">);</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'ping'</span><span class="hl-0">, </span><span class="hl-3">pong</span><span class="hl-0">);</span><br/><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-4">'ping'</span><span class="hl-0">, </span><span class="hl-3">pong</span><span class="hl-0">);</span><br/><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">removeListener</span><span class="hl-0">(</span><span class="hl-4">'ping'</span><span class="hl-0">, </span><span class="hl-3">pong</span><span class="hl-0">);</span><br/><br/><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'ping'</span><span class="hl-0">);</span><br/><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'ping'</span><span class="hl-0">);</span>
|
|
</code></pre>
|
|
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"close"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:472</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"data"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">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>chunk: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:473</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"end"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:474</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"error"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:475</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"pause"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:476</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"readable"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:477</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">"resume"</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#removeListener">removeListener</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:478</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>event: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5>listener: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="resume" class="tsd-anchor"></a><h3>resume</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">resume<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#resume">resume</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:133</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Resumes reading after a call to <code>socket.pause()</code>.</p>
|
|
</div></div><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="setDefaultEncoding" class="tsd-anchor"></a><h3>set<wbr/>Default<wbr/>Encoding</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Default<wbr/>Encoding<span class="tsd-signature-symbol">(</span>encoding<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#setDefaultEncoding">setDefaultEncoding</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:855</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>encoding: <a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="setEncoding" class="tsd-anchor"></a><h3>set<wbr/>Encoding</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Encoding<span class="tsd-signature-symbol">(</span>encoding<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#setEncoding">setEncoding</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:122</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Set the encoding for the socket as a <code>Readable Stream</code>. See <code>readable.setEncoding()</code> for more information.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.90</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> encoding: <a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a id="setKeepAlive" class="tsd-anchor"></a><h3>set<wbr/>Keep<wbr/>Alive</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Keep<wbr/>Alive<span class="tsd-signature-symbol">(</span>enable<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, initialDelay<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:191</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Enable/disable keep-alive functionality, and optionally set the initial
|
|
delay before the first keepalive probe is sent on an idle socket.</p>
|
|
</div><div><p>Set <code>initialDelay</code> (in milliseconds) to set the delay between the last
|
|
data packet received and the first keepalive probe. Setting <code>0</code> for<code>initialDelay</code> will leave the value unchanged from the default
|
|
(or previous) setting.</p>
|
|
<p>Enabling the keep-alive functionality will set the following socket options:</p>
|
|
<ul>
|
|
<li><code>SO_KEEPALIVE=1</code></li>
|
|
<li><code>TCP_KEEPIDLE=initialDelay</code></li>
|
|
<li><code>TCP_KEEPCNT=10</code></li>
|
|
<li><code>TCP_KEEPINTVL=1</code></li>
|
|
</ul>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.92</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> enable: <span class="tsd-signature-type">boolean</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> initialDelay: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a><h3>set<wbr/>Max<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Max<wbr/>Listeners<span class="tsd-signature-symbol">(</span>n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#setMaxListeners">setMaxListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:465</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>By default <code>EventEmitter</code>s will print a warning if more than <code>10</code> listeners are
|
|
added for a particular event. This is a useful default that helps finding
|
|
memory leaks. The <code>emitter.setMaxListeners()</code> method allows the limit to be
|
|
modified for this specific <code>EventEmitter</code> instance. The value can be set to<code>Infinity</code> (or <code>0</code>) to indicate an unlimited number of listeners.</p>
|
|
</div><div><p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.3.5</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>n: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a id="setNoDelay" class="tsd-anchor"></a><h3>set<wbr/>No<wbr/>Delay</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>No<wbr/>Delay<span class="tsd-signature-symbol">(</span>noDelay<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:171</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Enable/disable the use of Nagle's algorithm.</p>
|
|
</div><div><p>When a TCP connection is created, it will have Nagle's algorithm enabled.</p>
|
|
<p>Nagle's algorithm delays data before it is sent via the network. It attempts
|
|
to optimize throughput at the expense of latency.</p>
|
|
<p>Passing <code>true</code> for <code>noDelay</code> or not passing an argument will disable Nagle's
|
|
algorithm for the socket. Passing <code>false</code> for <code>noDelay</code> will enable Nagle's
|
|
algorithm.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.90</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> noDelay: <span class="tsd-signature-type">boolean</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a id="setTimeout" class="tsd-anchor"></a><h3>set<wbr/>Timeout</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">set<wbr/>Timeout<span class="tsd-signature-symbol">(</span>timeout<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:155</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sets the socket to timeout after <code>timeout</code> milliseconds of inactivity on
|
|
the socket. By default <code>net.Socket</code> do not have a timeout.</p>
|
|
</div><div><p>When an idle timeout is triggered the socket will receive a <code>'timeout'</code> event but the connection will not be severed. The user must manually call <code>socket.end()</code> or <code>socket.destroy()</code> to
|
|
end the connection.</p>
|
|
<pre><code class="language-js"><span class="hl-3">socket</span><span class="hl-0">.</span><span class="hl-7">setTimeout</span><span class="hl-0">(</span><span class="hl-8">3000</span><span class="hl-0">);</span><br/><span class="hl-3">socket</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'timeout'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'socket timeout'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">socket</span><span class="hl-0">.</span><span class="hl-7">end</span><span class="hl-0">();</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
<p>If <code>timeout</code> is 0, then the existing idle timeout is disabled.</p>
|
|
<p>The optional <code>callback</code> parameter will be added as a one-time listener for the <code>'timeout'</code> event.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.90</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>timeout: <span class="tsd-signature-type">number</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="uncork" class="tsd-anchor"></a><h3>uncork</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">uncork<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#uncork">uncork</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:860</li></ul></aside><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="unpipe" class="tsd-anchor"></a><h3>unpipe</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">unpipe<span class="tsd-signature-symbol">(</span>destination<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_internal_.WritableStream.html" class="tsd-signature-type" data-tsd-kind="Interface">WritableStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#unpipe">unpipe</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:305</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The <code>readable.unpipe()</code> method detaches a <code>Writable</code> stream previously attached
|
|
using the <a href="_internal_.Socket.html#pipe">pipe</a> method.</p>
|
|
</div><div><p>If the <code>destination</code> is not specified, then <em>all</em> pipes are detached.</p>
|
|
<p>If the <code>destination</code> is specified, but no pipe is set up for it, then
|
|
the method does nothing.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">fs</span><span class="hl-0"> = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'fs'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">readable</span><span class="hl-0"> = </span><span class="hl-7">getReadableStreamSomehow</span><span class="hl-0">();</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">writable</span><span class="hl-0"> = </span><span class="hl-3">fs</span><span class="hl-0">.</span><span class="hl-7">createWriteStream</span><span class="hl-0">(</span><span class="hl-4">'file.txt'</span><span class="hl-0">);</span><br/><span class="hl-5">// All the data from readable goes into 'file.txt',</span><br/><span class="hl-5">// but only for the first second.</span><br/><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">pipe</span><span class="hl-0">(</span><span class="hl-3">writable</span><span class="hl-0">);</span><br/><span class="hl-7">setTimeout</span><span class="hl-0">(() </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Stop writing to file.txt.'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">readable</span><span class="hl-0">.</span><span class="hl-7">unpipe</span><span class="hl-0">(</span><span class="hl-3">writable</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Manually close the file stream.'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">writable</span><span class="hl-0">.</span><span class="hl-7">end</span><span class="hl-0">();</span><br/><span class="hl-0">}, </span><span class="hl-8">1000</span><span class="hl-0">);</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.4</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> destination: <a href="../interfaces/_internal_.WritableStream.html" class="tsd-signature-type" data-tsd-kind="Interface">WritableStream</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Optional specific stream to unpipe</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external"><a id="unref" class="tsd-anchor"></a><h3>unref</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external"><li class="tsd-signature tsd-kind-icon">unref<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in node_modules/@types/node/net.d.ts:204</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Calling <code>unref()</code> on a socket will allow the program to exit if this is the only
|
|
active socket in the event system. If the socket is already <code>unref</code>ed calling<code>unref()</code> again will have no effect.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.1</p>
|
|
</dd></dl></div><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4><div><p>The socket itself.</p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="unshift" class="tsd-anchor"></a><h3>unshift</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">unshift<span class="tsd-signature-symbol">(</span>chunk<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, encoding<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#unshift">unshift</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:371</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Passing <code>chunk</code> as <code>null</code> signals the end of the stream (EOF) and behaves the
|
|
same as <code>readable.push(null)</code>, after which no more data can be written. The EOF
|
|
signal is put at the end of the buffer and any buffered data will still be
|
|
flushed.</p>
|
|
</div><div><p>The <code>readable.unshift()</code> method pushes a chunk of data back into the internal
|
|
buffer. This is useful in certain situations where a stream is being consumed by
|
|
code that needs to "un-consume" some amount of data that it has optimistically
|
|
pulled out of the source, so that the data can be passed on to some other party.</p>
|
|
<p>The <code>stream.unshift(chunk)</code> method cannot be called after the <code>'end'</code> event
|
|
has been emitted or a runtime error will be thrown.</p>
|
|
<p>Developers using <code>stream.unshift()</code> often should consider switching to
|
|
use of a <code>Transform</code> stream instead. See the <code>API for stream implementers</code> section for more information.</p>
|
|
<pre><code class="language-js"><span class="hl-5">// Pull off a header delimited by \n\n.</span><br/><span class="hl-5">// Use unshift() if we get too much.</span><br/><span class="hl-5">// Call the callback with (error, header, stream).</span><br/><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">StringDecoder</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'string_decoder'</span><span class="hl-0">);</span><br/><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">parseHeader</span><span class="hl-0">(</span><span class="hl-3">stream</span><span class="hl-0">, </span><span class="hl-3">callback</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">stream</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'error'</span><span class="hl-0">, </span><span class="hl-3">callback</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">stream</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'readable'</span><span class="hl-0">, </span><span class="hl-3">onReadable</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">decoder</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">StringDecoder</span><span class="hl-0">(</span><span class="hl-4">'utf8'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">let</span><span class="hl-0"> </span><span class="hl-3">header</span><span class="hl-0"> = </span><span class="hl-4">''</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">onReadable</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-2">let</span><span class="hl-0"> </span><span class="hl-3">chunk</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-1">while</span><span class="hl-0"> (</span><span class="hl-2">null</span><span class="hl-0"> !== (</span><span class="hl-3">chunk</span><span class="hl-0"> = </span><span class="hl-3">stream</span><span class="hl-0">.</span><span class="hl-7">read</span><span class="hl-0">())) {</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">str</span><span class="hl-0"> = </span><span class="hl-3">decoder</span><span class="hl-0">.</span><span class="hl-7">write</span><span class="hl-0">(</span><span class="hl-3">chunk</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">if</span><span class="hl-0"> (</span><span class="hl-3">str</span><span class="hl-0">.</span><span class="hl-7">match</span><span class="hl-0">(</span><span class="hl-11">/\n\n/</span><span class="hl-0">)) {</span><br/><span class="hl-0"> </span><span class="hl-5">// Found the header boundary.</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">split</span><span class="hl-0"> = </span><span class="hl-3">str</span><span class="hl-0">.</span><span class="hl-7">split</span><span class="hl-0">(</span><span class="hl-11">/\n\n/</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">header</span><span class="hl-0"> += </span><span class="hl-3">split</span><span class="hl-0">.</span><span class="hl-7">shift</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">remaining</span><span class="hl-0"> = </span><span class="hl-3">split</span><span class="hl-0">.</span><span class="hl-7">join</span><span class="hl-0">(</span><span class="hl-4">'</span><span class="hl-12">\n\n</span><span class="hl-4">'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">buf</span><span class="hl-0"> = </span><span class="hl-3">Buffer</span><span class="hl-0">.</span><span class="hl-7">from</span><span class="hl-0">(</span><span class="hl-3">remaining</span><span class="hl-0">, </span><span class="hl-4">'utf8'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">stream</span><span class="hl-0">.</span><span class="hl-7">removeListener</span><span class="hl-0">(</span><span class="hl-4">'error'</span><span class="hl-0">, </span><span class="hl-3">callback</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">// Remove the 'readable' listener before unshifting.</span><br/><span class="hl-0"> </span><span class="hl-3">stream</span><span class="hl-0">.</span><span class="hl-7">removeListener</span><span class="hl-0">(</span><span class="hl-4">'readable'</span><span class="hl-0">, </span><span class="hl-3">onReadable</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-1">if</span><span class="hl-0"> (</span><span class="hl-3">buf</span><span class="hl-0">.</span><span class="hl-3">length</span><span class="hl-0">)</span><br/><span class="hl-0"> </span><span class="hl-3">stream</span><span class="hl-0">.</span><span class="hl-7">unshift</span><span class="hl-0">(</span><span class="hl-3">buf</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">// Now the body of the message can be read from the stream.</span><br/><span class="hl-0"> </span><span class="hl-7">callback</span><span class="hl-0">(</span><span class="hl-2">null</span><span class="hl-0">, </span><span class="hl-3">header</span><span class="hl-0">, </span><span class="hl-3">stream</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-1">else</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">// Still reading the header.</span><br/><span class="hl-0"> </span><span class="hl-3">header</span><span class="hl-0"> += </span><span class="hl-3">str</span><span class="hl-0">;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
|
|
</code></pre>
|
|
<p>Unlike <a href="_internal_.Socket.html#push">push</a>, <code>stream.unshift(chunk)</code> will not
|
|
end the reading process by resetting the internal reading state of the stream.
|
|
This can cause unexpected results if <code>readable.unshift()</code> is called during a
|
|
read (i.e. from within a <a href="_internal_.Socket.html#_read">_read</a> implementation on a
|
|
custom stream). Following the call to <code>readable.unshift()</code> with an immediate <a href="_internal_.Socket.html#push">push</a> will reset the reading state appropriately,
|
|
however it is best to simply avoid calling <code>readable.unshift()</code> while in the
|
|
process of performing a read.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.11</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>chunk: <span class="tsd-signature-type">any</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Chunk of data to unshift onto the read queue. For streams not operating in object mode, <code>chunk</code> must be a string, <code>Buffer</code>, <code>Uint8Array</code> or <code>null</code>. For object mode
|
|
streams, <code>chunk</code> may be any JavaScript value.</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> encoding: <a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Encoding of string chunks. Must be a valid <code>Buffer</code> encoding, such as <code>'utf8'</code> or <code>'ascii'</code>.</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a id="wrap" class="tsd-anchor"></a><h3>wrap</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><li class="tsd-signature tsd-kind-icon">wrap<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.ReadableStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#wrap">wrap</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:397</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Prior to Node.js 0.10, streams did not implement the entire <code>stream</code> module API
|
|
as it is currently defined. (See <code>Compatibility</code> for more information.)</p>
|
|
</div><div><p>When using an older Node.js library that emits <code>'data'</code> events and has a <a href="_internal_.Socket.html#pause">pause</a> method that is advisory only, the<code>readable.wrap()</code> method can be used to create a <code>Readable</code>
|
|
stream that uses
|
|
the old stream as its data source.</p>
|
|
<p>It will rarely be necessary to use <code>readable.wrap()</code> but the method has been
|
|
provided as a convenience for interacting with older Node.js applications and
|
|
libraries.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">OldReader</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'./old-api-module.js'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">Readable</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'stream'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">oreader</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">OldReader</span><span class="hl-0">();</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">myReader</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">Readable</span><span class="hl-0">().</span><span class="hl-7">wrap</span><span class="hl-0">(</span><span class="hl-3">oreader</span><span class="hl-0">);</span><br/><br/><span class="hl-3">myReader</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'readable'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">myReader</span><span class="hl-0">.</span><span class="hl-7">read</span><span class="hl-0">(); </span><span class="hl-5">// etc.</span><br/><span class="hl-0">});</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.4</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>stream: <a href="../interfaces/_internal_.ReadableStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableStream</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>An "old style" readable stream</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="_internal_.Socket.html" class="tsd-signature-type" data-tsd-kind="Class">Socket</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a id="write" class="tsd-anchor"></a><h3>write</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><li class="tsd-signature tsd-kind-icon">write<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a>, cb<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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">boolean</span></li><li class="tsd-signature tsd-kind-icon">write<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a>, encoding<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a>, cb<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#write">write</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:92</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Sends data on the socket. The second parameter specifies the encoding in the
|
|
case of a string. It defaults to UTF8 encoding.</p>
|
|
</div><div><p>Returns <code>true</code> if the entire data was flushed successfully to the kernel
|
|
buffer. Returns <code>false</code> if all or part of the data was queued in user memory.<code>'drain'</code> will be emitted when the buffer is again free.</p>
|
|
<p>The optional <code>callback</code> parameter will be executed when the data is finally
|
|
written out, which may not be immediately.</p>
|
|
<p>See <code>Writable</code> stream <code>write()</code> method for more
|
|
information.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.1.90</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>buffer: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></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">boolean</span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Overrides <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#write">write</a></p><ul><li>Defined in node_modules/@types/node/net.d.ts:93</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>str: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Uint8Array-1" class="tsd-signature-type" data-tsd-kind="Variable">Uint8Array</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> encoding: <a href="../modules/_internal_.html#BufferEncoding" class="tsd-signature-type" data-tsd-kind="Type alias">BufferEncoding</a></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> cb: <span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><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 tsd-is-external"><li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>err<span class="tsd-signature-symbol">?: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> err: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Error-1" class="tsd-signature-type" data-tsd-kind="Variable">Error</a></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">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="from" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> from</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">from<span class="tsd-signature-symbol">(</span>src<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Object-1" class="tsd-signature-type" data-tsd-kind="Variable">Object</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="_internal_.Stream-1.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.Iterable.html" class="tsd-signature-type" data-tsd-kind="Interface">Iterable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.AsyncIterable.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncIterable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.Blob.html" class="tsd-signature-type" data-tsd-kind="Interface">Blob</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#ArrayBuffer-1" class="tsd-signature-type" data-tsd-kind="Variable">ArrayBuffer</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.AsyncGeneratorFunction.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncGeneratorFunction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.internal.html" class="tsd-signature-type" data-tsd-kind="Namespace">internal</a><span class="tsd-signature-symbol">.</span><a href="_internal_.internal.Duplex.html" class="tsd-signature-type" data-tsd-kind="Class">Duplex</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#from">from</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:842</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A utility method for creating duplex streams.</p>
|
|
</div><div><ul>
|
|
<li><code>Stream</code> converts writable stream into writable <code>Duplex</code> and readable stream
|
|
to <code>Duplex</code>.</li>
|
|
<li><code>Blob</code> converts into readable <code>Duplex</code>.</li>
|
|
<li><code>string</code> converts into readable <code>Duplex</code>.</li>
|
|
<li><code>ArrayBuffer</code> converts into readable <code>Duplex</code>.</li>
|
|
<li><code>AsyncIterable</code> converts into a readable <code>Duplex</code>. Cannot yield <code>null</code>.</li>
|
|
<li><code>AsyncGeneratorFunction</code> converts into a readable/writable transform
|
|
<code>Duplex</code>. Must take a source <code>AsyncIterable</code> as first parameter. Cannot yield
|
|
<code>null</code>.</li>
|
|
<li><code>AsyncFunction</code> converts into a writable <code>Duplex</code>. Must return
|
|
either <code>null</code> or <code>undefined</code></li>
|
|
<li><code>Object ({ writable, readable })</code> converts <code>readable</code> and
|
|
<code>writable</code> into <code>Stream</code> and then combines them into <code>Duplex</code> where the
|
|
<code>Duplex</code> will write to the <code>writable</code> and read from the <code>readable</code>.</li>
|
|
<li><code>Promise</code> converts into readable <code>Duplex</code>. Value <code>null</code> is ignored.</li>
|
|
</ul>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v16.8.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>src: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Object-1" class="tsd-signature-type" data-tsd-kind="Variable">Object</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="_internal_.Stream-1.html" class="tsd-signature-type" data-tsd-kind="Class">Stream</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.Iterable.html" class="tsd-signature-type" data-tsd-kind="Interface">Iterable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.AsyncIterable.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncIterable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.Blob.html" class="tsd-signature-type" data-tsd-kind="Interface">Blob</a><span class="tsd-signature-symbol"> | </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#ArrayBuffer-1" class="tsd-signature-type" data-tsd-kind="Variable">ArrayBuffer</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.AsyncGeneratorFunction.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncGeneratorFunction</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.internal.html" class="tsd-signature-type" data-tsd-kind="Namespace">internal</a><span class="tsd-signature-symbol">.</span><a href="_internal_.internal.Duplex.html" class="tsd-signature-type" data-tsd-kind="Class">Duplex</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr/>Event<wbr/>Listeners</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">get<wbr/>Event<wbr/>Listeners<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.EventEmitter-2.html" class="tsd-signature-type" data-tsd-kind="Interface">EventEmitter</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.DOMEventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">DOMEventTarget</a>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Function-1" class="tsd-signature-type" data-tsd-kind="Variable">Function</a><span class="tsd-signature-symbol">[]</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#getEventListeners">getEventListeners</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:262</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
|
</div><div><p>For <code>EventEmitter</code>s this behaves exactly the same as calling <code>.listeners</code> on
|
|
the emitter.</p>
|
|
<p>For <code>EventTarget</code>s this is the only way to get the event listeners for the
|
|
event target. This is useful for debugging and diagnostic purposes.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">getEventListeners</span><span class="hl-0">, </span><span class="hl-6">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-7">listener</span><span class="hl-0"> = () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Events are fun'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">, </span><span class="hl-3">listener</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-7">getEventListeners</span><span class="hl-0">(</span><span class="hl-3">ee</span><span class="hl-0">, </span><span class="hl-4">'foo'</span><span class="hl-0">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-0">}</span><br/><span class="hl-0">{</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">et</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventTarget</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-7">listener</span><span class="hl-0"> = () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'Events are fun'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">et</span><span class="hl-0">.</span><span class="hl-7">addEventListener</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">, </span><span class="hl-3">listener</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-7">getEventListeners</span><span class="hl-0">(</span><span class="hl-3">et</span><span class="hl-0">, </span><span class="hl-4">'foo'</span><span class="hl-0">); </span><span class="hl-5">// [listener]</span><br/><span class="hl-0">}</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v15.2.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.EventEmitter-2.html" class="tsd-signature-type" data-tsd-kind="Interface">EventEmitter</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.DOMEventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">DOMEventTarget</a></h5></li><li><h5>name: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Function-1" class="tsd-signature-type" data-tsd-kind="Variable">Function</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="isDisturbed" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr/>Disturbed</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">is<wbr/>Disturbed<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="_internal_.Readable.html" class="tsd-signature-type" data-tsd-kind="Class">Readable</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.ReadableStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableStream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#isDisturbed">isDisturbed</a></p><ul><li>Defined in node_modules/@types/node/stream.d.ts:59</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Returns whether the stream has been read from or cancelled.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v16.8.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>stream: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="_internal_.Readable.html" class="tsd-signature-type" data-tsd-kind="Class">Readable</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_internal_.ReadableStream.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableStream</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="listenerCount-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> listener<wbr/>Count</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">listener<wbr/>Count<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.EventEmitter-2.html" class="tsd-signature-type" data-tsd-kind="Interface">EventEmitter</a>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#listenerCount-1">listenerCount</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:234</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
|
|
</div><div><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">EventEmitter</span><span class="hl-0">, </span><span class="hl-6">listenerCount</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'events'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">myEmitter</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><span class="hl-3">myEmitter</span><span class="hl-0">.</span><span class="hl-7">on</span><span class="hl-0">(</span><span class="hl-4">'event'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-7">listenerCount</span><span class="hl-0">(</span><span class="hl-3">myEmitter</span><span class="hl-0">, </span><span class="hl-4">'event'</span><span class="hl-0">));</span><br/><span class="hl-5">// Prints: 2</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v0.9.12</p>
|
|
</dd><dt>deprecated</dt><dd><p>Since v3.2.0 - Use <code>listenerCount</code> instead.</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.EventEmitter-2.html" class="tsd-signature-type" data-tsd-kind="Interface">EventEmitter</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The emitter to query</p>
|
|
</div></div></li><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The event name</p>
|
|
</div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="on-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> on</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">on<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.EventEmitter-2.html" class="tsd-signature-type" data-tsd-kind="Interface">EventEmitter</a>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_internal_.StaticEventEmitterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticEventEmitterOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.AsyncIterableIterator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncIterableIterator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#on-1">on</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:217</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>```js
|
|
const { on, EventEmitter } = require('events');</p>
|
|
</div><div><p>(async () => {
|
|
const ee = new EventEmitter();</p>
|
|
<p> // Emit later on
|
|
process.nextTick(() => {
|
|
ee.emit('foo', 'bar');
|
|
ee.emit('foo', 42);
|
|
});</p>
|
|
<p> for await (const event of on(ee, 'foo')) {
|
|
// The execution of this inner block is synchronous and it
|
|
// processes one event at a time (even with await). Do not use
|
|
// if concurrent execution is required.
|
|
console.log(event); // prints ['bar'] [42]
|
|
}
|
|
// Unreachable here
|
|
})();</p>
|
|
<pre><code><br/><span class="hl-3">Returns</span><span class="hl-0"> </span><span class="hl-3">an</span><span class="hl-0"> </span><span class="hl-4">`AsyncIterator`</span><span class="hl-0"> </span><span class="hl-3">that</span><span class="hl-0"> </span><span class="hl-3">iterates</span><span class="hl-0"> </span><span class="hl-4">`eventName`</span><span class="hl-0"> </span><span class="hl-3">events</span><span class="hl-0">. </span><span class="hl-3">It</span><span class="hl-0"> </span><span class="hl-3">will</span><span class="hl-0"> </span><span class="hl-1">throw</span><br/><span class="hl-1">if</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-4">`EventEmitter`</span><span class="hl-0"> </span><span class="hl-3">emits</span><span class="hl-0"> </span><span class="hl-4">`'error'`</span><span class="hl-0">. </span><span class="hl-3">It</span><span class="hl-0"> </span><span class="hl-3">removes</span><span class="hl-0"> </span><span class="hl-3">all</span><span class="hl-0"> </span><span class="hl-3">listeners</span><span class="hl-0"> </span><span class="hl-3">when</span><br/><span class="hl-3">exiting</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">loop</span><span class="hl-0">. </span><span class="hl-3">The</span><span class="hl-0"> </span><span class="hl-4">`value`</span><span class="hl-0"> </span><span class="hl-3">returned</span><span class="hl-0"> </span><span class="hl-3">by</span><span class="hl-0"> </span><span class="hl-3">each</span><span class="hl-0"> </span><span class="hl-3">iteration</span><span class="hl-0"> </span><span class="hl-3">is</span><span class="hl-0"> </span><span class="hl-3">an</span><span class="hl-0"> </span><span class="hl-3">array</span><br/><span class="hl-3">composed</span><span class="hl-0"> </span><span class="hl-2">of</span><span class="hl-0"> </span><span class="hl-3">the</span><span class="hl-0"> </span><span class="hl-3">emitted</span><span class="hl-0"> </span><span class="hl-3">event</span><span class="hl-0"> </span><span class="hl-2">arguments</span><span class="hl-0">.</span><br/><br/><span class="hl-3">An</span><span class="hl-0"> </span><span class="hl-4">`AbortSignal`</span><span class="hl-0"> </span><span class="hl-3">can</span><span class="hl-0"> </span><span class="hl-3">be</span><span class="hl-0"> </span><span class="hl-3">used</span><span class="hl-0"> </span><span class="hl-3">to</span><span class="hl-0"> </span><span class="hl-3">cancel</span><span class="hl-0"> </span><span class="hl-3">waiting</span><span class="hl-0"> </span><span class="hl-3">on</span><span class="hl-0"> </span><span class="hl-13">events</span><span class="hl-0">:</span><br/><br/><span class="hl-4">```js</span><br/><span class="hl-4">const { on, EventEmitter } = require('events');</span><br/><span class="hl-4">const ac = new AbortController();</span><br/><br/><span class="hl-4">(async () => {</span><br/><span class="hl-4"> const ee = new EventEmitter();</span><br/><br/><span class="hl-4"> // Emit later on</span><br/><span class="hl-4"> process.nextTick(() => {</span><br/><span class="hl-4"> ee.emit('foo', 'bar');</span><br/><span class="hl-4"> ee.emit('foo', 42);</span><br/><span class="hl-4"> });</span><br/><br/><span class="hl-4"> for await (const event of on(ee, 'foo', { signal: ac.signal })) {</span><br/><span class="hl-4"> // The execution of this inner block is synchronous and it</span><br/><span class="hl-4"> // processes one event at a time (even with await). Do not use</span><br/><span class="hl-4"> // if concurrent execution is required.</span><br/><span class="hl-4"> console.log(event); // prints ['bar'] [42]</span><br/><span class="hl-4"> }</span><br/><span class="hl-4"> // Unreachable here</span><br/><span class="hl-4">})();</span><br/><br/><span class="hl-4">process.nextTick(() => ac.abort());</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v13.6.0, v12.16.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_internal_.EventEmitter-2.html" class="tsd-signature-type" data-tsd-kind="Interface">EventEmitter</a></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The name of the event being listened for</p>
|
|
</div></div></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_internal_.StaticEventEmitterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticEventEmitterOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../interfaces/_internal_.AsyncIterableIterator.html" class="tsd-signature-type" data-tsd-kind="Interface">AsyncIterableIterator</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><div><p>that iterates <code>eventName</code> events emitted by the <code>emitter</code></p>
|
|
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a id="once-1" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagStatic">Static</span> once</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.NodeEventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">NodeEventTarget</a>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_internal_.StaticEventEmitterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticEventEmitterOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li><li class="tsd-signature tsd-kind-icon">once<span class="tsd-signature-symbol">(</span>emitter<span class="tsd-signature-symbol">: </span><a href="../interfaces/_internal_.DOMEventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">DOMEventTarget</a>, eventName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_internal_.StaticEventEmitterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticEventEmitterOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once-1">once</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:157</li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Creates a <code>Promise</code> that is fulfilled when the <code>EventEmitter</code> emits the given
|
|
event or that is rejected if the <code>EventEmitter</code> emits <code>'error'</code> while waiting.
|
|
The <code>Promise</code> will resolve with an array of all the arguments emitted to the
|
|
given event.</p>
|
|
</div><div><p>This method is intentionally generic and works with the web platform <a href="https://dom.spec.whatwg.org/#interface-eventtarget">EventTarget</a> interface, which has no special<code>'error'</code> event
|
|
semantics and does not listen to the <code>'error'</code> event.</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">once</span><span class="hl-0">, </span><span class="hl-6">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-2">async</span><span class="hl-0"> </span><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">run</span><span class="hl-0">() {</span><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-0"> </span><span class="hl-3">process</span><span class="hl-0">.</span><span class="hl-7">nextTick</span><span class="hl-0">(() </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'myevent'</span><span class="hl-0">, </span><span class="hl-8">42</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> [</span><span class="hl-6">value</span><span class="hl-0">] = </span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-3">ee</span><span class="hl-0">, </span><span class="hl-4">'myevent'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-3">value</span><span class="hl-0">);</span><br/><br/><span class="hl-0"> </span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">err</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-9">Error</span><span class="hl-0">(</span><span class="hl-4">'kaboom'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-3">process</span><span class="hl-0">.</span><span class="hl-7">nextTick</span><span class="hl-0">(() </span><span class="hl-2">=></span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'error'</span><span class="hl-0">, </span><span class="hl-3">err</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-1">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-3">ee</span><span class="hl-0">, </span><span class="hl-4">'myevent'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-1">catch</span><span class="hl-0"> (</span><span class="hl-3">err</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'error happened'</span><span class="hl-0">, </span><span class="hl-3">err</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-7">run</span><span class="hl-0">();</span>
|
|
</code></pre>
|
|
<p>The special handling of the <code>'error'</code> event is only used when <code>events.once()</code>is used to wait for another event. If <code>events.once()</code> is used to wait for the
|
|
'<code>error'</code> event itself, then it is treated as any other kind of event without
|
|
special handling:</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">EventEmitter</span><span class="hl-0">, </span><span class="hl-6">once</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-3">ee</span><span class="hl-0">, </span><span class="hl-4">'error'</span><span class="hl-0">)</span><br/><span class="hl-0"> .</span><span class="hl-7">then</span><span class="hl-0">(([</span><span class="hl-3">err</span><span class="hl-0">]) </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'ok'</span><span class="hl-0">, </span><span class="hl-3">err</span><span class="hl-0">.</span><span class="hl-3">message</span><span class="hl-0">))</span><br/><span class="hl-0"> .</span><span class="hl-7">catch</span><span class="hl-0">((</span><span class="hl-3">err</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'error'</span><span class="hl-0">, </span><span class="hl-3">err</span><span class="hl-0">.</span><span class="hl-3">message</span><span class="hl-0">));</span><br/><br/><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'error'</span><span class="hl-0">, </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-9">Error</span><span class="hl-0">(</span><span class="hl-4">'boom'</span><span class="hl-0">));</span><br/><br/><span class="hl-5">// Prints: ok boom</span>
|
|
</code></pre>
|
|
<p>An <code>AbortSignal</code> can be used to cancel waiting for the event:</p>
|
|
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-6">EventEmitter</span><span class="hl-0">, </span><span class="hl-6">once</span><span class="hl-0"> } = </span><span class="hl-7">require</span><span class="hl-0">(</span><span class="hl-4">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-6">ac</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-7">AbortController</span><span class="hl-0">();</span><br/><br/><span class="hl-2">async</span><span class="hl-0"> </span><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-7">foo</span><span class="hl-0">(</span><span class="hl-3">emitter</span><span class="hl-0">, </span><span class="hl-3">event</span><span class="hl-0">, </span><span class="hl-3">signal</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-1">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-1">await</span><span class="hl-0"> </span><span class="hl-7">once</span><span class="hl-0">(</span><span class="hl-3">emitter</span><span class="hl-0">, </span><span class="hl-3">event</span><span class="hl-0">, { </span><span class="hl-3">signal</span><span class="hl-0"> });</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">log</span><span class="hl-0">(</span><span class="hl-4">'event emitted!'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-1">catch</span><span class="hl-0"> (</span><span class="hl-3">error</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-1">if</span><span class="hl-0"> (</span><span class="hl-3">error</span><span class="hl-0">.</span><span class="hl-3">name</span><span class="hl-0"> === </span><span class="hl-4">'AbortError'</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">error</span><span class="hl-0">(</span><span class="hl-4">'Waiting for the event was canceled!'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-1">else</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">console</span><span class="hl-0">.</span><span class="hl-7">error</span><span class="hl-0">(</span><span class="hl-4">'There was an error'</span><span class="hl-0">, </span><span class="hl-3">error</span><span class="hl-0">.</span><span class="hl-3">message</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-7">foo</span><span class="hl-0">(</span><span class="hl-3">ee</span><span class="hl-0">, </span><span class="hl-4">'foo'</span><span class="hl-0">, </span><span class="hl-3">ac</span><span class="hl-0">.</span><span class="hl-3">signal</span><span class="hl-0">);</span><br/><span class="hl-3">ac</span><span class="hl-0">.</span><span class="hl-7">abort</span><span class="hl-0">(); </span><span class="hl-5">// Abort waiting for the event</span><br/><span class="hl-3">ee</span><span class="hl-0">.</span><span class="hl-7">emit</span><span class="hl-0">(</span><span class="hl-4">'foo'</span><span class="hl-0">); </span><span class="hl-5">// Prints: Waiting for the event was canceled!</span>
|
|
</code></pre>
|
|
</div><dl class="tsd-comment-tags"><dt>since</dt><dd><p>v11.13.0, v10.16.0</p>
|
|
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <a href="../interfaces/_internal_.NodeEventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">NodeEventTarget</a></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_internal_.StaticEventEmitterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticEventEmitterOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li><li class="tsd-description"><aside class="tsd-sources"><p>Inherited from <a href="_internal_.internal.Duplex.html">Duplex</a>.<a href="_internal_.internal.Duplex.html#once-1">once</a></p><ul><li>Defined in node_modules/@types/node/events.d.ts:158</li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>emitter: <a href="../interfaces/_internal_.DOMEventTarget.html" class="tsd-signature-type" data-tsd-kind="Interface">DOMEventTarget</a></h5></li><li><h5>eventName: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_internal_.StaticEventEmitterOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticEventEmitterOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="../modules/_internal_.html" class="tsd-signature-type" data-tsd-kind="Namespace"><internal></a><span class="tsd-signature-symbol">.</span><a href="../modules/_internal_.html#Promise-1" class="tsd-signature-type" data-tsd-kind="Variable">Promise</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/_internal_.html"><internal></a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_consumers_.html">"node:stream/consumers"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_._node_stream_promises_.html">"node:stream/promises"</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.EventEmitter.html">Event<wbr/>Emitter</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace tsd-is-external"><a href="../modules/_internal_.internal.html">internal</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace tsd-is-external"><a href="_internal_.Socket.html" class="tsd-kind-icon">Socket</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#allowHalfOpen" class="tsd-kind-icon">allow<wbr/>Half<wbr/>Open</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#bufferSize" class="tsd-kind-icon">buffer<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#bytesRead" class="tsd-kind-icon">bytes<wbr/>Read</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#bytesWritten" class="tsd-kind-icon">bytes<wbr/>Written</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#connecting" class="tsd-kind-icon">connecting</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#destroyed" class="tsd-kind-icon">destroyed</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#localAddress" class="tsd-kind-icon">local<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#localPort" class="tsd-kind-icon">local<wbr/>Port</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readable" class="tsd-kind-icon">readable</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableAborted" class="tsd-kind-icon">readable<wbr/>Aborted</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableDidRead" class="tsd-kind-icon">readable<wbr/>Did<wbr/>Read</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableEncoding" class="tsd-kind-icon">readable<wbr/>Encoding</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableEnded" class="tsd-kind-icon">readable<wbr/>Ended</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableFlowing" class="tsd-kind-icon">readable<wbr/>Flowing</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableHighWaterMark" class="tsd-kind-icon">readable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableLength" class="tsd-kind-icon">readable<wbr/>Length</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#readableObjectMode" class="tsd-kind-icon">readable<wbr/>Object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#remoteAddress" class="tsd-kind-icon">remote<wbr/>Address</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#remoteFamily" class="tsd-kind-icon">remote<wbr/>Family</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#remotePort" class="tsd-kind-icon">remote<wbr/>Port</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writable" class="tsd-kind-icon">writable</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableCorked" class="tsd-kind-icon">writable<wbr/>Corked</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableEnded" class="tsd-kind-icon">writable<wbr/>Ended</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableFinished" class="tsd-kind-icon">writable<wbr/>Finished</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableHighWaterMark" class="tsd-kind-icon">writable<wbr/>High<wbr/>Water<wbr/>Mark</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableLength" class="tsd-kind-icon">writable<wbr/>Length</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#writableObjectMode" class="tsd-kind-icon">writable<wbr/>Object<wbr/>Mode</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#captureRejectionSymbol" class="tsd-kind-icon">capture<wbr/>Rejection<wbr/>Symbol</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#captureRejections" class="tsd-kind-icon">capture<wbr/>Rejections</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#defaultMaxListeners" class="tsd-kind-icon">default<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#errorMonitor" class="tsd-kind-icon">error<wbr/>Monitor</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_asyncIterator_" class="tsd-kind-icon">[async<wbr/>Iterator]</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_construct" class="tsd-kind-icon">_construct</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_destroy" class="tsd-kind-icon">_destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_final" class="tsd-kind-icon">_final</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_read" class="tsd-kind-icon">_read</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_write" class="tsd-kind-icon">_write</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#_writev" class="tsd-kind-icon">_writev</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#addListener" class="tsd-kind-icon">add<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#address" class="tsd-kind-icon">address</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#connect" class="tsd-kind-icon">connect</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#cork" class="tsd-kind-icon">cork</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#destroy" class="tsd-kind-icon">destroy</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#emit" class="tsd-kind-icon">emit</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#end" class="tsd-kind-icon">end</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#eventNames" class="tsd-kind-icon">event<wbr/>Names</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#getMaxListeners" class="tsd-kind-icon">get<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#isPaused" class="tsd-kind-icon">is<wbr/>Paused</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#listenerCount" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#listeners" class="tsd-kind-icon">listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#off" class="tsd-kind-icon">off</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#on" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#once" class="tsd-kind-icon">once</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#pause" class="tsd-kind-icon">pause</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#pipe" class="tsd-kind-icon">pipe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#prependListener" class="tsd-kind-icon">prepend<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#prependOnceListener" class="tsd-kind-icon">prepend<wbr/>Once<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#push" class="tsd-kind-icon">push</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#rawListeners" class="tsd-kind-icon">raw<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#read" class="tsd-kind-icon">read</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#ref" class="tsd-kind-icon">ref</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#removeAllListeners" class="tsd-kind-icon">remove<wbr/>All<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#removeListener" class="tsd-kind-icon">remove<wbr/>Listener</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#resume" class="tsd-kind-icon">resume</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#setDefaultEncoding" class="tsd-kind-icon">set<wbr/>Default<wbr/>Encoding</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#setEncoding" class="tsd-kind-icon">set<wbr/>Encoding</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#setKeepAlive" class="tsd-kind-icon">set<wbr/>Keep<wbr/>Alive</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#setMaxListeners" class="tsd-kind-icon">set<wbr/>Max<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#setNoDelay" class="tsd-kind-icon">set<wbr/>No<wbr/>Delay</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#setTimeout" class="tsd-kind-icon">set<wbr/>Timeout</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#uncork" class="tsd-kind-icon">uncork</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#unpipe" class="tsd-kind-icon">unpipe</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="_internal_.Socket.html#unref" class="tsd-kind-icon">unref</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#unshift" class="tsd-kind-icon">unshift</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-external"><a href="_internal_.Socket.html#wrap" class="tsd-kind-icon">wrap</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-external"><a href="_internal_.Socket.html#write" class="tsd-kind-icon">write</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#from" class="tsd-kind-icon">from</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#getEventListeners" class="tsd-kind-icon">get<wbr/>Event<wbr/>Listeners</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#isDisturbed" class="tsd-kind-icon">is<wbr/>Disturbed</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#listenerCount-1" class="tsd-kind-icon">listener<wbr/>Count</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#on-1" class="tsd-kind-icon">on</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static tsd-is-external"><a href="_internal_.Socket.html#once-1" class="tsd-kind-icon">once</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-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul></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> |