Skip to content

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 16, 2023
1 parent 0e728df commit ed6551b
Show file tree
Hide file tree
Showing 28 changed files with 58 additions and 58 deletions.
4 changes: 2 additions & 2 deletions functions/helia.createHelia.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h5><span class="tsd-kind-parameter">init</span>: <a href="../interfaces/helia.H
<h4 class="tsd-returns-title">Returns <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><a href="../interfaces/helia.Helia.html" class="tsd-signature-type tsd-kind-interface">Helia</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/helia/src/index.ts#L121">packages/helia/src/index.ts:121</a></li></ul></aside></li>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/helia/src/index.ts#L121">packages/helia/src/index.ts:121</a></li></ul></aside></li>
<li class="tsd-signature tsd-anchor-link" id="createHelia-1"><span class="tsd-kind-call-signature">create<wbr/>Helia</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">init</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </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><a href="../interfaces/helia.Helia.html" class="tsd-signature-type tsd-kind-interface">Helia</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/helia.unknown.Libp2p.html" class="tsd-signature-type tsd-kind-interface">Libp2p</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">dht</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/helia.unknown.DualKadDHT.html" class="tsd-signature-type tsd-kind-interface">DualKadDHT</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pubsub</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/helia.unknown.PubSub.html" class="tsd-signature-type tsd-kind-interface">PubSub</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#createHelia-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
<li class="tsd-description">
<div class="tsd-parameters">
Expand All @@ -45,7 +45,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">init</span>: <a href="../interfaces/helia.HeliaInit.html" class="tsd-signature-type tsd-kind-interface">HeliaInit</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/helia.unknown.Libp2p.html" class="tsd-signature-type tsd-kind-interface">Libp2p</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">dht</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/helia.unknown.DualKadDHT.html" class="tsd-signature-type tsd-kind-interface">DualKadDHT</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pubsub</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/helia.unknown.PubSub.html" class="tsd-signature-type tsd-kind-interface">PubSub</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/helia.unknown.PubSubEvents.html" class="tsd-signature-type tsd-kind-interface">PubSubEvents</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <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><a href="../interfaces/helia.Helia.html" class="tsd-signature-type tsd-kind-interface">Helia</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/helia.unknown.Libp2p.html" class="tsd-signature-type tsd-kind-interface">Libp2p</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">dht</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/helia.unknown.DualKadDHT.html" class="tsd-signature-type tsd-kind-interface">DualKadDHT</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">pubsub</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/helia.unknown.PubSub.html" class="tsd-signature-type tsd-kind-interface">PubSub</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/helia/src/index.ts#L122">packages/helia/src/index.ts:122</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/helia/src/index.ts#L122">packages/helia/src/index.ts:122</a></li></ul></aside></li></ul></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion interfaces/_helia_interface.blocks.Blocks.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">Blocks</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/interface/src/blocks.ts#L57">packages/interface/src/blocks.ts:57</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/interface/src/blocks.ts#L57">packages/interface/src/blocks.ts:57</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
4 changes: 2 additions & 2 deletions interfaces/_helia_interface.blocks.GetOfflineOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">GetOfflineOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/interface/src/blocks.ts#L50">packages/interface/src/blocks.ts:50</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/interface/src/blocks.ts#L50">packages/interface/src/blocks.ts:50</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/blob/f3788f6/packages/interface/src/blocks.ts#L54">packages/interface/src/blocks.ts:54</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/interface/src/blocks.ts#L54">packages/interface/src/blocks.ts:54</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/_helia_interface.blocks.Pair.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Pair</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/interface/src/blocks.ts#L6">packages/interface/src/blocks.ts:6</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/interface/src/blocks.ts#L6">packages/interface/src/blocks.ts:6</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 @@ -39,12 +39,12 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><span>block</span><a href="#block" 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">block</span><span class="tsd-signature-symbol">:</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></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/interface/src/blocks.ts#L8">packages/interface/src/blocks.ts:8</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/interface/src/blocks.ts#L8">packages/interface/src/blocks.ts:8</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="cid" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>cid</span><a href="#cid" 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">cid</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_helia_interface.index.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/_helia_interface.index.unknown.Version.html" class="tsd-signature-type tsd-kind-type-alias">Version</a><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/interface/src/blocks.ts#L7">packages/interface/src/blocks.ts:7</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/interface/src/blocks.ts#L7">packages/interface/src/blocks.ts:7</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
2 changes: 1 addition & 1 deletion interfaces/_helia_interface.index.GCOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">GCOptions</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3788f6/packages/interface/src/index.ts#L70">packages/interface/src/index.ts:70</a></li></ul></aside>
<li>Defined in <a href="https://github.com/ipfs/helia/blob/f3a49c0/packages/interface/src/index.ts#L70">packages/interface/src/index.ts:70</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
Loading

0 comments on commit ed6551b

Please sign in to comment.