Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

Commit

Permalink
docs: update documentation [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
aegir[bot] committed Aug 27, 2023
1 parent c59eeb5 commit 462c68d
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion functions/car-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h5><span class="tsd-kind-parameter">init</span>: <a href="../interfaces/CarInit
<h4 class="tsd-returns-title">Returns <a href="../interfaces/Car.html" class="tsd-signature-type tsd-kind-interface">Car</a></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L237">packages/car/src/index.ts:237</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L237">packages/car/src/index.ts:237</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
6 changes: 3 additions & 3 deletions interfaces/Car.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Car</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L97">packages/car/src/index.ts:97</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L97">packages/car/src/index.ts:97</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -65,7 +65,7 @@ <h4>Example</h4><pre><code class="language-typescript"><span class="hl-0">import
</code><button>Copy</button></pre>
</div></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L146">packages/car/src/index.ts:146</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L146">packages/car/src/index.ts:146</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="import" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>import</span><a href="#import" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">import</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reader</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div>
Expand All @@ -91,7 +91,7 @@ <h4>Example</h4><pre><code class="language-typescript"><span class="hl-0">import
</code><button>Copy</button></pre>
</div></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L118">packages/car/src/index.ts:118</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L118">packages/car/src/index.ts:118</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
4 changes: 2 additions & 2 deletions interfaces/CarComponents.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">CarComponents</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L72">packages/car/src/index.ts:72</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L72">packages/car/src/index.ts:72</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -36,7 +36,7 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><span>blockstore</span><a href="#blockstore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">blockstore</span><span class="tsd-signature-symbol">:</span> <a href="unknown.Blocks.html" class="tsd-signature-type tsd-kind-interface">Blocks</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L73">packages/car/src/index.ts:73</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L73">packages/car/src/index.ts:73</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
4 changes: 2 additions & 2 deletions interfaces/CarInit.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">CarInit</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L76">packages/car/src/index.ts:76</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L76">packages/car/src/index.ts:76</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -41,7 +41,7 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
</div>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L82">packages/car/src/index.ts:82</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L82">packages/car/src/index.ts:82</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
6 changes: 3 additions & 3 deletions interfaces/DAGWalker.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">DAGWalker</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L88">packages/car/src/index.ts:88</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L88">packages/car/src/index.ts:88</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand All @@ -41,7 +41,7 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><span>codec</span><a href="#codec" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">codec</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/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L89">packages/car/src/index.ts:89</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L89">packages/car/src/index.ts:89</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="walk" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>walk</span><a href="#walk" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">walk</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">block</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="unknown.AsyncGenerator.html" class="tsd-signature-type tsd-kind-interface">AsyncGenerator</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/unknown.CID.html" class="tsd-signature-type tsd-kind-class">CID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="../types/unknown.Version.html" class="tsd-signature-type tsd-kind-type-alias">Version</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div>
Expand All @@ -59,7 +59,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><span class="tsd-kind-parameter">block</span>: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array" class="tsd-signature-type external" target="_blank">Uint8Array</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="unknown.AsyncGenerator.html" class="tsd-signature-type tsd-kind-interface">AsyncGenerator</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/unknown.CID.html" class="tsd-signature-type tsd-kind-class">CID</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><a href="../types/unknown.Version.html" class="tsd-signature-type tsd-kind-type-alias">Version</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></li></ul></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/546afef/packages/car/src/index.ts#L90">packages/car/src/index.ts:90</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia-car/blob/c8a2e7f/packages/car/src/index.ts#L90">packages/car/src/index.ts:90</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down

0 comments on commit 462c68d

Please sign in to comment.