UNPKG

@toit/esptool.js

Version:
629 lines 32.5 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Uint8Buffer | @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/util.html">util</a> </li> <li> <a href="util.Uint8Buffer.html">Uint8Buffer</a> </li> </ul> <h1>Class Uint8Buffer</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">Uint8Buffer</span> <ul class="tsd-hierarchy"> <li> <a href="util.Uint8BufferSlipEncode.html" class="tsd-signature-type" data-tsd-kind="Class">Uint8BufferSlipEncode</a> </li> </ul> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="util.Uint8Buffer.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="util.Uint8Buffer.html#_buffer" class="tsd-kind-icon">_buffer</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="util.Uint8Buffer.html#_view" class="tsd-kind-icon">_view</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="util.Uint8Buffer.html#readOffset" class="tsd-kind-icon">read<wbr>Offset</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="util.Uint8Buffer.html#size" class="tsd-kind-icon">size</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="util.Uint8Buffer.html#writeOffset" class="tsd-kind-icon">write<wbr>Offset</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Accessors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="util.Uint8Buffer.html#length" class="tsd-kind-icon">length</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="util.Uint8Buffer.html#copy" class="tsd-kind-icon">copy</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="util.Uint8Buffer.html#ensure" class="tsd-kind-icon">ensure</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="util.Uint8Buffer.html#fill" class="tsd-kind-icon">fill</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="util.Uint8Buffer.html#grow" class="tsd-kind-icon">grow</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="util.Uint8Buffer.html#pack" class="tsd-kind-icon">pack</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="util.Uint8Buffer.html#packet" class="tsd-kind-icon">packet</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="util.Uint8Buffer.html#push" class="tsd-kind-icon">push</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="util.Uint8Buffer.html#pushBytes" class="tsd-kind-icon">push<wbr>Bytes</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="util.Uint8Buffer.html#reset" class="tsd-kind-icon">reset</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="util.Uint8Buffer.html#shift" class="tsd-kind-icon">shift</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="util.Uint8Buffer.html#view" class="tsd-kind-icon">view</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>Uint8<wbr>Buffer<span class="tsd-signature-symbol">(</span>size<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="util.Uint8Buffer.html" class="tsd-signature-type" data-tsd-kind="Class">Uint8Buffer</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/util.ts#L17">util.ts:17</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>size: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 64</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="util.Uint8Buffer.html" class="tsd-signature-type" data-tsd-kind="Class">Uint8Buffer</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> <span class="tsd-signature-type">ArrayBuffer</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/util.ts#L14">util.ts:14</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="_view" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> _view</h3> <div class="tsd-signature tsd-kind-icon">_view<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Uint8Array</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/util.ts#L15">util.ts:15</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="readOffset" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> read<wbr>Offset</h3> <div class="tsd-signature tsd-kind-icon">read<wbr>Offset<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/util.ts#L10">util.ts:10</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="size" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> size</h3> <div class="tsd-signature tsd-kind-icon">size<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/toitware/esptool.js/blob/ba304a7/src/util.ts#L12">util.ts:12</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="writeOffset" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> write<wbr>Offset</h3> <div class="tsd-signature tsd-kind-icon">write<wbr>Offset<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/util.ts#L11">util.ts:11</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Accessors</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class"> <a name="length" class="tsd-anchor"></a> <h3>length</h3> <ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> length<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/util.ts#L23">util.ts:23</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </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="copy" class="tsd-anchor"></a> <h3>copy</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">copy<span class="tsd-signature-symbol">(</span>bytes<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><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/util.ts#L104">util.ts:104</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>bytes: <span class="tsd-signature-type">Uint8Array</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-private"> <a name="ensure" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> ensure</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">ensure<span class="tsd-signature-symbol">(</span>length<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/util.ts#L49">util.ts:49</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>length: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="fill" class="tsd-anchor"></a> <h3>fill</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">fill<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, length<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/util.ts#L43">util.ts:43</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>element: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>length: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 1</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-private"> <a name="grow" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> grow</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">grow<span class="tsd-signature-symbol">(</span>newSize<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/util.ts#L34">util.ts:34</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>newSize: <span class="tsd-signature-type">number</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="pack" class="tsd-anchor"></a> <h3>pack</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">pack<span class="tsd-signature-symbol">(</span>format<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, <span class="tsd-signature-symbol">...</span>args<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-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/util.ts#L66">util.ts:66</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>format: <span class="tsd-signature-type">string</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">number</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"> <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><span class="tsd-signature-symbol">)</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">Uint8Array</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/util.ts#L114">util.ts:114</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <dl class="tsd-comment-tags"> <dt>name</dt> <dd><p>packet returns the bytes between two 0xc0 bytes.</p> </dd> </dl> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="push" class="tsd-anchor"></a> <h3>push</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">push<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>bytes<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-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/util.ts#L98">util.ts:98</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>bytes: <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">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a name="pushBytes" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> push<wbr>Bytes</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private"> <li class="tsd-signature tsd-kind-icon">push<wbr>Bytes<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, byteCount<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, littleEndian<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/toitware/esptool.js/blob/ba304a7/src/util.ts#L56">util.ts:56</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>value: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>byteCount: <span class="tsd-signature-type">number</span></h5> </li> <li> <h5>littleEndian: <span class="tsd-signature-type">boolean</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="reset" class="tsd-anchor"></a> <h3>reset</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">reset<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/util.ts#L93">util.ts:93</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="shift" class="tsd-anchor"></a> <h3>shift</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">shift<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</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">number</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/util.ts#L27">util.ts:27</a></li> </ul> </aside> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="view" class="tsd-anchor"></a> <h3>view</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">view<span class="tsd-signature-symbol">(</span>reset<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</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/util.ts#L144">util.ts:144</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>reset: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Uint8Array</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=" 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="current tsd-kind-module"> <a href="../modules/util.html">util</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module"> <a href="util.Uint8Buffer.html" class="tsd-kind-icon">Uint8<wbr>Buffer</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#_buffer" class="tsd-kind-icon">_buffer</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#_view" class="tsd-kind-icon">_view</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#readOffset" class="tsd-kind-icon">read<wbr>Offset</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#size" class="tsd-kind-icon">size</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#writeOffset" class="tsd-kind-icon">write<wbr>Offset</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#length" class="tsd-kind-icon">length</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#copy" class="tsd-kind-icon">copy</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#ensure" class="tsd-kind-icon">ensure</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#fill" class="tsd-kind-icon">fill</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#grow" class="tsd-kind-icon">grow</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#pack" class="tsd-kind-icon">pack</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#packet" class="tsd-kind-icon">packet</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#push" class="tsd-kind-icon">push</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private"> <a href="util.Uint8Buffer.html#pushBytes" class="tsd-kind-icon">push<wbr>Bytes</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#reset" class="tsd-kind-icon">reset</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#shift" class="tsd-kind-icon">shift</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="util.Uint8Buffer.html#view" class="tsd-kind-icon">view</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="util.Uint8BufferSlipEncode.html" class="tsd-kind-icon">Uint8<wbr>Buffer<wbr>Slip<wbr>Encode</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/util.html#isTransientError" class="tsd-kind-icon">is<wbr>Transient<wbr>Error</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/util.html#sleep" class="tsd-kind-icon">sleep</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/util.html#toByteArray" class="tsd-kind-icon">to<wbr>Byte<wbr>Array</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="../modules/util.html#toHex" class="tsd-kind-icon">to<wbr>Hex</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>