@substrate-system/bencode
Version:
Bencode de/encoder
17 lines (16 loc) • 34.8 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | @substrate-system/bencode</title><meta name="description" content="Documentation for @substrate-system/bencode"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@substrate-system/bencode</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@substrate-system/bencode</a></li><li><a href="../modules/decode.html">decode</a></li><li><a href="decode.default.html">default</a></li></ul><h1>Function default</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Decode bencoded data.</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-data" class="tsd-anchor"></a>Param: data<a href="#param-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The buffer to decode</p>
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-start" class="tsd-anchor"></a>Param: start<a href="#param-start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Optional start index</p>
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-end" class="tsd-anchor"></a>Param: end<a href="#param-end" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Optional end index</p>
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link"><a id="param-encoding" class="tsd-anchor"></a>Param: encoding<a href="#param-encoding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Optional encoding type (utf8, etc)</p>
</div><div class="tsd-tag-returns"><h4 class="tsd-anchor-link"><a id="returns" class="tsd-anchor"></a>Returns<a href="#returns" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4></div></div></section><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L43">decode.ts:43</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L78">decode.ts:78</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L79">decode.ts:79</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L80">decode.ts:80</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L81">decode.ts:81</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L83">decode.ts:83</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L96">decode.ts:96</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L114">decode.ts:114</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L136">decode.ts:136</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L150">decode.ts:150</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L160">decode.ts:160</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="default-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a><a href="#default-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L43">decode.ts:43</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L78">decode.ts:78</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L79">decode.ts:79</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L80">decode.ts:80</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L81">decode.ts:81</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L83">decode.ts:83</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L96">decode.ts:96</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L114">decode.ts:114</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L136">decode.ts:136</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L150">decode.ts:150</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L160">decode.ts:160</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="default-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">start</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a><a href="#default-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L43">decode.ts:43</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L78">decode.ts:78</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L79">decode.ts:79</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L80">decode.ts:80</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L81">decode.ts:81</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L83">decode.ts:83</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L96">decode.ts:96</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L114">decode.ts:114</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L136">decode.ts:136</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L150">decode.ts:150</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L160">decode.ts:160</a></li></ul></aside></li><li class="tsd-signature tsd-anchor-link"><a id="default-3" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">start</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">end</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a><a href="#default-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">end</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../types/decode.Decoded.html" class="tsd-signature-type tsd-kind-type-alias">Decoded</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L43">decode.ts:43</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L78">decode.ts:78</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L79">decode.ts:79</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L80">decode.ts:80</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L81">decode.ts:81</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L83">decode.ts:83</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L96">decode.ts:96</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L114">decode.ts:114</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L136">decode.ts:136</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L150">decode.ts:150</a></li><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L160">decode.ts:160</a></li></ul></aside></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="decode.default.html#buffer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buffer</span></a>
<a href="decode.default.html#bytes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bytes</span></a>
<a href="decode.default.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
<a href="decode.default.html#dictionary" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dictionary</span></a>
<a href="decode.default.html#encoding" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encoding</span></a>
<a href="decode.default.html#find" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>find</span></a>
<a href="decode.default.html#integer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>integer</span></a>
<a href="decode.default.html#list" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list</span></a>
<a href="decode.default.html#next" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next</span></a>
<a href="decode.default.html#position" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position</span></a>
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="buffer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>buffer</span><a href="#buffer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L29">decode.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="bytes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>bytes</span><a href="#bytes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bytes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L23">decode.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ArrayBufferLike</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L22">decode.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="dictionary" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>dictionary</span><a href="#dictionary" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">dictionary</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L27">decode.ts:27</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="encoding" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>encoding</span><a href="#encoding" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">encoding</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L25">decode.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>find</span><a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">find</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">ch</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">null</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L30">decode.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="integer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>integer</span><a href="#integer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">integer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L31">decode.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="list" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>list</span><a href="#list" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">list</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L28">decode.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="next" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>next</span><a href="#next" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L26">decode.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="position" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>position</span><a href="#position" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">position</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/substrate-system/node-bencode/blob/c49f545e3948689e4c3cb91af3dca55c49cf34f8/src/decode.ts#L24">decode.ts:24</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#buffer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>buffer</span></a><a href="#bytes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bytes</span></a><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#dictionary" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>dictionary</span></a><a href="#encoding" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>encoding</span></a><a href="#find" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>find</span></a><a href="#integer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>integer</span></a><a href="#list" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>list</span></a><a href="#next" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>next</span></a><a href="#position" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@substrate-system/bencode</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>