pagespeed-quest
Version:
A framework for efficient web front-end speed improvement
716 lines (715 loc) • 448 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ThrottlingTransform | pagespeed-quest</title>
<meta name="description" content="Documentation for pagespeed-quest">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">pagespeed-quest</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="throttlingtransform.html">ThrottlingTransform</a>
</li>
</ul>
<h1>Class ThrottlingTransform</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">Transform</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">ThrottlingTransform</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><span class="tsd-signature-type">ReadableStream</span></li>
<li><span class="tsd-signature-type">WritableBase</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="throttlingtransform.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#allowhalfopen" class="tsd-kind-icon">allow<wbr>Half<wbr>Open</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#closed" class="tsd-kind-icon">closed</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#destroyed" class="tsd-kind-icon">destroyed</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#errored" class="tsd-kind-icon">errored</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readable" class="tsd-kind-icon">readable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readableaborted" class="tsd-kind-icon">readable<wbr>Aborted</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readabledidread" class="tsd-kind-icon">readable<wbr>Did<wbr>Read</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readableencoding" class="tsd-kind-icon">readable<wbr>Encoding</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readableended" class="tsd-kind-icon">readable<wbr>Ended</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readableflowing" class="tsd-kind-icon">readable<wbr>Flowing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readablehighwatermark" class="tsd-kind-icon">readable<wbr>High<wbr>Water<wbr>Mark</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readablelength" class="tsd-kind-icon">readable<wbr>Length</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#readableobjectmode" class="tsd-kind-icon">readable<wbr>Object<wbr>Mode</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="throttlingtransform.html#retryintervalms" class="tsd-kind-icon">retry<wbr>Interval<wbr>Ms</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="throttlingtransform.html#throttle" class="tsd-kind-icon">throttle</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writable" class="tsd-kind-icon">writable</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writablecorked" class="tsd-kind-icon">writable<wbr>Corked</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writableended" class="tsd-kind-icon">writable<wbr>Ended</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writablefinished" class="tsd-kind-icon">writable<wbr>Finished</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writablehighwatermark" class="tsd-kind-icon">writable<wbr>High<wbr>Water<wbr>Mark</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writablelength" class="tsd-kind-icon">writable<wbr>Length</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writableneeddrain" class="tsd-kind-icon">writable<wbr>Need<wbr>Drain</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#writableobjectmode" class="tsd-kind-icon">writable<wbr>Object<wbr>Mode</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#_eventemitter_capturerejectionsymbol_" class="tsd-kind-icon">[<wbr>Event<wbr>Emitter.capture<wbr>Rejection<wbr>Symbol]</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_symbol_asyncdispose_" class="tsd-kind-icon">[<wbr>Symbol.async<wbr>Dispose]</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_symbol_asynciterator_" class="tsd-kind-icon">[<wbr>Symbol.async<wbr>Iterator]</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_construct" class="tsd-kind-icon">_construct</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#_destroy" class="tsd-kind-icon">_destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_final" class="tsd-kind-icon">_final</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_flush" class="tsd-kind-icon">_flush</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_read" class="tsd-kind-icon">_read</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="throttlingtransform.html#_transform" class="tsd-kind-icon">_transform</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_write" class="tsd-kind-icon">_write</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#_writev" class="tsd-kind-icon">_writev</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#addlistener" class="tsd-kind-icon">add<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#asindexedpairs" class="tsd-kind-icon">as<wbr>Indexed<wbr>Pairs</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#compose" class="tsd-kind-icon">compose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#cork" class="tsd-kind-icon">cork</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#destroy" class="tsd-kind-icon">destroy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#drop" class="tsd-kind-icon">drop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#emit" class="tsd-kind-icon">emit</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#end" class="tsd-kind-icon">end</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#eventnames" class="tsd-kind-icon">event<wbr>Names</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#every" class="tsd-kind-icon">every</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#filter" class="tsd-kind-icon">filter</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#find" class="tsd-kind-icon">find</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#flatmap" class="tsd-kind-icon">flat<wbr>Map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#foreach" class="tsd-kind-icon">for<wbr>Each</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#getmaxlisteners" class="tsd-kind-icon">get<wbr>Max<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#ispaused" class="tsd-kind-icon">is<wbr>Paused</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#iterator" class="tsd-kind-icon">iterator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#listenercount" class="tsd-kind-icon">listener<wbr>Count</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#listeners" class="tsd-kind-icon">listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#map" class="tsd-kind-icon">map</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#off" class="tsd-kind-icon">off</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#on" class="tsd-kind-icon">on</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#once" class="tsd-kind-icon">once</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#pause" class="tsd-kind-icon">pause</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#pipe" class="tsd-kind-icon">pipe</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#prependlistener" class="tsd-kind-icon">prepend<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#prependoncelistener" class="tsd-kind-icon">prepend<wbr>Once<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#push" class="tsd-kind-icon">push</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#rawlisteners" class="tsd-kind-icon">raw<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#read" class="tsd-kind-icon">read</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited"><a href="throttlingtransform.html#reduce" class="tsd-kind-icon">reduce</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#removealllisteners" class="tsd-kind-icon">remove<wbr>All<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="throttlingtransform.html#removelistener" class="tsd-kind-icon">remove<wbr>Listener</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#resume" class="tsd-kind-icon">resume</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#setdefaultencoding" class="tsd-kind-icon">set<wbr>Default<wbr>Encoding</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#setencoding" class="tsd-kind-icon">set<wbr>Encoding</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#setmaxlisteners" class="tsd-kind-icon">set<wbr>Max<wbr>Listeners</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#some" class="tsd-kind-icon">some</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#take" class="tsd-kind-icon">take</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#toarray" class="tsd-kind-icon">to<wbr>Array</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#uncork" class="tsd-kind-icon">uncork</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#unpipe" class="tsd-kind-icon">unpipe</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#unshift" class="tsd-kind-icon">unshift</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#wrap" class="tsd-kind-icon">wrap</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="throttlingtransform.html#write" class="tsd-kind-icon">write</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited tsd-is-static"><a href="throttlingtransform.html#from" class="tsd-kind-icon">from</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="throttlingtransform.html#fromweb" class="tsd-kind-icon">from<wbr>Web</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="throttlingtransform.html#isdisturbed" class="tsd-kind-icon">is<wbr>Disturbed</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited tsd-is-static"><a href="throttlingtransform.html#toweb" class="tsd-kind-icon">to<wbr>Web</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Throttling<wbr>Transform<span class="tsd-signature-symbol">(</span>throttle<span class="tsd-signature-symbol">: </span><a href="throttle.html" class="tsd-signature-type">Throttle</a>, retryIntervalMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="throttlingtransform.html" class="tsd-signature-type">ThrottlingTransform</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Overrides Transform.__constructor</p>
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/throttling.ts#L77">src/throttling.ts:77</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>throttle: <a href="throttle.html" class="tsd-signature-type">Throttle</a></h5>
</li>
<li>
<h5>retryIntervalMs: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="throttlingtransform.html" class="tsd-signature-type">ThrottlingTransform</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="allowhalfopen" class="tsd-anchor"></a>
<h3>allow<wbr>Half<wbr>Open</h3>
<div class="tsd-signature tsd-kind-icon">allow<wbr>Half<wbr>Open<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#allowhalfopen">allowHalfOpen</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1076</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If <code>false</code> then the stream will automatically end the writable side when the
readable side ends. Set initially by the <code>allowHalfOpen</code> constructor option,
which defaults to <code>true</code>.</p>
</div>
<p>This can be changed manually to change the half-open behavior of an existing
<code>Duplex</code> stream instance, but must be changed before the <code>'end'</code> event is emitted.</p>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v0.9.4</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a name="closed" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> closed</h3>
<div class="tsd-signature tsd-kind-icon">closed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#closed">closed</a></p>
<p>Overrides ReadableBase.closed</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1065</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="destroyed" class="tsd-anchor"></a>
<h3>destroyed</h3>
<div class="tsd-signature tsd-kind-icon">destroyed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#destroyed">destroyed</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:121</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Is <code>true</code> after <code>readable.destroy()</code> has been called.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v8.0.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
<a name="errored" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> errored</h3>
<div class="tsd-signature tsd-kind-icon">errored<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#errored">errored</a></p>
<p>Overrides ReadableBase.errored</p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1066</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readable" class="tsd-anchor"></a>
<h3>readable</h3>
<div class="tsd-signature tsd-kind-icon">readable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readable">readable</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:77</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Is <code>true</code> if it is safe to call <a href="throttlingtransform.html#read">read</a>, which means
the stream has not been destroyed or emitted <code>'error'</code> or <code>'end'</code>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v11.4.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readableaborted" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>Aborted</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Aborted<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readableaborted">readableAborted</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:71</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns whether the stream was destroyed or errored before emitting <code>'end'</code>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v16.8.0</p>
</dd>
<dt>experimental</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readabledidread" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>Did<wbr>Read</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Did<wbr>Read<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readabledidread">readableDidRead</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:83</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns whether <code>'data'</code> has been emitted.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v16.7.0, v14.18.0</p>
</dd>
<dt>experimental</dt>
<dd></dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readableencoding" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>Encoding</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Encoding<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">BufferEncoding</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readableencoding">readableEncoding</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:88</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Getter for the property <code>encoding</code> of a given <code>Readable</code> stream. The <code>encoding</code> property can be set using the <a href="throttlingtransform.html#setencoding">setEncoding</a> method.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v12.7.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readableended" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>Ended</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readableended">readableEnded</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:93</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Becomes <code>true</code> when <a href="https://nodejs.org/docs/latest-v20.x/api/stream.html#event-end"><code>'end'</code></a> event is emitted.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v12.9.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readableflowing" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>Flowing</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Flowing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readableflowing">readableFlowing</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:99</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This property reflects the current state of a <code>Readable</code> stream as described
in the <a href="https://nodejs.org/docs/latest-v20.x/api/stream.html#three-states">Three states</a> section.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v9.4.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readablehighwatermark" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>High<wbr>Water<wbr>Mark</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>High<wbr>Water<wbr>Mark<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readablehighwatermark">readableHighWaterMark</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:104</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns the value of <code>highWaterMark</code> passed when creating this <code>Readable</code>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v9.3.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readablelength" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>Length</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readablelength">readableLength</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:111</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This property contains the number of bytes (or objects) in the queue
ready to be read. The value provides introspection data regarding
the status of the <code>highWaterMark</code>.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v9.4.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="readableobjectmode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> readable<wbr>Object<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Object<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#readableobjectmode">readableObjectMode</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:116</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Getter for the property <code>objectMode</code> of a given <code>Readable</code> stream.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v12.3.0</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="retryintervalms" class="tsd-anchor"></a>
<h3>retry<wbr>Interval<wbr>Ms</h3>
<div class="tsd-signature tsd-kind-icon">retry<wbr>Interval<wbr>Ms<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/ideamans/pagespeed-quest/blob/8dbbaab/src/throttling.ts#L77">src/throttling.ts:77</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="throttle" class="tsd-anchor"></a>
<h3>throttle</h3>
<div class="tsd-signature tsd-kind-icon">throttle<span class="tsd-signature-symbol">:</span> <a href="throttle.html" class="tsd-signature-type">Throttle</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ideamans/pagespeed-quest/blob/8dbbaab/src/throttling.ts#L76">src/throttling.ts:76</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writable" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable</h3>
<div class="tsd-signature tsd-kind-icon">writable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writable">writable</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1057</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writablecorked" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr>Corked</h3>
<div class="tsd-signature tsd-kind-icon">writable<wbr>Corked<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writablecorked">writableCorked</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1063</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writableended" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr>Ended</h3>
<div class="tsd-signature tsd-kind-icon">writable<wbr>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writableended">writableEnded</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1058</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writablefinished" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr>Finished</h3>
<div class="tsd-signature tsd-kind-icon">writable<wbr>Finished<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writablefinished">writableFinished</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1059</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writablehighwatermark" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr>High<wbr>Water<wbr>Mark</h3>
<div class="tsd-signature tsd-kind-icon">writable<wbr>High<wbr>Water<wbr>Mark<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writablehighwatermark">writableHighWaterMark</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1060</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writablelength" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr>Length</h3>
<div class="tsd-signature tsd-kind-icon">writable<wbr>Length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writablelength">writableLength</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1061</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writableneeddrain" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr>Need<wbr>Drain</h3>
<div class="tsd-signature tsd-kind-icon">writable<wbr>Need<wbr>Drain<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writableneeddrain">writableNeedDrain</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1064</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
<a name="writableobjectmode" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> writable<wbr>Object<wbr>Mode</h3>
<div class="tsd-signature tsd-kind-icon">writable<wbr>Object<wbr>Mode<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#writableobjectmode">writableObjectMode</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:1062</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<a name="_eventemitter_capturerejectionsymbol_" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> [<wbr>Event<wbr>Emitter.capture<wbr>Rejection<wbr>Symbol]</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">[<wbr>Event<wbr>Emitter.capture<wbr>Rejection<wbr>Symbol]<K><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Error</span>, event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultEventMap</span><span class="tsd-signature-symbol">></span>, <span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Args</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultEventMap</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#_eventemitter_capturerejectionsymbol_">[EventEmitter.captureRejectionSymbol]</a></p>
<ul>
<li>Defined in node_modules/@types/node/events.d.ts:592</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>K</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>error: <span class="tsd-signature-type">Error</span></h5>
</li>
<li>
<h5>event: <span class="tsd-signature-type">Key</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultEventMap</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">Args</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">K</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">DefaultEventMap</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="_symbol_asyncdispose_" class="tsd-anchor"></a>
<h3>[<wbr>Symbol.async<wbr>Dispose]</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">[<wbr>Symbol.async<wbr>Dispose]<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#_symbol_asyncdispose_">[Symbol.asyncDispose]</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:659</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calls <code>readable.destroy()</code> with an <code>AbortError</code> and returns a promise that fulfills when the stream is finished.</p>
</div>
<dl class="tsd-comment-tags">
<dt>since</dt>
<dd><p>v20.4.0</p>
</dd>
</dl>
</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>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="_symbol_asynciterator_" class="tsd-anchor"></a>
<h3>[<wbr>Symbol.async<wbr>Iterator]</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">[<wbr>Symbol.async<wbr>Iterator]<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#_symbol_asynciterator_">[Symbol.asyncIterator]</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:654</li>
</ul>
</aside>
<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>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="_construct" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> _construct</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">_construct<span class="tsd-signature-symbol">(</span>callback<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="throttlingtransform.html">ThrottlingTransform</a>.<a href="throttlingtransform.html#_construct">_construct</a></p>
<ul>
<li>Defined in node_modules/@types/node/stream.d.ts:133</li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>callback: <span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> error: <span class="tsd-signature-type">Error</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>