@toit/esptool.js
Version:
TypeScript port of the esptool
536 lines • 30.6 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Reader | @toit/esptool.js</title>
<meta name="description" content="Documentation for @toit/esptool.js">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</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">@toit/esptool.js</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@toit/esptool.js</a>
</li>
<li>
<a href="../modules/reader.html">reader</a>
</li>
<li>
<a href="reader.Reader.html">Reader</a>
</li>
</ul>
<h1>Class Reader</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="target">Reader</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"><a href="reader.Reader.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#buffer" class="tsd-kind-icon">buffer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#closing" class="tsd-kind-icon">closing</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#completer" class="tsd-kind-icon">completer</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#listenRef" class="tsd-kind-icon">listen<wbr>Ref</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#readableOwner" class="tsd-kind-icon">readable<wbr>Owner</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#reader" class="tsd-kind-icon">reader</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#runPromise" class="tsd-kind-icon">run<wbr>Promise</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#running" class="tsd-kind-icon">running</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"><a href="reader.Reader.html#listen" class="tsd-kind-icon">listen</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reader.Reader.html#packet" class="tsd-kind-icon">packet</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reader.Reader.html#read" class="tsd-kind-icon">read</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#run" class="tsd-kind-icon">run</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reader.Reader.html#start" class="tsd-kind-icon">start</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reader.Reader.html#stop" class="tsd-kind-icon">stop</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="reader.Reader.html#waitData" class="tsd-kind-icon">wait<wbr>Data</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="reader.Reader.html#waitSilent" class="tsd-kind-icon">wait<wbr>Silent</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">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Reader<span class="tsd-signature-symbol">(</span>readableOwner<span class="tsd-signature-symbol">: </span><a href="../interfaces/reader.ReadableOwner.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableOwner</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="reader.Reader.html" class="tsd-signature-type" data-tsd-kind="Class">Reader</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L32">reader.ts:32</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>readableOwner: <a href="../interfaces/reader.ReadableOwner.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableOwner</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="reader.Reader.html" class="tsd-signature-type" data-tsd-kind="Class">Reader</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="buffer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> buffer</h3>
<div class="tsd-signature tsd-kind-icon">buffer<span class="tsd-signature-symbol">:</span> <a href="util.Uint8Buffer.html" class="tsd-signature-type" data-tsd-kind="Class">Uint8Buffer</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L21">reader.ts:21</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="closing" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> closing</h3>
<div class="tsd-signature tsd-kind-icon">closing<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L25">reader.ts:25</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="completer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> completer</h3>
<div class="tsd-signature tsd-kind-icon">completer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="reader.Completer.html" class="tsd-signature-type" data-tsd-kind="Class">Completer</a><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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L28">reader.ts:28</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="listenRef" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> listen<wbr>Ref</h3>
<div class="tsd-signature tsd-kind-icon">listen<wbr>Ref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L30">reader.ts:30</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="readableOwner" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> readable<wbr>Owner</h3>
<div class="tsd-signature tsd-kind-icon">readable<wbr>Owner<span class="tsd-signature-symbol">:</span> <a href="../interfaces/reader.ReadableOwner.html" class="tsd-signature-type" data-tsd-kind="Interface">ReadableOwner</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L22">reader.ts:22</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="reader" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> reader</h3>
<div class="tsd-signature tsd-kind-icon">reader<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ReadableStreamDefaultReader</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L27">reader.ts:27</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="runPromise" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> run<wbr>Promise</h3>
<div class="tsd-signature tsd-kind-icon">run<wbr>Promise<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L29">reader.ts:29</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="running" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> running</h3>
<div class="tsd-signature tsd-kind-icon">running<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L24">reader.ts:24</a></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">
<a name="listen" class="tsd-anchor"></a>
<h3>listen</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">listen<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/reader.html#Unlisten" class="tsd-signature-type" data-tsd-kind="Type alias">Unlisten</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L124">reader.ts:124</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="../modules/reader.html#Unlisten" class="tsd-signature-type" data-tsd-kind="Type alias">Unlisten</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="packet" class="tsd-anchor"></a>
<h3>packet</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">packet<span class="tsd-signature-symbol">(</span>minLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, timeoutMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L183">reader.ts:183</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>minLength: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>timeoutMs: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="read" class="tsd-anchor"></a>
<h3>read</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">read<span class="tsd-signature-symbol">(</span>minLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, timeoutMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L174">reader.ts:174</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>minLength: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>timeoutMs: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Uint8Array</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-private">
<a name="run" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> run</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">run<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">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L69">reader.ts:69</a></li>
</ul>
</aside>
<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">
<a name="start" class="tsd-anchor"></a>
<h3>start</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L37">reader.ts:37</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="stop" class="tsd-anchor"></a>
<h3>stop</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">stop<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">unknown</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L47">reader.ts:47</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">unknown</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-private">
<a name="waitData" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> wait<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">wait<wbr>Data<span class="tsd-signature-symbol">(</span>minLength<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, timeoutMs<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</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">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L140">reader.ts:140</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>minLength: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>timeoutMs: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</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">
<a name="waitSilent" class="tsd-anchor"></a>
<h3>wait<wbr>Silent</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">wait<wbr>Silent<span class="tsd-signature-symbol">(</span>retry<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, timeoutMs<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/reader.ts#L158">reader.ts:158</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>retry: <span class="tsd-signature-type">number</span></h5>
</li>
<li>
<h5>timeoutMs: <span class="tsd-signature-type">number</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/errors.html">errors</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/index.html">index</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/reader.html">reader</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/stubs.html">stubs</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/util.html">util</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="reader.Completer.html" class="tsd-kind-icon">Completer</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="reader.Reader.html" class="tsd-kind-icon">Reader</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="reader.Reader.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#buffer" class="tsd-kind-icon">buffer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#closing" class="tsd-kind-icon">closing</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#completer" class="tsd-kind-icon">completer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#listenRef" class="tsd-kind-icon">listen<wbr>Ref</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#readableOwner" class="tsd-kind-icon">readable<wbr>Owner</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#reader" class="tsd-kind-icon">reader</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#runPromise" class="tsd-kind-icon">run<wbr>Promise</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#running" class="tsd-kind-icon">running</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reader.Reader.html#listen" class="tsd-kind-icon">listen</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reader.Reader.html#packet" class="tsd-kind-icon">packet</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reader.Reader.html#read" class="tsd-kind-icon">read</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#run" class="tsd-kind-icon">run</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reader.Reader.html#start" class="tsd-kind-icon">start</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reader.Reader.html#stop" class="tsd-kind-icon">stop</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="reader.Reader.html#waitData" class="tsd-kind-icon">wait<wbr>Data</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="reader.Reader.html#waitSilent" class="tsd-kind-icon">wait<wbr>Silent</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/reader.ReadableOwner.html" class="tsd-kind-icon">Readable<wbr>Owner</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/reader.html#Unlisten" class="tsd-kind-icon">Unlisten</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>