mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
4044 lines
482 KiB
HTML
4044 lines
482 KiB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SliceStream | Community Solid Server - v7.0.1</title><meta name="description" content="Documentation for Community Solid Server"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><link rel="stylesheet" href="../assets/custom.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
|
||
<div class="tsd-toolbar-contents container">
|
||
<div class="table-cell" id="tsd-search" data-base="..">
|
||
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
|
||
<div class="field">
|
||
<div id="tsd-toolbar-links"></div></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">Community Solid Server - v7.0.1</a></div>
|
||
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
|
||
<div class="container container-main">
|
||
<div class="col-content">
|
||
<div class="tsd-page-title">
|
||
<ul class="tsd-breadcrumb">
|
||
<li><a href="../modules.html">Community Solid Server</a></li>
|
||
<li><a href="SliceStream.html">SliceStream</a></li></ul>
|
||
<h1>Class SliceStream</h1></div>
|
||
<section class="tsd-panel tsd-comment">
|
||
<div class="tsd-comment tsd-typography"><p>A stream that slices a part out of another stream.
|
||
<code>start</code> and <code>end</code> are inclusive.
|
||
If <code>end</code> is not defined it is until the end of the stream.</p>
|
||
<p>Negative <code>start</code> values can be used to instead slice that many streams off the end of the stream.
|
||
This requires the <code>size</code> field to be defined.</p>
|
||
<p>Both object and non-object streams are supported.
|
||
This needs to be explicitly specified,
|
||
as the class makes no assumptions based on the object mode of the source stream.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></section>
|
||
<section class="tsd-panel tsd-hierarchy">
|
||
<h4>Hierarchy</h4>
|
||
<ul class="tsd-hierarchy">
|
||
<li><span class="tsd-signature-type ">Transform</span>
|
||
<ul class="tsd-hierarchy">
|
||
<li><span class="target">SliceStream</span></li></ul></li></ul></section><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L24">src/util/SliceStream.ts:24</a></li></ul></aside>
|
||
<section class="tsd-panel-group tsd-index-group">
|
||
<section class="tsd-panel tsd-index-panel">
|
||
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
||
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary>
|
||
<div class="tsd-accordion-details">
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Constructors</h3>
|
||
<div class="tsd-index-list"><a href="SliceStream.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Properties</h3>
|
||
<div class="tsd-index-list"><a href="SliceStream.html#allowHalfOpen" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>allow<wbr/>Half<wbr/>Open</span></a>
|
||
<a href="SliceStream.html#closed" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>closed</span></a>
|
||
<a href="SliceStream.html#destroyed" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>destroyed</span></a>
|
||
<a href="SliceStream.html#errored" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>errored</span></a>
|
||
<a href="SliceStream.html#readable" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable</span></a>
|
||
<a href="SliceStream.html#readableAborted" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Aborted</span></a>
|
||
<a href="SliceStream.html#readableDidRead" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Did<wbr/>Read</span></a>
|
||
<a href="SliceStream.html#readableEncoding" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Encoding</span></a>
|
||
<a href="SliceStream.html#readableEnded" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Ended</span></a>
|
||
<a href="SliceStream.html#readableFlowing" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Flowing</span></a>
|
||
<a href="SliceStream.html#readableHighWaterMark" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>High<wbr/>Water<wbr/>Mark</span></a>
|
||
<a href="SliceStream.html#readableLength" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Length</span></a>
|
||
<a href="SliceStream.html#readableObjectMode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Object<wbr/>Mode</span></a>
|
||
<a href="SliceStream.html#remainingRead" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>remaining<wbr/>Read</span></a>
|
||
<a href="SliceStream.html#remainingSkip" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>remaining<wbr/>Skip</span></a>
|
||
<a href="SliceStream.html#source" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>source</span></a>
|
||
<a href="SliceStream.html#writable" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable</span></a>
|
||
<a href="SliceStream.html#writableCorked" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Corked</span></a>
|
||
<a href="SliceStream.html#writableEnded" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Ended</span></a>
|
||
<a href="SliceStream.html#writableFinished" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Finished</span></a>
|
||
<a href="SliceStream.html#writableHighWaterMark" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>High<wbr/>Water<wbr/>Mark</span></a>
|
||
<a href="SliceStream.html#writableLength" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Length</span></a>
|
||
<a href="SliceStream.html#writableNeedDrain" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Need<wbr/>Drain</span></a>
|
||
<a href="SliceStream.html#writableObjectMode" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Object<wbr/>Mode</span></a>
|
||
<a href="SliceStream.html#captureRejectionSymbol" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a>
|
||
<a href="SliceStream.html#captureRejections" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>capture<wbr/>Rejections</span></a>
|
||
<a href="SliceStream.html#defaultMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#errorMonitor" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>error<wbr/>Monitor</span></a>
|
||
</div></section>
|
||
<section class="tsd-index-section">
|
||
<h3 class="tsd-index-heading">Methods</h3>
|
||
<div class="tsd-index-list"><a href="SliceStream.html#_asyncDispose_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>[async<wbr/>Dispose]</span></a>
|
||
<a href="SliceStream.html#_asyncIterator_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>[async<wbr/>Iterator]</span></a>
|
||
<a href="SliceStream.html#_captureRejectionSymbol_" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>[capture<wbr/>Rejection<wbr/>Symbol]?</span></a>
|
||
<a href="SliceStream.html#_construct" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_construct?</span></a>
|
||
<a href="SliceStream.html#_destroy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_destroy</span></a>
|
||
<a href="SliceStream.html#_final" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_final</span></a>
|
||
<a href="SliceStream.html#_flush" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_flush</span></a>
|
||
<a href="SliceStream.html#_read" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_read</span></a>
|
||
<a href="SliceStream.html#_transform" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_transform</span></a>
|
||
<a href="SliceStream.html#_write" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_write</span></a>
|
||
<a href="SliceStream.html#_writev" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_writev?</span></a>
|
||
<a href="SliceStream.html#addListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Listener</span></a>
|
||
<a href="SliceStream.html#asIndexedPairs" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>as<wbr/>Indexed<wbr/>Pairs</span></a>
|
||
<a href="SliceStream.html#binarySlice" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>binary<wbr/>Slice</span></a>
|
||
<a href="SliceStream.html#checkEnd" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>End</span></a>
|
||
<a href="SliceStream.html#compose" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compose</span></a>
|
||
<a href="SliceStream.html#cork" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cork</span></a>
|
||
<a href="SliceStream.html#destroy" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a>
|
||
<a href="SliceStream.html#drop" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>drop</span></a>
|
||
<a href="SliceStream.html#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a>
|
||
<a href="SliceStream.html#end" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>end</span></a>
|
||
<a href="SliceStream.html#eventNames" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>event<wbr/>Names</span></a>
|
||
<a href="SliceStream.html#every" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>every</span></a>
|
||
<a href="SliceStream.html#filter" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>filter</span></a>
|
||
<a href="SliceStream.html#find" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>find</span></a>
|
||
<a href="SliceStream.html#flatMap" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flat<wbr/>Map</span></a>
|
||
<a href="SliceStream.html#forEach" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>for<wbr/>Each</span></a>
|
||
<a href="SliceStream.html#getMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#isPaused" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Paused</span></a>
|
||
<a href="SliceStream.html#iterator" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterator</span></a>
|
||
<a href="SliceStream.html#listenerCount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
||
<a href="SliceStream.html#listeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a>
|
||
<a href="SliceStream.html#map" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>map</span></a>
|
||
<a href="SliceStream.html#objectSlice" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>object<wbr/>Slice</span></a>
|
||
<a href="SliceStream.html#off" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a>
|
||
<a href="SliceStream.html#on" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
|
||
<a href="SliceStream.html#once" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a>
|
||
<a href="SliceStream.html#pause" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a>
|
||
<a href="SliceStream.html#pipe" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pipe</span></a>
|
||
<a href="SliceStream.html#prependListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Listener</span></a>
|
||
<a href="SliceStream.html#prependOnceListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a>
|
||
<a href="SliceStream.html#push" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>push</span></a>
|
||
<a href="SliceStream.html#rawListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>raw<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#read" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>read</span></a>
|
||
<a href="SliceStream.html#reduce" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reduce</span></a>
|
||
<a href="SliceStream.html#removeAllListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#removeListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a>
|
||
<a href="SliceStream.html#resume" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>resume</span></a>
|
||
<a href="SliceStream.html#setDefaultEncoding" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Encoding</span></a>
|
||
<a href="SliceStream.html#setEncoding" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Encoding</span></a>
|
||
<a href="SliceStream.html#setMaxListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#some" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>some</span></a>
|
||
<a href="SliceStream.html#take" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>take</span></a>
|
||
<a href="SliceStream.html#toArray" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>Array</span></a>
|
||
<a href="SliceStream.html#uncork" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>uncork</span></a>
|
||
<a href="SliceStream.html#unpipe" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unpipe</span></a>
|
||
<a href="SliceStream.html#unshift" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unshift</span></a>
|
||
<a href="SliceStream.html#wrap" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>wrap</span></a>
|
||
<a href="SliceStream.html#write" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>write</span></a>
|
||
<a href="SliceStream.html#addAbortListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Abort<wbr/>Listener</span></a>
|
||
<a href="SliceStream.html#from" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from</span></a>
|
||
<a href="SliceStream.html#fromWeb" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Web</span></a>
|
||
<a href="SliceStream.html#getEventListeners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Event<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#getMaxListeners-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#isDisturbed" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Disturbed</span></a>
|
||
<a href="SliceStream.html#listenerCount-2" class="tsd-index-link deprecated tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
||
<a href="SliceStream.html#on-13" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
|
||
<a href="SliceStream.html#once-13" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a>
|
||
<a href="SliceStream.html#setMaxListeners-2" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a>
|
||
<a href="SliceStream.html#toWeb" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>Web</span></a>
|
||
</div></section></div></details></section></section>
|
||
<section class="tsd-panel-group tsd-member-group">
|
||
<h2>Constructors</h2>
|
||
<section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures">
|
||
<li class="tsd-signature tsd-anchor-link" id="constructor.new_SliceStream"><span class="tsd-kind-constructor-signature">new <wbr/>Slice<wbr/>Stream</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#constructor.new_SliceStream" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">source</span>: <span class="tsd-signature-type ">Readable</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/SliceStreamOptions.html" class="tsd-signature-type tsd-kind-interface">SliceStreamOptions</a></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Overrides Transform.constructor</p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L29">src/util/SliceStream.ts:29</a></li></ul></aside></li></ul></section></section>
|
||
<section class="tsd-panel-group tsd-member-group">
|
||
<h2>Properties</h2>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="allowHalfOpen" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>allow<wbr/>Half<wbr/>Open</span><a href="#allowHalfOpen" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">allow<wbr/>Half<wbr/>Open</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<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>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.4</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.allowHalfOpen</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1060</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="closed" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>closed</span><a href="#closed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">closed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.closed</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1049</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="destroyed" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>destroyed</span><a href="#destroyed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">destroyed</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Is <code>true</code> after <code>readable.destroy()</code> has been called.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v8.0.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.destroyed</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:145</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="errored" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>errored</span><a href="#errored" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">errored</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.errored</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1050</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readable" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>readable</span><a href="#readable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v11.4.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readable</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:101</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableAborted" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <code class="tsd-tag ts-flagExperimental">Experimental</code> <span>readable<wbr/>Aborted</span><a href="#readableAborted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>Aborted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Returns whether the stream was destroyed or errored before emitting <code>'end'</code>.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v16.8.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableAborted</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:95</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableDidRead" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <code class="tsd-tag ts-flagExperimental">Experimental</code> <span>readable<wbr/>Did<wbr/>Read</span><a href="#readableDidRead" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>Did<wbr/>Read</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Returns whether <code>'data'</code> has been emitted.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v16.7.0, v14.18.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableDidRead</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:107</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableEncoding" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readable<wbr/>Encoding</span><a href="#readableEncoding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>Encoding</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">BufferEncoding</span></div>
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v12.7.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableEncoding</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:112</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableEnded" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readable<wbr/>Ended</span><a href="#readableEnded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>Ended</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Becomes <code>true</code> when <code>'end'</code> event is emitted.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v12.9.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableEnded</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:117</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableFlowing" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readable<wbr/>Flowing</span><a href="#readableFlowing" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>Flowing</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>This property reflects the current state of a <code>Readable</code> stream as described
|
||
in the <code>Three states</code> section.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v9.4.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableFlowing</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:123</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableHighWaterMark" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readable<wbr/>High<wbr/>Water<wbr/>Mark</span><a href="#readableHighWaterMark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>High<wbr/>Water<wbr/>Mark</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Returns the value of <code>highWaterMark</code> passed when creating this <code>Readable</code>.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v9.3.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableHighWaterMark</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:128</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableLength" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readable<wbr/>Length</span><a href="#readableLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>Length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v9.4.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableLength</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:135</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="readableObjectMode" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>readable<wbr/>Object<wbr/>Mode</span><a href="#readableObjectMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">readable<wbr/>Object<wbr/>Mode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Getter for the property <code>objectMode</code> of a given <code>Readable</code> stream.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v12.3.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.readableObjectMode</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:140</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-protected"><a id="remainingRead" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>remaining<wbr/>Read</span><a href="#remainingRead" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">remaining<wbr/>Read</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L27">src/util/SliceStream.ts:27</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-protected"><a id="remainingSkip" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>remaining<wbr/>Skip</span><a href="#remainingSkip" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">remaining<wbr/>Skip</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L26">src/util/SliceStream.ts:26</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-protected"><a id="source" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>source</span><a href="#source" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">source</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">Readable</span></div><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L25">src/util/SliceStream.ts:25</a></li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writable" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable</span><a href="#writable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writable</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1041</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writableCorked" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable<wbr/>Corked</span><a href="#writableCorked" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable<wbr/>Corked</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writableCorked</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1047</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writableEnded" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable<wbr/>Ended</span><a href="#writableEnded" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable<wbr/>Ended</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writableEnded</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1042</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writableFinished" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable<wbr/>Finished</span><a href="#writableFinished" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable<wbr/>Finished</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writableFinished</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1043</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writableHighWaterMark" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable<wbr/>High<wbr/>Water<wbr/>Mark</span><a href="#writableHighWaterMark" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable<wbr/>High<wbr/>Water<wbr/>Mark</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writableHighWaterMark</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1044</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writableLength" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable<wbr/>Length</span><a href="#writableLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable<wbr/>Length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writableLength</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1045</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writableNeedDrain" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable<wbr/>Need<wbr/>Drain</span><a href="#writableNeedDrain" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable<wbr/>Need<wbr/>Drain</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writableNeedDrain</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1048</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="writableObjectMode" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>writable<wbr/>Object<wbr/>Mode</span><a href="#writableObjectMode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">writable<wbr/>Object<wbr/>Mode</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.writableObjectMode</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1046</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejectionSymbol" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>capture<wbr/>Rejection<wbr/>Symbol</span><a href="#captureRejectionSymbol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">capture<wbr/>Rejection<wbr/>Symbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="SliceStream.html#captureRejectionSymbol" class="tsd-signature-type tsd-kind-property">captureRejectionSymbol</a></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.captureRejectionSymbol</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:405</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureRejections" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>capture<wbr/>Rejections</span><a href="#captureRejections" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">capture<wbr/>Rejections</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
<div class="tsd-comment tsd-typography"><p>Sets or gets the default captureRejection value for all emitters.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.captureRejections</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:410</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="defaultMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>default<wbr/>Max<wbr/>Listeners</span><a href="#defaultMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.defaultMaxListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:411</li></ul></aside></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="errorMonitor" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>error<wbr/>Monitor</span><a href="#errorMonitor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<div class="tsd-signature"><span class="tsd-kind-property">error<wbr/>Monitor</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">typeof </span><a href="SliceStream.html#errorMonitor" class="tsd-signature-type tsd-kind-property">errorMonitor</a></div>
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<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 class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.errorMonitor</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:404</li></ul></aside></section></section>
|
||
<section class="tsd-panel-group tsd-member-group">
|
||
<h2>Methods</h2>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_asyncDispose_" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>[async<wbr/>Dispose]</span><a href="#_asyncDispose_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_asyncDispose_._asyncDispose_-1"><span class="tsd-kind-call-signature">[async<wbr/>Dispose]</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#_asyncDispose_._asyncDispose_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Calls <code>readable.destroy()</code> with an <code>AbortError</code> and returns a promise that fulfills when the stream is finished.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v18.18.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.[asyncDispose]</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:682</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_asyncIterator_" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>[async<wbr/>Iterator]</span><a href="#_asyncIterator_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_asyncIterator_._asyncIterator_-1"><span class="tsd-kind-call-signature">[async<wbr/>Iterator]</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#_asyncIterator_._asyncIterator_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.[asyncIterator]</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:677</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_captureRejectionSymbol_" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>[capture<wbr/>Rejection<wbr/>Symbol]</span><a href="#_captureRejectionSymbol_" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_captureRejectionSymbol_._captureRejectionSymbol_-1"><span class="tsd-kind-call-signature">[capture<wbr/>Rejection<wbr/>Symbol]</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">event</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_captureRejectionSymbol_._captureRejectionSymbol_-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type ">Error</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.[captureRejectionSymbol]</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:115</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_construct" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>_construct</span><a href="#_construct" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_construct._construct-1"><span class="tsd-kind-call-signature">_construct</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_construct._construct-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform._construct</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:157</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_destroy" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>_destroy</span><a href="#_destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_destroy._destroy-1"><span class="tsd-kind-call-signature">_destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_destroy._destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform._destroy</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1103</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_final" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>_final</span><a href="#_final" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_final._final-1"><span class="tsd-kind-call-signature">_final</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_final._final-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform._final</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1104</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_flush" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>_flush</span><a href="#_flush" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_flush._flush-1"><span class="tsd-kind-call-signature">_flush</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_flush._flush-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type ">TransformCallback</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform._flush</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1250</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_read" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>_read</span><a href="#_read" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_read._read-1"><span class="tsd-kind-call-signature">_read</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_read._read-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform._read</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:158</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member"><a id="_transform" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>_transform</span><a href="#_transform" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures">
|
||
<li class="tsd-signature tsd-anchor-link" id="_transform._transform-1"><span class="tsd-kind-call-signature">_transform</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">encoding</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_transform._transform-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type ">TransformCallback</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Overrides Transform._transform</p>
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L60">src/util/SliceStream.ts:60</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_write" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>_write</span><a href="#_write" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_write._write-1"><span class="tsd-kind-call-signature">_write</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">encoding</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_write._write-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform._write</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1095</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="_writev" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>_writev</span><a href="#_writev" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="_writev._writev-1"><span class="tsd-kind-call-signature">_writev</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunks</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_writev._writev-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunks</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">chunk</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">encoding</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">BufferEncoding</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform._writev</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1096</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-1"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Event emitter
|
||
The defined events on documents including:</p>
|
||
<ol>
|
||
<li>close</li>
|
||
<li>data</li>
|
||
<li>drain</li>
|
||
<li>end</li>
|
||
<li>error</li>
|
||
<li>finish</li>
|
||
<li>pause</li>
|
||
<li>pipe</li>
|
||
<li>readable</li>
|
||
<li>resume</li>
|
||
<li>unpipe</li>
|
||
</ol>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"close"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1128</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-2"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"data"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1129</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-3"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"drain"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1130</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-4"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"end"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1131</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-5"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1132</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-6"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"finish"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1133</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-7"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pause"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1134</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-8"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1135</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-9"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"readable"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1136</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-10"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"resume"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1137</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-11"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"unpipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1138</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="addListener.addListener-12"><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#addListener.addListener-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <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-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1139</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="asIndexedPairs" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>as<wbr/>Indexed<wbr/>Pairs</span><a href="#asIndexedPairs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="asIndexedPairs.asIndexedPairs-1"><span class="tsd-kind-call-signature">as<wbr/>Indexed<wbr/>Pairs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Readable</span><a href="#asIndexedPairs.asIndexedPairs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method returns a new stream with chunks of the underlying stream paired with a counter
|
||
in the form <code>[index, chunk]</code>. The first index value is <code>0</code> and it increases by 1 for each chunk produced.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4><p>a stream of indexed pairs.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.asIndexedPairs</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:572</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-protected"><a id="binarySlice" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>binary<wbr/>Slice</span><a href="#binarySlice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-protected">
|
||
<li class="tsd-signature tsd-anchor-link" id="binarySlice.binarySlice-1"><span class="tsd-kind-call-signature">binary<wbr/>Slice</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#binarySlice.binarySlice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type ">Buffer</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L72">src/util/SliceStream.ts:72</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-protected"><a id="checkEnd" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>check<wbr/>End</span><a href="#checkEnd" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-protected">
|
||
<li class="tsd-signature tsd-anchor-link" id="checkEnd.checkEnd-1"><span class="tsd-kind-call-signature">check<wbr/>End</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><a href="#checkEnd.checkEnd-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Stop piping the source stream and close everything once the slice is finished.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L100">src/util/SliceStream.ts:100</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="compose" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>compose</span><a href="#compose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="compose.compose-1"><span class="tsd-kind-call-signature">compose</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stream</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#compose.compose-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<section class="tsd-panel">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameter-list">
|
||
<li>
|
||
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">ReadableStream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">stream</span>: <span class="tsd-signature-type ">ComposeFnParam</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AsyncIterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AbortSignal</span></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.compose</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:35</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cork" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>cork</span><a href="#cork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="cork.cork-1"><span class="tsd-kind-call-signature">cork</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><a href="#cork.cork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.cork</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1111</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="destroy" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="destroy.destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#destroy.destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<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>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type ">Error</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Error which will be passed as payload in <code>'error'</code> event</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v8.0.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.destroy</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:609</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="drop" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>drop</span><a href="#drop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="drop.drop-1"><span class="tsd-kind-call-signature">drop</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Readable</span><a href="#drop.drop-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method returns a new stream with the first <em>limit</em> chunks dropped from the start.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the number of chunks to drop from the readable.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4><p>a stream with <em>limit</em> chunks dropped from the start.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.drop</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:558</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-1"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"close"</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1140</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-2"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"data"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1141</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-3"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"drain"</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1142</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-4"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"end"</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1143</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-5"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1144</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-6"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"finish"</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1145</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-7"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pause"</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1146</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-8"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1147</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-9"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"readable"</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1148</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-10"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"resume"</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1149</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-11"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"unpipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1150</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="emit.emit-12"><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#emit.emit-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.emit</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1151</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="end" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>end</span><a href="#end" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="end.end-1"><span class="tsd-kind-call-signature">end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#end.end-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">cb</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.end</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1108</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="end.end-2"><span class="tsd-kind-call-signature">end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#end.end-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">cb</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.end</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1109</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="end.end-3"><span class="tsd-kind-call-signature">end</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cb</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#end.end-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">cb</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.end</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1110</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="eventNames" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>event<wbr/>Names</span><a href="#eventNames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="eventNames.eventNames-1"><span class="tsd-kind-call-signature">event<wbr/>Names</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><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="#eventNames.eventNames-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">EventEmitter</span><span class="hl-0"> = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'events'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">myEE</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-5">myEE</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'foo'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><span class="hl-5">myEE</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'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-3">sym</span><span class="hl-0"> = </span><span class="hl-4">Symbol</span><span class="hl-0">(</span><span class="hl-1">'symbol'</span><span class="hl-0">);</span><br/><span class="hl-5">myEE</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-5">sym</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">myEE</span><span class="hl-0">.</span><span class="hl-4">eventNames</span><span class="hl-0">());</span><br/><span class="hl-6">// Prints: [ 'foo', 'bar', Symbol(symbol) ]</span>
|
||
</code><button>Copy</button></pre>
|
||
</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>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v6.0.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.eventNames</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:794</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="every" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>every</span><a href="#every" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="every.every-1"><span class="tsd-kind-call-signature">every</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#every.every-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method is similar to <code>Array.prototype.every</code> and calls <em>fn</em> on each chunk in the stream
|
||
to check if all awaited return values are truthy value for <em>fn</em>. Once an <em>fn</em> call on a chunk
|
||
<code>await</code>ed return value is falsy, the stream is destroyed and the promise is fulfilled with <code>false</code>.
|
||
If all of the <em>fn</em> calls on the chunks return a truthy value, the promise is fulfilled with <code>true</code>.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><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></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function to call on each chunk of the stream. Async or not.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>a promise evaluating to <code>true</code> if <em>fn</em> returned a truthy value for every one of the chunks.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.every</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:537</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="filter" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>filter</span><a href="#filter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="filter.filter-1"><span class="tsd-kind-call-signature">filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Readable</span><a href="#filter.filter-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method allows filtering the stream. For each chunk in the stream the <em>fn</em> function will be called
|
||
and if it returns a truthy value, the chunk will be passed to the result stream.
|
||
If the <em>fn</em> function returns a promise - that promise will be <code>await</code>ed.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><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></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function to filter chunks from the stream. Async or not.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4><p>a stream filtered with the predicate <em>fn</em>.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.4.0, v16.14.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.filter</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:465</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="find" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>find</span><a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="find.find-1"><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#find.find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method is similar to <code>Array.prototype.find</code> and calls <em>fn</em> on each chunk in the stream
|
||
to find a chunk with a truthy value for <em>fn</em>. Once an <em>fn</em> call's awaited return value is truthy,
|
||
the stream is destroyed and the promise is fulfilled with value for which <em>fn</em> returned a truthy value.
|
||
If all of the <em>fn</em> calls on the chunks return a falsy value, the promise is fulfilled with <code>undefined</code>.</p>
|
||
</div>
|
||
<section class="tsd-panel">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameter-list">
|
||
<li>
|
||
<h4><span class="tsd-kind-type-parameter">T</span></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function to call on each chunk of the stream. Async or not.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol"> is </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4><p>a promise evaluating to the first chunk for which <em>fn</em> evaluated with a truthy value,
|
||
or <code>undefined</code> if no element was found.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.find</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:520</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="find.find-2"><span class="tsd-kind-call-signature">find</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#find.find-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.find</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:524</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="flatMap" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>flat<wbr/>Map</span><a href="#flatMap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="flatMap.flatMap-1"><span class="tsd-kind-call-signature">flat<wbr/>Map</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Readable</span><a href="#flatMap.flatMap-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method returns a new stream by applying the given callback to each chunk of the stream
|
||
and then flattening the result.</p>
|
||
<p>It is possible to return a stream or another iterable or async iterable from <em>fn</em> and the result streams
|
||
will be merged (flattened) into the returned stream.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function to map over every chunk in the stream. May be async. May be a stream or generator.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4><p>a stream flat-mapped with the function <em>fn</em>.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.flatMap</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:551</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="forEach" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>for<wbr/>Each</span><a href="#forEach" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="forEach.forEach-1"><span class="tsd-kind-call-signature">for<wbr/>Each</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#forEach.forEach-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method allows iterating a stream. For each chunk in the stream the <em>fn</em> function will be called.
|
||
If the <em>fn</em> function returns a promise - that promise will be <code>await</code>ed.</p>
|
||
<p>This method is different from <code>for await...of</code> loops in that it can optionally process chunks concurrently.
|
||
In addition, a <code>forEach</code> iteration can only be stopped by having passed a <code>signal</code> option
|
||
and aborting the related AbortController while <code>for await...of</code> can be stopped with <code>break</code> or <code>return</code>.
|
||
In either case the stream will be destroyed.</p>
|
||
<p>This method is different from listening to the <code>'data'</code> event in that it uses the <code>readable</code> event
|
||
in the underlying machinary and can limit the number of concurrent <em>fn</em> calls.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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-type ">Promise</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></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function to call on each chunk of the stream. Async or not.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>a promise for when the stream has finished.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.forEach</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:484</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>get<wbr/>Max<wbr/>Listeners</span><a href="#getMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="getMaxListeners.getMaxListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Max<wbr/>Listeners</span><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><a href="#getMaxListeners.getMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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="SliceStream.html#defaultMaxListeners" class="tsd-kind-property">defaultMaxListeners</a>.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v1.0.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.getMaxListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:647</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isPaused" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>is<wbr/>Paused</span><a href="#isPaused" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="isPaused.isPaused-1"><span class="tsd-kind-call-signature">is<wbr/>Paused</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><a href="#isPaused.isPaused-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">readable</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-5">stream</span><span class="hl-0">.</span><span class="hl-4">Readable</span><span class="hl-0">();</span><br/><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">isPaused</span><span class="hl-0">(); </span><span class="hl-6">// === false</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">pause</span><span class="hl-0">();</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">isPaused</span><span class="hl-0">(); </span><span class="hl-6">// === true</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">resume</span><span class="hl-0">();</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">isPaused</span><span class="hl-0">(); </span><span class="hl-6">// === false</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.11.14</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.isPaused</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:318</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="iterator" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>iterator</span><a href="#iterator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="iterator.iterator-1"><span class="tsd-kind-call-signature">iterator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#iterator.iterator-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>The iterator created by this method gives users the option to cancel the destruction
|
||
of the stream if the <code>for await...of</code> loop is exited by <code>return</code>, <code>break</code>, or <code>throw</code>,
|
||
or if the iterator should destroy the stream if the stream emitted an error during iteration.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">destroyOnReturn</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">destroy<wbr/>On<wbr/>Return</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>When set to <code>false</code>, calling <code>return</code> on the async iterator,
|
||
or exiting a <code>for await...of</code> iteration using a <code>break</code>, <code>return</code>, or <code>throw</code> will not destroy the stream.
|
||
<strong>Default: <code>true</code></strong>.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v16.3.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.iterator</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:448</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="listenerCount.listenerCount-1"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><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><a href="#listenerCount.listenerCount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns the number of listeners listening to the event named <code>eventName</code>.</p>
|
||
<p>If <code>listener</code> is provided, it will return how many times the listener
|
||
is found in the list of the listeners of the event.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <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"><p>The name of the event being listened for</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-type ">Function</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The event handler function</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v3.2.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.listenerCount</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:741</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>listeners</span><a href="#listeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="listeners.listeners-1"><span class="tsd-kind-call-signature">listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#listeners.listeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||
<pre><code class="language-js"><span class="hl-5">server</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'connection'</span><span class="hl-0">, (</span><span class="hl-5">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-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'someone connected!'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">util</span><span class="hl-0">.</span><span class="hl-4">inspect</span><span class="hl-0">(</span><span class="hl-5">server</span><span class="hl-0">.</span><span class="hl-4">listeners</span><span class="hl-0">(</span><span class="hl-1">'connection'</span><span class="hl-0">)));</span><br/><span class="hl-6">// Prints: [ [Function] ]</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.1.26</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.listeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:660</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="map" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>map</span><a href="#map" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="map.map-1"><span class="tsd-kind-call-signature">map</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Readable</span><a href="#map.map-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method allows mapping over the stream. The <em>fn</em> function will be called for every chunk in the stream.
|
||
If the <em>fn</em> function returns a promise - that promise will be <code>await</code>ed before being passed to the result stream.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function to map over every chunk in the stream. Async or not.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4><p>a stream mapped with the function <em>fn</em>.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.4.0, v16.14.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.map</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:456</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-protected"><a id="objectSlice" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>object<wbr/>Slice</span><a href="#objectSlice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-protected">
|
||
<li class="tsd-signature tsd-anchor-link" id="objectSlice.objectSlice-1"><span class="tsd-kind-call-signature">object<wbr/>Slice</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#objectSlice.objectSlice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">unknown</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<ul>
|
||
<li>Defined in <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/cd1daae/src/util/SliceStream.ts#L87">src/util/SliceStream.ts:87</a></li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="off" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="off.off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Alias for <code>emitter.removeListener()</code>.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <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-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v10.0.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.off</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:620</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="on" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"close"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1152</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-2"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"data"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1153</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-3"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"drain"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1154</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-4"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"end"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1155</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-5"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1156</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-6"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"finish"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1157</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-7"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pause"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1158</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-8"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1159</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-9"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"readable"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1160</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-10"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"resume"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1161</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-11"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"unpipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1162</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="on.on-12"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#on.on-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <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-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1163</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>once</span><a href="#once" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-1"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"close"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1164</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-2"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"data"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1165</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-3"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"drain"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1166</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-4"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"end"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1167</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-5"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1168</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-6"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"finish"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1169</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-7"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pause"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1170</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-8"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1171</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-9"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"readable"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1172</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-10"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"resume"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1173</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-11"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"unpipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1174</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once.once-12"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#once.once-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <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-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1175</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pause" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>pause</span><a href="#pause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="pause.pause-1"><span class="tsd-kind-call-signature">pause</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#pause.pause-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>The <code>readable.pause()</code> method will cause a stream in flowing mode to stop
|
||
emitting <code>'data'</code> events, switching out of flowing mode. Any data that
|
||
becomes available will remain in the internal buffer.</p>
|
||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">readable</span><span class="hl-0"> = </span><span class="hl-4">getReadableStreamSomehow</span><span class="hl-0">();</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'data'</span><span class="hl-0">, (</span><span class="hl-5">chunk</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-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">`Received </span><span class="hl-2">${</span><span class="hl-5">chunk</span><span class="hl-7">.</span><span class="hl-5">length</span><span class="hl-2">}</span><span class="hl-1"> bytes of data.`</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">pause</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'There will be no additional data for 1 second.'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-4">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-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Now data will start flowing again.'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">resume</span><span class="hl-0">();</span><br/><span class="hl-0"> }, </span><span class="hl-8">1000</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>The <code>readable.pause()</code> method has no effect if there is a <code>'readable'</code>event listener.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.4</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.pause</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:282</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="pipe" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>pipe</span><a href="#pipe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="pipe.pipe-1"><span class="tsd-kind-call-signature">pipe</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destination</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><a href="#pipe.pipe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<section class="tsd-panel">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameter-list">
|
||
<li>
|
||
<h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type ">WritableStream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">destination</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter">
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.pipe</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:29</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prependListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Listener</span><a href="#prependListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"close"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1176</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-2"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"data"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1177</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-3"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"drain"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1178</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-4"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"end"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1179</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-5"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1180</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-6"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"finish"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1181</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-7"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pause"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1182</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-8"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1183</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-9"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"readable"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1184</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-10"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"resume"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1185</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-11"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"unpipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1186</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependListener.prependListener-12"><span class="tsd-kind-call-signature">prepend<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependListener.prependListener-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <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-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1187</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="prependOnceListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>prepend<wbr/>Once<wbr/>Listener</span><a href="#prependOnceListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-1"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"close"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1188</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-2"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"data"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1189</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-3"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"drain"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1190</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-4"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"end"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1191</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-5"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1192</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-6"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"finish"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1193</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-7"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pause"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1194</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-8"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1195</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-9"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"readable"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1196</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-10"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"resume"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1197</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-11"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"unpipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1198</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="prependOnceListener.prependOnceListener-12"><span class="tsd-kind-call-signature">prepend<wbr/>Once<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#prependOnceListener.prependOnceListener-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <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-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.prependOnceListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1199</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="push" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>push</span><a href="#push" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="push.push-1"><span class="tsd-kind-call-signature">push</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">encoding</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><a href="#push.push-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.push</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:438</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="rawListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>raw<wbr/>Listeners</span><a href="#rawListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="rawListeners.rawListeners-1"><span class="tsd-kind-call-signature">raw<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#rawListeners.rawListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">emitter</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">once</span><span class="hl-0">(</span><span class="hl-1">'log'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'log once'</span><span class="hl-0">));</span><br/><br/><span class="hl-6">// Returns a new Array with a function `onceWrapper` which has a property</span><br/><span class="hl-6">// `listener` which contains the original listener bound above</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">listeners</span><span class="hl-0"> = </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">rawListeners</span><span class="hl-0">(</span><span class="hl-1">'log'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">logFnWrapper</span><span class="hl-0"> = </span><span class="hl-5">listeners</span><span class="hl-0">[</span><span class="hl-8">0</span><span class="hl-0">];</span><br/><br/><span class="hl-6">// Logs "log once" to the console and does not unbind the `once` event</span><br/><span class="hl-5">logFnWrapper</span><span class="hl-0">.</span><span class="hl-4">listener</span><span class="hl-0">();</span><br/><br/><span class="hl-6">// Logs "log once" to the console and removes the listener</span><br/><span class="hl-4">logFnWrapper</span><span class="hl-0">();</span><br/><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'log'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'log persistently'</span><span class="hl-0">));</span><br/><span class="hl-6">// 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-3">newListeners</span><span class="hl-0"> = </span><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">rawListeners</span><span class="hl-0">(</span><span class="hl-1">'log'</span><span class="hl-0">);</span><br/><br/><span class="hl-6">// Logs "log persistently" twice</span><br/><span class="hl-5">newListeners</span><span class="hl-0">[</span><span class="hl-8">0</span><span class="hl-0">]();</span><br/><span class="hl-5">emitter</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'log'</span><span class="hl-0">);</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v9.4.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.rawListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:690</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="read" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>read</span><a href="#read" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="read.read-1"><span class="tsd-kind-call-signature">read</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><a href="#read.read-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>The <code>readable.read()</code> method reads data out of the internal buffer and
|
||
returns it. If no data is available to be read, <code>null</code> is returned. By default,
|
||
the data is 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>
|
||
<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-3">readable</span><span class="hl-0"> = </span><span class="hl-4">getReadableStreamSomehow</span><span class="hl-0">();</span><br/><br/><span class="hl-6">// 'readable' may be triggered multiple times as data is buffered in</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'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-5">chunk</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Stream is readable (new data received in buffer)'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-6">// Use a loop to make sure we read all currently available data</span><br/><span class="hl-0"> </span><span class="hl-9">while</span><span class="hl-0"> (</span><span class="hl-2">null</span><span class="hl-0"> !== (</span><span class="hl-5">chunk</span><span class="hl-0"> = </span><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">read</span><span class="hl-0">())) {</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">`Read </span><span class="hl-2">${</span><span class="hl-5">chunk</span><span class="hl-7">.</span><span class="hl-5">length</span><span class="hl-2">}</span><span class="hl-1"> 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-6">// 'end' will be triggered once when there is no more data available</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'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-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Reached end of stream.'</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||
</code><button>Copy</button></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-3">chunks</span><span class="hl-0"> = [];</span><br/><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'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-5">chunk</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-9">while</span><span class="hl-0"> (</span><span class="hl-2">null</span><span class="hl-0"> !== (</span><span class="hl-5">chunk</span><span class="hl-0"> = </span><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">read</span><span class="hl-0">())) {</span><br/><span class="hl-0"> </span><span class="hl-5">chunks</span><span class="hl-0">.</span><span class="hl-4">push</span><span class="hl-0">(</span><span class="hl-5">chunk</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'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-3">content</span><span class="hl-0"> = </span><span class="hl-5">chunks</span><span class="hl-0">.</span><span class="hl-4">join</span><span class="hl-0">(</span><span class="hl-1">''</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||
</code><button>Copy</button></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="SliceStream.html#read" class="tsd-kind-method">read</a> after the <code>'end'</code> event has
|
||
been emitted will return <code>null</code>. No runtime error will be raised.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Optional argument to specify how much data to read.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.4</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.read</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:235</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="reduce" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>reduce</span><a href="#reduce" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="reduce.reduce-1"><span class="tsd-kind-call-signature">reduce</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">initial</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#reduce.reduce-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method calls <em>fn</em> on each chunk of the stream in order, passing it the result from the calculation
|
||
on the previous element. It returns a promise for the final value of the reduction.</p>
|
||
<p>If no <em>initial</em> value is supplied the first chunk of the stream is used as the initial value.
|
||
If the stream is empty, the promise is rejected with a <code>TypeError</code> with the <code>ERR_INVALID_ARGS</code> code property.</p>
|
||
<p>The reducer function iterates the stream element-by-element which means that there is no <em>concurrency</em> parameter
|
||
or parallelism. To perform a reduce concurrently, you can extract the async function to <code>readable.map</code> method.</p>
|
||
</div>
|
||
<section class="tsd-panel">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameter-list">
|
||
<li>
|
||
<h4><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previous</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a reducer function to call over every chunk in the stream. Async or not.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previous</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">previous</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">initial</span>: <span class="tsd-signature-type">undefined</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the initial value to use in the reduction.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4><p>a promise for the final value of the reduction.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.reduce</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:587</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="reduce.reduce-2"><span class="tsd-kind-call-signature">reduce</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">initial</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><a href="#reduce.reduce-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<section class="tsd-panel">
|
||
<h4>Type Parameters</h4>
|
||
<ul class="tsd-type-parameter-list">
|
||
<li>
|
||
<h4><span class="tsd-kind-type-parameter">T</span> = <span class="tsd-signature-type">any</span></h4></li></ul></section>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previous</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">previous</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type tsd-kind-type-parameter">T</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">previous</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">initial</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.reduce</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:592</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="removeAllListeners.removeAllListeners-1"><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeAllListeners.removeAllListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Removes all listeners, or those of the specified <code>eventName</code>.</p>
|
||
<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>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.1.26</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeAllListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:631</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>remove<wbr/>Listener</span><a href="#removeListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-1"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"close"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1200</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-2"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"data"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1201</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-3"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"drain"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1202</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-4"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"end"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1203</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-5"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"error"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">err</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">err</span>: <span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1204</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-6"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"finish"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1205</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-7"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pause"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1206</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-8"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"pipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1207</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-9"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"readable"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1208</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-10"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"resume"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</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><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><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>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1209</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-11"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type">"unpipe"</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1210</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="removeListener.removeListener-12"><span class="tsd-kind-call-signature">remove<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#removeListener.removeListener-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <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-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.removeListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1211</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="resume" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>resume</span><a href="#resume" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="resume.resume-1"><span class="tsd-kind-call-signature">resume</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#resume.resume-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>The <code>readable.resume()</code> method causes an explicitly paused <code>Readable</code> stream to
|
||
resume emitting <code>'data'</code> events, switching the stream into flowing mode.</p>
|
||
<p>The <code>readable.resume()</code> method can be used to fully consume the data from a
|
||
stream without actually processing any of that data:</p>
|
||
<pre><code class="language-js"><span class="hl-4">getReadableStreamSomehow</span><span class="hl-0">()</span><br/><span class="hl-0"> .</span><span class="hl-4">resume</span><span class="hl-0">()</span><br/><span class="hl-0"> .</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'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-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Reached the end, but did not read anything.'</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>The <code>readable.resume()</code> method has no effect if there is a <code>'readable'</code>event listener.</p>
|
||
</div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.4</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.resume</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:301</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setDefaultEncoding" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>set<wbr/>Default<wbr/>Encoding</span><a href="#setDefaultEncoding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="setDefaultEncoding.setDefaultEncoding-1"><span class="tsd-kind-call-signature">set<wbr/>Default<wbr/>Encoding</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#setDefaultEncoding.setDefaultEncoding-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.setDefaultEncoding</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1107</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setEncoding" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>set<wbr/>Encoding</span><a href="#setEncoding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="setEncoding.setEncoding-1"><span class="tsd-kind-call-signature">set<wbr/>Encoding</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#setEncoding.setEncoding-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>The <code>readable.setEncoding()</code> method sets the character encoding for
|
||
data read from the <code>Readable</code> stream.</p>
|
||
<p>By default, no encoding is assigned and stream data will be returned as<code>Buffer</code> objects. Setting an encoding causes the stream data
|
||
to be returned as strings of the specified encoding rather than as <code>Buffer</code>objects. For instance, calling <code>readable.setEncoding('utf8')</code> will cause the
|
||
output data to be interpreted as UTF-8 data, and passed as strings. Calling<code>readable.setEncoding('hex')</code> will cause the data to be encoded in hexadecimal
|
||
string format.</p>
|
||
<p>The <code>Readable</code> stream will properly handle multi-byte characters delivered
|
||
through the stream that would otherwise become improperly decoded if simply
|
||
pulled from the stream as <code>Buffer</code> objects.</p>
|
||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">readable</span><span class="hl-0"> = </span><span class="hl-4">getReadableStreamSomehow</span><span class="hl-0">();</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">setEncoding</span><span class="hl-0">(</span><span class="hl-1">'utf8'</span><span class="hl-0">);</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'data'</span><span class="hl-0">, (</span><span class="hl-5">chunk</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-5">assert</span><span class="hl-0">.</span><span class="hl-4">equal</span><span class="hl-0">(</span><span class="hl-2">typeof</span><span class="hl-0"> </span><span class="hl-5">chunk</span><span class="hl-0">, </span><span class="hl-1">'string'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Got %d characters of string data:'</span><span class="hl-0">, </span><span class="hl-5">chunk</span><span class="hl-0">.</span><span class="hl-5">length</span><span class="hl-0">);</span><br/><span class="hl-0">});</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The encoding to use.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.4</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.setEncoding</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:260</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setMaxListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners.setMaxListeners-1"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#setMaxListeners.setMaxListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<p>Returns a reference to the <code>EventEmitter</code>, so that calls can be chained.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.3.5</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.setMaxListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:641</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="some" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>some</span><a href="#some" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="some.some-1"><span class="tsd-kind-call-signature">some</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fn</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span><a href="#some.some-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method is similar to <code>Array.prototype.some</code> and calls <em>fn</em> on each chunk in the stream
|
||
until the awaited return value is <code>true</code> (or any truthy value). Once an <em>fn</em> call on a chunk
|
||
<code>await</code>ed return value is truthy, the stream is destroyed and the promise is fulfilled with <code>true</code>.
|
||
If none of the <em>fn</em> calls on the chunks return a truthy value, the promise is fulfilled with <code>false</code>.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">fn</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><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></h5>
|
||
<div class="tsd-comment tsd-typography"><p>a function to call on each chunk of the stream. Async or not.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">options</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><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4></li></ul></li></ul></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">ArrayOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4><p>a promise evaluating to <code>true</code> if <em>fn</em> returned a truthy value for at least one of the chunks.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.some</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:506</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="take" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>take</span><a href="#take" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="take.take-1"><span class="tsd-kind-call-signature">take</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">limit</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Readable</span><a href="#take.take-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method returns a new stream with the first <em>limit</em> chunks.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">limit</span>: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>the number of chunks to take from the readable.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4><p>a stream with <em>limit</em> chunks taken.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.take</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:565</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toArray" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>to<wbr/>Array</span><a href="#toArray" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="toArray.toArray-1"><span class="tsd-kind-call-signature">to<wbr/>Array</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#toArray.toArray-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>This method allows easily obtaining the contents of a stream.</p>
|
||
<p>As this method reads the entire stream into memory, it negates the benefits of streams. It's intended
|
||
for interoperability and convenience, not as the primary way to consume streams.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ArrayOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><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><p>a promise containing an array with the contents of the stream.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.5.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.toArray</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:496</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="uncork" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>uncork</span><a href="#uncork" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="uncork.uncork-1"><span class="tsd-kind-call-signature">uncork</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><a href="#uncork.uncork-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.uncork</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1112</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="unpipe" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>unpipe</span><a href="#unpipe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="unpipe.unpipe-1"><span class="tsd-kind-call-signature">unpipe</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">destination</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#unpipe.unpipe-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>The <code>readable.unpipe()</code> method detaches a <code>Writable</code> stream previously attached
|
||
using the <a href="SliceStream.html#pipe" class="tsd-kind-method">pipe</a> method.</p>
|
||
<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-3">fs</span><span class="hl-0"> = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'fs'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">readable</span><span class="hl-0"> = </span><span class="hl-4">getReadableStreamSomehow</span><span class="hl-0">();</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">writable</span><span class="hl-0"> = </span><span class="hl-5">fs</span><span class="hl-0">.</span><span class="hl-4">createWriteStream</span><span class="hl-0">(</span><span class="hl-1">'file.txt'</span><span class="hl-0">);</span><br/><span class="hl-6">// All the data from readable goes into 'file.txt',</span><br/><span class="hl-6">// but only for the first second.</span><br/><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">pipe</span><span class="hl-0">(</span><span class="hl-5">writable</span><span class="hl-0">);</span><br/><span class="hl-4">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-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Stop writing to file.txt.'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">readable</span><span class="hl-0">.</span><span class="hl-4">unpipe</span><span class="hl-0">(</span><span class="hl-5">writable</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Manually close the file stream.'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">writable</span><span class="hl-0">.</span><span class="hl-4">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><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">destination</span>: <span class="tsd-signature-type ">WritableStream</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>Optional specific stream to unpipe</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.4</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.unpipe</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:345</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="unshift" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>unshift</span><a href="#unshift" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="unshift.unshift-1"><span class="tsd-kind-call-signature">unshift</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">encoding</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><a href="#unshift.unshift-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<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-6">// Pull off a header delimited by \n\n.</span><br/><span class="hl-6">// Use unshift() if we get too much.</span><br/><span class="hl-6">// Call the callback with (error, header, stream).</span><br/><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-3">StringDecoder</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'string_decoder'</span><span class="hl-0">);</span><br/><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-4">parseHeader</span><span class="hl-0">(</span><span class="hl-5">stream</span><span class="hl-0">, </span><span class="hl-5">callback</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-5">stream</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'error'</span><span class="hl-0">, </span><span class="hl-5">callback</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">stream</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'readable'</span><span class="hl-0">, </span><span class="hl-5">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-3">decoder</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">StringDecoder</span><span class="hl-0">(</span><span class="hl-1">'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-5">header</span><span class="hl-0"> = </span><span class="hl-1">''</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-4">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-5">chunk</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-9">while</span><span class="hl-0"> (</span><span class="hl-2">null</span><span class="hl-0"> !== (</span><span class="hl-5">chunk</span><span class="hl-0"> = </span><span class="hl-5">stream</span><span class="hl-0">.</span><span class="hl-4">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-3">str</span><span class="hl-0"> = </span><span class="hl-5">decoder</span><span class="hl-0">.</span><span class="hl-4">write</span><span class="hl-0">(</span><span class="hl-5">chunk</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> (</span><span class="hl-5">str</span><span class="hl-0">.</span><span class="hl-4">includes</span><span class="hl-0">(</span><span class="hl-1">'</span><span class="hl-10">\n\n</span><span class="hl-1">'</span><span class="hl-0">)) {</span><br/><span class="hl-0"> </span><span class="hl-6">// 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-3">split</span><span class="hl-0"> = </span><span class="hl-5">str</span><span class="hl-0">.</span><span class="hl-4">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-5">header</span><span class="hl-0"> += </span><span class="hl-5">split</span><span class="hl-0">.</span><span class="hl-4">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-3">remaining</span><span class="hl-0"> = </span><span class="hl-5">split</span><span class="hl-0">.</span><span class="hl-4">join</span><span class="hl-0">(</span><span class="hl-1">'</span><span class="hl-10">\n\n</span><span class="hl-1">'</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-3">buf</span><span class="hl-0"> = </span><span class="hl-5">Buffer</span><span class="hl-0">.</span><span class="hl-4">from</span><span class="hl-0">(</span><span class="hl-5">remaining</span><span class="hl-0">, </span><span class="hl-1">'utf8'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">stream</span><span class="hl-0">.</span><span class="hl-4">removeListener</span><span class="hl-0">(</span><span class="hl-1">'error'</span><span class="hl-0">, </span><span class="hl-5">callback</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-6">// Remove the 'readable' listener before unshifting.</span><br/><span class="hl-0"> </span><span class="hl-5">stream</span><span class="hl-0">.</span><span class="hl-4">removeListener</span><span class="hl-0">(</span><span class="hl-1">'readable'</span><span class="hl-0">, </span><span class="hl-5">onReadable</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> (</span><span class="hl-5">buf</span><span class="hl-0">.</span><span class="hl-5">length</span><span class="hl-0">)</span><br/><span class="hl-0"> </span><span class="hl-5">stream</span><span class="hl-0">.</span><span class="hl-4">unshift</span><span class="hl-0">(</span><span class="hl-5">buf</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-6">// Now the body of the message can be read from the stream.</span><br/><span class="hl-0"> </span><span class="hl-4">callback</span><span class="hl-0">(</span><span class="hl-2">null</span><span class="hl-0">, </span><span class="hl-5">header</span><span class="hl-0">, </span><span class="hl-5">stream</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-9">return</span><span class="hl-0">;</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-6">// Still reading the header.</span><br/><span class="hl-0"> </span><span class="hl-5">header</span><span class="hl-0"> += </span><span class="hl-5">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>
|
||
</code><button>Copy</button></pre>
|
||
<p>Unlike <a href="SliceStream.html#push" class="tsd-kind-method">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="SliceStream.html#_read" class="tsd-kind-method">_read</a> implementation on a
|
||
custom stream). Following the call to <code>readable.unshift()</code> with an immediate <a href="SliceStream.html#push" class="tsd-kind-method">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>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5>
|
||
<div class="tsd-comment tsd-typography"><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 class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.11</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.unshift</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:411</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="wrap" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>wrap</span><a href="#wrap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="wrap.wrap-1"><span class="tsd-kind-call-signature">wrap</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stream</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a><a href="#wrap.wrap-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<p>When using an older Node.js library that emits <code>'data'</code> events and has a <a href="SliceStream.html#pause" class="tsd-kind-method">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-3">OldReader</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'./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-3">Readable</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'stream'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">oreader</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">OldReader</span><span class="hl-0">();</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">myReader</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">Readable</span><span class="hl-0">().</span><span class="hl-4">wrap</span><span class="hl-0">(</span><span class="hl-5">oreader</span><span class="hl-0">);</span><br/><br/><span class="hl-5">myReader</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'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-5">myReader</span><span class="hl-0">.</span><span class="hl-4">read</span><span class="hl-0">(); </span><span class="hl-6">// etc.</span><br/><span class="hl-0">});</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">stream</span>: <span class="tsd-signature-type ">ReadableStream</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>An "old style" readable stream</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <a href="SliceStream.html" class="tsd-signature-type tsd-kind-class">SliceStream</a></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.4</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.wrap</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:437</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="write" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><span>write</span><a href="#write" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="write.write-1"><span class="tsd-kind-call-signature">write</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cb</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><a href="#write.write-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type ">BufferEncoding</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.write</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1105</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="write.write-2"><span class="tsd-kind-call-signature">write</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">chunk</span>, <span class="tsd-kind-parameter">cb</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><a href="#write.write-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">chunk</span>: <span class="tsd-signature-type">any</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">cb</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">error</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Error</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
||
<p>Inherited from Transform.write</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1106</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addAbortListener" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>add<wbr/>Abort<wbr/>Listener</span><a href="#addAbortListener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="addAbortListener.addAbortListener-1"><span class="tsd-kind-call-signature">add<wbr/>Abort<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">signal</span>, <span class="tsd-kind-parameter">resource</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Disposable</span><a href="#addAbortListener.addAbortListener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description"><code class="tsd-tag ts-flagExperimental">Experimental</code>
|
||
<div class="tsd-comment tsd-typography"><p>Listens once to the <code>abort</code> event on the provided <code>signal</code>.</p>
|
||
<p>Listening to the <code>abort</code> event on abort signals is unsafe and may
|
||
lead to resource leaks since another third party with the signal can
|
||
call <code>e.stopImmediatePropagation()</code>. Unfortunately Node.js cannot change
|
||
this since it would violate the web standard. Additionally, the original
|
||
API makes it easy to forget to remove listeners.</p>
|
||
<p>This API allows safely using <code>AbortSignal</code>s in Node.js APIs by solving these
|
||
two issues by listening to the event such that <code>stopImmediatePropagation</code> does
|
||
not prevent the listener from running.</p>
|
||
<p>Returns a disposable so that it may be unsubscribed from more easily.</p>
|
||
<pre><code class="language-js"><span class="hl-9">import</span><span class="hl-0"> { </span><span class="hl-5">addAbortListener</span><span class="hl-0"> } </span><span class="hl-9">from</span><span class="hl-0"> </span><span class="hl-1">'node:events'</span><span class="hl-0">;</span><br/><br/><span class="hl-2">function</span><span class="hl-0"> </span><span class="hl-4">example</span><span class="hl-0">(</span><span class="hl-5">signal</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-5">disposable</span><span class="hl-0">;</span><br/><span class="hl-0"> </span><span class="hl-9">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">signal</span><span class="hl-0">.</span><span class="hl-4">addEventListener</span><span class="hl-0">(</span><span class="hl-1">'abort'</span><span class="hl-0">, (</span><span class="hl-5">e</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">e</span><span class="hl-0">.</span><span class="hl-4">stopImmediatePropagation</span><span class="hl-0">());</span><br/><span class="hl-0"> </span><span class="hl-5">disposable</span><span class="hl-0"> = </span><span class="hl-4">addAbortListener</span><span class="hl-0">(</span><span class="hl-5">signal</span><span class="hl-0">, (</span><span class="hl-5">e</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-6">// Do something when signal is aborted.</span><br/><span class="hl-0"> });</span><br/><span class="hl-0"> } </span><span class="hl-9">finally</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">disposable</span><span class="hl-0">?.[</span><span class="hl-5">Symbol</span><span class="hl-0">.</span><span class="hl-5">dispose</span><span class="hl-0">]();</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type ">AbortSignal</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">resource</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</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></h5>
|
||
<ul class="tsd-parameters">
|
||
<li class="tsd-parameter-signature">
|
||
<ul class="tsd-signatures tsd-is-external">
|
||
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">Event</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Disposable</span></h4><p>Disposable that removes the <code>abort</code> listener.</p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v18.18.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.addAbortListener</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:394</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="from" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from</span><a href="#from" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="from.from-1"><span class="tsd-kind-call-signature">from</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">src</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Duplex</span><a href="#from.from-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>A utility method for creating duplex streams.</p>
|
||
<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>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">src</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Stream</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Promise</span><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 ">Iterable</span><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 ">AsyncIterable</span><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 ">ArrayBuffer</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">Blob</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AsyncGeneratorFunction</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Duplex</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v16.8.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.from</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:1083</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="fromWeb" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>from<wbr/>Web</span><a href="#fromWeb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="fromWeb.fromWeb-1"><span class="tsd-kind-call-signature">from<wbr/>Web</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">readableStream</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Readable</span><a href="#fromWeb.fromWeb-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description"><code class="tsd-tag ts-flagExperimental">Experimental</code>
|
||
<div class="tsd-comment tsd-typography"><p>A utility method for creating a <code>Readable</code> from a web <code>ReadableStream</code>.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">readableStream</span>: <span class="tsd-signature-type ">ReadableStream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">Pick</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ReadableOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"encoding"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"highWaterMark"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"objectMode"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"signal"</span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Readable</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.0.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.fromWeb</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:75</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getEventListeners" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Event<wbr/>Listeners</span><a href="#getEventListeners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="getEventListeners.getEventListeners-1"><span class="tsd-kind-call-signature">get<wbr/>Event<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span><a href="#getEventListeners.getEventListeners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns a copy of the array of listeners for the event named <code>eventName</code>.</p>
|
||
<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-3">getEventListeners</span><span class="hl-0">, </span><span class="hl-3">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'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-3">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">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-4">listener</span><span class="hl-0"> = () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Events are fun'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">ee</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'foo'</span><span class="hl-0">, </span><span class="hl-5">listener</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-4">getEventListeners</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">, </span><span class="hl-1">'foo'</span><span class="hl-0">); </span><span class="hl-6">// [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-3">et</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">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-4">listener</span><span class="hl-0"> = () </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'Events are fun'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">et</span><span class="hl-0">.</span><span class="hl-4">addEventListener</span><span class="hl-0">(</span><span class="hl-1">'foo'</span><span class="hl-0">, </span><span class="hl-5">listener</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-4">getEventListeners</span><span class="hl-0">(</span><span class="hl-5">et</span><span class="hl-0">, </span><span class="hl-1">'foo'</span><span class="hl-0">); </span><span class="hl-6">// [listener]</span><br/><span class="hl-0">}</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">_DOMEventTarget</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Function</span><span class="tsd-signature-symbol">[]</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v15.2.0, v14.17.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.getEventListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:312</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="getMaxListeners-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>get<wbr/>Max<wbr/>Listeners</span><a href="#getMaxListeners-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="getMaxListeners-2.getMaxListeners-3"><span class="tsd-kind-call-signature">get<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#getMaxListeners-2.getMaxListeners-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns the currently set max amount of listeners.</p>
|
||
<p>For <code>EventEmitter</code>s this behaves exactly the same as calling <code>.getMaxListeners</code> on
|
||
the emitter.</p>
|
||
<p>For <code>EventTarget</code>s this is the only way to get the max event listeners for the
|
||
event target. If the number of event handlers on a single EventTarget exceeds
|
||
the max set, the EventTarget will print a warning.</p>
|
||
<pre><code class="language-js"><span class="hl-9">import</span><span class="hl-0"> { </span><span class="hl-5">getMaxListeners</span><span class="hl-0">, </span><span class="hl-5">setMaxListeners</span><span class="hl-0">, </span><span class="hl-5">EventEmitter</span><span class="hl-0"> } </span><span class="hl-9">from</span><span class="hl-0"> </span><span class="hl-1">'node: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-3">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-4">getMaxListeners</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">)); </span><span class="hl-6">// 10</span><br/><span class="hl-0"> </span><span class="hl-4">setMaxListeners</span><span class="hl-0">(</span><span class="hl-8">11</span><span class="hl-0">, </span><span class="hl-5">ee</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-4">getMaxListeners</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">)); </span><span class="hl-6">// 11</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-3">et</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventTarget</span><span class="hl-0">();</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-4">getMaxListeners</span><span class="hl-0">(</span><span class="hl-5">et</span><span class="hl-0">)); </span><span class="hl-6">// 10</span><br/><span class="hl-0"> </span><span class="hl-4">setMaxListeners</span><span class="hl-0">(</span><span class="hl-8">11</span><span class="hl-0">, </span><span class="hl-5">et</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-4">getMaxListeners</span><span class="hl-0">(</span><span class="hl-5">et</span><span class="hl-0">)); </span><span class="hl-6">// 11</span><br/><span class="hl-0">}</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">_DOMEventTarget</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v18.17.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.getMaxListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:341</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="isDisturbed" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>is<wbr/>Disturbed</span><a href="#isDisturbed" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="isDisturbed.isDisturbed-1"><span class="tsd-kind-call-signature">is<wbr/>Disturbed</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stream</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isDisturbed.isDisturbed-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>Returns whether the stream has been read from or cancelled.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">stream</span>: <span class="tsd-signature-type ">Readable</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">ReadableStream</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v16.8.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.isDisturbed</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:83</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span class="deprecated">listener<wbr/>Count</span><a href="#listenerCount-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="listenerCount-2.listenerCount-3"><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount-2.listenerCount-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><p>A class method that returns the number of listeners for the given <code>eventName</code>registered on the given <code>emitter</code>.</p>
|
||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-3">EventEmitter</span><span class="hl-0">, </span><span class="hl-3">listenerCount</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'events'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">myEmitter</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-5">myEmitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'event'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><span class="hl-5">myEmitter</span><span class="hl-0">.</span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-1">'event'</span><span class="hl-0">, () </span><span class="hl-2">=></span><span class="hl-0"> {});</span><br/><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-4">listenerCount</span><span class="hl-0">(</span><span class="hl-5">myEmitter</span><span class="hl-0">, </span><span class="hl-1">'event'</span><span class="hl-0">));</span><br/><span class="hl-6">// Prints: 2</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The emitter to query</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <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"><p>The event name</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v0.9.12</p>
|
||
|
||
<h4>Deprecated</h4><p>Since v3.2.0 - Use <code>listenerCount</code> instead.</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.listenerCount</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:284</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="on-13" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>on</span><a href="#on-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="on-13.on-14"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#on-13.on-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-3">on</span><span class="hl-0">, </span><span class="hl-3">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-0">(</span><span class="hl-2">async</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-3">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-0"> </span><span class="hl-6">// Emit later on</span><br/><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-4">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-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'foo'</span><span class="hl-0">, </span><span class="hl-1">'bar'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'foo'</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-9">for</span><span class="hl-0"> </span><span class="hl-9">await</span><span class="hl-0"> (</span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">event</span><span class="hl-0"> </span><span class="hl-2">of</span><span class="hl-0"> </span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">, </span><span class="hl-1">'foo'</span><span class="hl-0">)) {</span><br/><span class="hl-0"> </span><span class="hl-6">// The execution of this inner block is synchronous and it</span><br/><span class="hl-0"> </span><span class="hl-6">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-0"> </span><span class="hl-6">// if concurrent execution is required.</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">event</span><span class="hl-0">); </span><span class="hl-6">// prints ['bar'] [42]</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-6">// Unreachable here</span><br/><span class="hl-0">})();</span>
|
||
</code><button>Copy</button></pre>
|
||
<p>Returns an <code>AsyncIterator</code> that iterates <code>eventName</code> events. It will throw
|
||
if the <code>EventEmitter</code> emits <code>'error'</code>. It removes all listeners when
|
||
exiting the loop. The <code>value</code> returned by each iteration is an array
|
||
composed of the emitted event arguments.</p>
|
||
<p>An <code>AbortSignal</code> can be used to cancel waiting on events:</p>
|
||
<pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> { </span><span class="hl-3">on</span><span class="hl-0">, </span><span class="hl-3">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'events'</span><span class="hl-0">);</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">ac</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">AbortController</span><span class="hl-0">();</span><br/><br/><span class="hl-0">(</span><span class="hl-2">async</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-3">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-0"> </span><span class="hl-6">// Emit later on</span><br/><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-4">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-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'foo'</span><span class="hl-0">, </span><span class="hl-1">'bar'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'foo'</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-9">for</span><span class="hl-0"> </span><span class="hl-9">await</span><span class="hl-0"> (</span><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">event</span><span class="hl-0"> </span><span class="hl-2">of</span><span class="hl-0"> </span><span class="hl-4">on</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">, </span><span class="hl-1">'foo'</span><span class="hl-0">, { </span><span class="hl-5">signal:</span><span class="hl-0"> </span><span class="hl-5">ac</span><span class="hl-0">.</span><span class="hl-5">signal</span><span class="hl-0"> })) {</span><br/><span class="hl-0"> </span><span class="hl-6">// The execution of this inner block is synchronous and it</span><br/><span class="hl-0"> </span><span class="hl-6">// processes one event at a time (even with await). Do not use</span><br/><span class="hl-0"> </span><span class="hl-6">// if concurrent execution is required.</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">event</span><span class="hl-0">); </span><span class="hl-6">// prints ['bar'] [42]</span><br/><span class="hl-0"> }</span><br/><span class="hl-0"> </span><span class="hl-6">// Unreachable here</span><br/><span class="hl-0">})();</span><br/><br/><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-4">nextTick</span><span class="hl-0">(() </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">ac</span><span class="hl-0">.</span><span class="hl-4">abort</span><span class="hl-0">());</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">EventEmitter</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>The name of the event being listened for</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AsyncIterableIterator</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>that iterates <code>eventName</code> events emitted by the <code>emitter</code></p>
|
||
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v13.6.0, v12.16.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.on</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:263</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="once-13" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>once</span><a href="#once-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="once-13.once-14"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-13.once-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><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>
|
||
<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-3">once</span><span class="hl-0">, </span><span class="hl-3">EventEmitter</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'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-4">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-3">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-4">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-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'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-3">value</span><span class="hl-0">] = </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-4">once</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">, </span><span class="hl-1">'myevent'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-5">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-3">err</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">Error</span><span class="hl-0">(</span><span class="hl-1">'kaboom'</span><span class="hl-0">);</span><br/><span class="hl-0"> </span><span class="hl-5">process</span><span class="hl-0">.</span><span class="hl-4">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-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'error'</span><span class="hl-0">, </span><span class="hl-5">err</span><span class="hl-0">);</span><br/><span class="hl-0"> });</span><br/><br/><span class="hl-0"> </span><span class="hl-9">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-4">once</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">, </span><span class="hl-1">'myevent'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-9">catch</span><span class="hl-0"> (</span><span class="hl-5">err</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'error happened'</span><span class="hl-0">, </span><span class="hl-5">err</span><span class="hl-0">);</span><br/><span class="hl-0"> }</span><br/><span class="hl-0">}</span><br/><br/><span class="hl-4">run</span><span class="hl-0">();</span>
|
||
</code><button>Copy</button></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-3">EventEmitter</span><span class="hl-0">, </span><span class="hl-3">once</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-4">once</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">, </span><span class="hl-1">'error'</span><span class="hl-0">)</span><br/><span class="hl-0"> .</span><span class="hl-4">then</span><span class="hl-0">(([</span><span class="hl-5">err</span><span class="hl-0">]) </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'ok'</span><span class="hl-0">, </span><span class="hl-5">err</span><span class="hl-0">.</span><span class="hl-5">message</span><span class="hl-0">))</span><br/><span class="hl-0"> .</span><span class="hl-4">catch</span><span class="hl-0">((</span><span class="hl-5">err</span><span class="hl-0">) </span><span class="hl-2">=></span><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'error'</span><span class="hl-0">, </span><span class="hl-5">err</span><span class="hl-0">.</span><span class="hl-5">message</span><span class="hl-0">));</span><br/><br/><span class="hl-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'error'</span><span class="hl-0">, </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">Error</span><span class="hl-0">(</span><span class="hl-1">'boom'</span><span class="hl-0">));</span><br/><br/><span class="hl-6">// Prints: ok boom</span>
|
||
</code><button>Copy</button></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-3">EventEmitter</span><span class="hl-0">, </span><span class="hl-3">once</span><span class="hl-0"> } = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">ee</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">ac</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">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-4">foo</span><span class="hl-0">(</span><span class="hl-5">emitter</span><span class="hl-0">, </span><span class="hl-5">event</span><span class="hl-0">, </span><span class="hl-5">signal</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-9">try</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-9">await</span><span class="hl-0"> </span><span class="hl-4">once</span><span class="hl-0">(</span><span class="hl-5">emitter</span><span class="hl-0">, </span><span class="hl-5">event</span><span class="hl-0">, { </span><span class="hl-5">signal</span><span class="hl-0"> });</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">log</span><span class="hl-0">(</span><span class="hl-1">'event emitted!'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-9">catch</span><span class="hl-0"> (</span><span class="hl-5">error</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-9">if</span><span class="hl-0"> (</span><span class="hl-5">error</span><span class="hl-0">.</span><span class="hl-5">name</span><span class="hl-0"> === </span><span class="hl-1">'AbortError'</span><span class="hl-0">) {</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">error</span><span class="hl-0">(</span><span class="hl-1">'Waiting for the event was canceled!'</span><span class="hl-0">);</span><br/><span class="hl-0"> } </span><span class="hl-9">else</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-5">console</span><span class="hl-0">.</span><span class="hl-4">error</span><span class="hl-0">(</span><span class="hl-1">'There was an error'</span><span class="hl-0">, </span><span class="hl-5">error</span><span class="hl-0">.</span><span class="hl-5">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-4">foo</span><span class="hl-0">(</span><span class="hl-5">ee</span><span class="hl-0">, </span><span class="hl-1">'foo'</span><span class="hl-0">, </span><span class="hl-5">ac</span><span class="hl-0">.</span><span class="hl-5">signal</span><span class="hl-0">);</span><br/><span class="hl-5">ac</span><span class="hl-0">.</span><span class="hl-4">abort</span><span class="hl-0">(); </span><span class="hl-6">// Abort waiting for the event</span><br/><span class="hl-5">ee</span><span class="hl-0">.</span><span class="hl-4">emit</span><span class="hl-0">(</span><span class="hl-1">'foo'</span><span class="hl-0">); </span><span class="hl-6">// Prints: Waiting for the event was canceled!</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">_NodeEventTarget</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">symbol</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><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>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v11.13.0, v10.16.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:199</li></ul></aside></li>
|
||
<li class="tsd-signature tsd-anchor-link" id="once-13.once-15"><span class="tsd-kind-call-signature">once</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">emitter</span>, <span class="tsd-kind-parameter">eventName</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#once-13.once-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">emitter</span>: <span class="tsd-signature-type ">_DOMEventTarget</span></h5></li>
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">eventName</span>: <span class="tsd-signature-type">string</span></h5></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">StaticEventEmitterOptions</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><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><aside class="tsd-sources">
|
||
<p>Inherited from Transform.once</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:204</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="setMaxListeners-2" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>set<wbr/>Max<wbr/>Listeners</span><a href="#setMaxListeners-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="setMaxListeners-2.setMaxListeners-3"><span class="tsd-kind-call-signature">set<wbr/>Max<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">n</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setMaxListeners-2.setMaxListeners-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description">
|
||
<div class="tsd-comment tsd-typography"><pre><code class="language-js"><span class="hl-2">const</span><span class="hl-0"> {</span><br/><span class="hl-0"> </span><span class="hl-3">setMaxListeners</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">EventEmitter</span><br/><span class="hl-0">} = </span><span class="hl-4">require</span><span class="hl-0">(</span><span class="hl-1">'events'</span><span class="hl-0">);</span><br/><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">target</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventTarget</span><span class="hl-0">();</span><br/><span class="hl-2">const</span><span class="hl-0"> </span><span class="hl-3">emitter</span><span class="hl-0"> = </span><span class="hl-2">new</span><span class="hl-0"> </span><span class="hl-4">EventEmitter</span><span class="hl-0">();</span><br/><br/><span class="hl-4">setMaxListeners</span><span class="hl-0">(</span><span class="hl-8">5</span><span class="hl-0">, </span><span class="hl-5">target</span><span class="hl-0">, </span><span class="hl-5">emitter</span><span class="hl-0">);</span>
|
||
</code><button>Copy</button></pre>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">n</span>: <span class="tsd-signature-type">number</span></h5>
|
||
<div class="tsd-comment tsd-typography"><p>A non-negative number. The maximum number of listeners per <code>EventTarget</code> event.</p>
|
||
</div>
|
||
<div class="tsd-comment tsd-typography"></div></li>
|
||
<li>
|
||
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">eventTargets</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type ">EventEmitter</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">_DOMEventTarget</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v15.4.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.setMaxListeners</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/events.d.ts:359</li></ul></aside></li></ul></section>
|
||
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="toWeb" class="tsd-anchor"></a>
|
||
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>to<wbr/>Web</span><a href="#toWeb" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
||
<ul class="tsd-signatures tsd-is-inherited tsd-is-external">
|
||
<li class="tsd-signature tsd-anchor-link" id="toWeb.toWeb-1"><span class="tsd-kind-call-signature">to<wbr/>Web</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">streamReadable</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">ReadableStream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#toWeb.toWeb-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
||
<li class="tsd-description"><code class="tsd-tag ts-flagExperimental">Experimental</code>
|
||
<div class="tsd-comment tsd-typography"><p>A utility method for creating a web <code>ReadableStream</code> from a <code>Readable</code>.</p>
|
||
</div>
|
||
<div class="tsd-parameters">
|
||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
<ul class="tsd-parameter-list">
|
||
<li>
|
||
<h5><span class="tsd-kind-parameter">streamReadable</span>: <span class="tsd-signature-type ">Readable</span></h5></li></ul></div>
|
||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">ReadableStream</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||
<div class="tsd-comment tsd-typography">
|
||
<h4>Since</h4><p>v17.0.0</p>
|
||
</div><aside class="tsd-sources">
|
||
<p>Inherited from Transform.toWeb</p>
|
||
<ul>
|
||
<li>Defined in node_modules/@types/node/stream.d.ts:89</li></ul></aside></li></ul></section></section></div>
|
||
<div class="col-sidebar">
|
||
<div class="page-menu">
|
||
<div class="tsd-navigation settings">
|
||
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<div class="tsd-filter-visibility">
|
||
<h4 class="uppercase">Member Visibility</h4><form>
|
||
<ul id="tsd-filter-options">
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
|
||
<li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div>
|
||
<div class="tsd-theme-toggle">
|
||
<h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
|
||
<details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary">
|
||
<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary>
|
||
<div class="tsd-accordion-details">
|
||
<ul>
|
||
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
|
||
<li><a href="#allowHalfOpen" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>allow<wbr/>Half<wbr/>Open</span></a></li>
|
||
<li><a href="#closed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>closed</span></a></li>
|
||
<li><a href="#destroyed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>destroyed</span></a></li>
|
||
<li><a href="#errored" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>errored</span></a></li>
|
||
<li><a href="#readable" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable</span></a></li>
|
||
<li><a href="#readableAborted" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Aborted</span></a></li>
|
||
<li><a href="#readableDidRead" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Did<wbr/>Read</span></a></li>
|
||
<li><a href="#readableEncoding" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Encoding</span></a></li>
|
||
<li><a href="#readableEnded" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Ended</span></a></li>
|
||
<li><a href="#readableFlowing" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Flowing</span></a></li>
|
||
<li><a href="#readableHighWaterMark" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>High<wbr/>Water<wbr/>Mark</span></a></li>
|
||
<li><a href="#readableLength" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Length</span></a></li>
|
||
<li><a href="#readableObjectMode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>readable<wbr/>Object<wbr/>Mode</span></a></li>
|
||
<li><a href="#remainingRead" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>remaining<wbr/>Read</span></a></li>
|
||
<li><a href="#remainingSkip" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>remaining<wbr/>Skip</span></a></li>
|
||
<li><a href="#source" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>source</span></a></li>
|
||
<li><a href="#writable" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable</span></a></li>
|
||
<li><a href="#writableCorked" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Corked</span></a></li>
|
||
<li><a href="#writableEnded" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Ended</span></a></li>
|
||
<li><a href="#writableFinished" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Finished</span></a></li>
|
||
<li><a href="#writableHighWaterMark" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>High<wbr/>Water<wbr/>Mark</span></a></li>
|
||
<li><a href="#writableLength" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Length</span></a></li>
|
||
<li><a href="#writableNeedDrain" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Need<wbr/>Drain</span></a></li>
|
||
<li><a href="#writableObjectMode" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>writable<wbr/>Object<wbr/>Mode</span></a></li>
|
||
<li><a href="#captureRejectionSymbol" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>capture<wbr/>Rejection<wbr/>Symbol</span></a></li>
|
||
<li><a href="#captureRejections" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>capture<wbr/>Rejections</span></a></li>
|
||
<li><a href="#defaultMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>default<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#errorMonitor" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>error<wbr/>Monitor</span></a></li>
|
||
<li><a href="#_asyncDispose_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>[async<wbr/>Dispose]</span></a></li>
|
||
<li><a href="#_asyncIterator_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>[async<wbr/>Iterator]</span></a></li>
|
||
<li><a href="#_captureRejectionSymbol_" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>[capture<wbr/>Rejection<wbr/>Symbol]</span></a></li>
|
||
<li><a href="#_construct" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_construct</span></a></li>
|
||
<li><a href="#_destroy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_destroy</span></a></li>
|
||
<li><a href="#_final" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_final</span></a></li>
|
||
<li><a href="#_flush" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_flush</span></a></li>
|
||
<li><a href="#_read" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_read</span></a></li>
|
||
<li><a href="#_transform" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_transform</span></a></li>
|
||
<li><a href="#_write" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_write</span></a></li>
|
||
<li><a href="#_writev" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>_writev</span></a></li>
|
||
<li><a href="#addListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Listener</span></a></li>
|
||
<li><a href="#asIndexedPairs" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>as<wbr/>Indexed<wbr/>Pairs</span></a></li>
|
||
<li><a href="#binarySlice" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>binary<wbr/>Slice</span></a></li>
|
||
<li><a href="#checkEnd" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>check<wbr/>End</span></a></li>
|
||
<li><a href="#compose" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>compose</span></a></li>
|
||
<li><a href="#cork" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>cork</span></a></li>
|
||
<li><a href="#destroy" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>destroy</span></a></li>
|
||
<li><a href="#drop" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>drop</span></a></li>
|
||
<li><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>emit</span></a></li>
|
||
<li><a href="#end" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>end</span></a></li>
|
||
<li><a href="#eventNames" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>event<wbr/>Names</span></a></li>
|
||
<li><a href="#every" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>every</span></a></li>
|
||
<li><a href="#filter" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>filter</span></a></li>
|
||
<li><a href="#find" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>find</span></a></li>
|
||
<li><a href="#flatMap" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>flat<wbr/>Map</span></a></li>
|
||
<li><a href="#forEach" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>for<wbr/>Each</span></a></li>
|
||
<li><a href="#getMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#isPaused" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Paused</span></a></li>
|
||
<li><a href="#iterator" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>iterator</span></a></li>
|
||
<li><a href="#listenerCount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a></li>
|
||
<li><a href="#listeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listeners</span></a></li>
|
||
<li><a href="#map" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>map</span></a></li>
|
||
<li><a href="#objectSlice" class="tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>object<wbr/>Slice</span></a></li>
|
||
<li><a href="#off" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li>
|
||
<li><a href="#on" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
|
||
<li><a href="#once" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a></li>
|
||
<li><a href="#pause" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pause</span></a></li>
|
||
<li><a href="#pipe" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>pipe</span></a></li>
|
||
<li><a href="#prependListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Listener</span></a></li>
|
||
<li><a href="#prependOnceListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>prepend<wbr/>Once<wbr/>Listener</span></a></li>
|
||
<li><a href="#push" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>push</span></a></li>
|
||
<li><a href="#rawListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>raw<wbr/>Listeners</span></a></li>
|
||
<li><a href="#read" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>read</span></a></li>
|
||
<li><a href="#reduce" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reduce</span></a></li>
|
||
<li><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a></li>
|
||
<li><a href="#removeListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Listener</span></a></li>
|
||
<li><a href="#resume" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>resume</span></a></li>
|
||
<li><a href="#setDefaultEncoding" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Default<wbr/>Encoding</span></a></li>
|
||
<li><a href="#setEncoding" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Encoding</span></a></li>
|
||
<li><a href="#setMaxListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#some" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>some</span></a></li>
|
||
<li><a href="#take" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>take</span></a></li>
|
||
<li><a href="#toArray" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>Array</span></a></li>
|
||
<li><a href="#uncork" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>uncork</span></a></li>
|
||
<li><a href="#unpipe" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unpipe</span></a></li>
|
||
<li><a href="#unshift" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unshift</span></a></li>
|
||
<li><a href="#wrap" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>wrap</span></a></li>
|
||
<li><a href="#write" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>write</span></a></li>
|
||
<li><a href="#addAbortListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Abort<wbr/>Listener</span></a></li>
|
||
<li><a href="#from" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from</span></a></li>
|
||
<li><a href="#fromWeb" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>from<wbr/>Web</span></a></li>
|
||
<li><a href="#getEventListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Event<wbr/>Listeners</span></a></li>
|
||
<li><a href="#getMaxListeners-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#isDisturbed" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Disturbed</span></a></li>
|
||
<li><a href="#listenerCount-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a></li>
|
||
<li><a href="#on-13" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
|
||
<li><a href="#once-13" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>once</span></a></li>
|
||
<li><a href="#setMaxListeners-2" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Max<wbr/>Listeners</span></a></li>
|
||
<li><a href="#toWeb" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>to<wbr/>Web</span></a></li></ul></div></details></div>
|
||
<div class="site-menu">
|
||
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>Community Solid Server - v7.0.1</span></a>
|
||
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
|
||
<li><a href="../enums/AccessMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>AccessMode</a></li>
|
||
<li><a href="../enums/AclMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg>AclMode</a></li>
|
||
<li><a href="AbsolutePathInteractionRoute.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AbsolutePathInteractionRoute</a></li>
|
||
<li><a href="AcceptPreferenceParser.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AcceptPreferenceParser</a></li>
|
||
<li><a href="AccessChecker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AccessChecker</a></li>
|
||
<li><a href="AccountInitializer.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AccountInitializer</a></li>
|
||
<li><a href="AccountPromptFactory.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AccountPromptFactory</a></li>
|
||
<li><a href="AcpHeaderHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AcpHeaderHandler</a></li>
|
||
<li><a href="AcpReader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AcpReader</a></li>
|
||
<li><a href="ActivityNotificationGenerator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ActivityNotificationGenerator</a></li>
|
||
<li><a href="AddRemoveNotificationGenerator.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AddRemoveNotificationGenerator</a></li>
|
||
<li><a href="AgentAccessChecker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AgentAccessChecker</a></li>
|
||
<li><a href="AgentClassAccessChecker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AgentClassAccessChecker</a></li>
|
||
<li><a href="AgentGroupAccessChecker.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AgentGroupAccessChecker</a></li>
|
||
<li><a href="AllStaticReader.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AllStaticReader</a></li>
|
||
<li><a href="AllowAcceptHeaderWriter.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AllowAcceptHeaderWriter</a></li>
|
||
<li><a href="App.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>App</a></li>
|
||
<li><a href="AppRunner.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AppRunner</a></li>
|
||
<li><a href="ArrayUnionHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ArrayUnionHandler</a></li>
|
||
<li><a href="AssetPathExtractor.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AssetPathExtractor</a></li>
|
||
<li><a href="AsyncHandler.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>AsyncHandler</a></li>
|
||
<li>Loading...</li></ul></nav></div></div></div>
|
||
<div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></g><g id="icon-search"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg></body></html> |