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 Feb 29, 2024
1 parent 349a9e6 commit 95659cd
Show file tree
Hide file tree
Showing 14 changed files with 26 additions and 28 deletions.
2 changes: 1 addition & 1 deletion functions/createVerifiedFetch.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions functions/verifiedFetch-1.html

Large diffs are not rendered by default.

14 changes: 6 additions & 8 deletions index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions interfaces/CIDDetail.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions interfaces/CIDDetailError.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion interfaces/ContentTypeParser.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions interfaces/CreateVerifiedFetchInit.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions interfaces/CreateVerifiedFetchOptions.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions interfaces/ResourceDetail.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions interfaces/VerifiedFetch.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion interfaces/VerifiedFetchInit.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<p>This interface contains all the same fields as the <a href="https://developer.mozilla.org/en-US/docs/Web/API/fetch#options">options object</a>
passed to <code>fetch</code> in browsers, plus an <code>onProgress</code> option to listen for
progress events.</p>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">VerifiedFetchInit</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#body">body</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BodyInit</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#cache">cache</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCache</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#credentials">credentials</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCredentials</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#headers">headers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">HeadersInit</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#integrity">integrity</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#keepalive">keepalive</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#method">method</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#mode">mode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestMode</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#onProgress">onProgress</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#redirect">redirect</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestRedirect</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#referrer">referrer</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#referrerPolicy">referrerPolicy</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReferrerPolicy</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#signal">signal</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="https://developer.mozilla.org/docs/Web/API/AbortSignal" class="tsd-signature-type external" target="_blank">AbortSignal</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#window">window</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">RequestInit</span></li><li><a href="https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html" class="tsd-signature-type external" target="_blank">ProgressOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/BubbledProgressEvents.html" class="tsd-signature-type tsd-kind-type-alias">BubbledProgressEvents</a><span class="tsd-signature-symbol"> | </span><a href="../types/VerifiedFetchProgressEvents.html" class="tsd-signature-type tsd-kind-type-alias">VerifiedFetchProgressEvents</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">VerifiedFetchInit</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-verified-fetch/blob/a584a1a/packages/verified-fetch/src/index.ts#L597">packages/verified-fetch/src/index.ts:597</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"><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="#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="VerifiedFetchInit.html#body" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>body?</span></a>
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">VerifiedFetchInit</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#body">body</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">BodyInit</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#cache">cache</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCache</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#credentials">credentials</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestCredentials</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#headers">headers</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">HeadersInit</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#integrity">integrity</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#keepalive">keepalive</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#method">method</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#mode">mode</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestMode</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#onProgress">onProgress</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">evt</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#redirect">redirect</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestRedirect</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#referrer">referrer</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#referrerPolicy">referrerPolicy</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ReferrerPolicy</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#signal">signal</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="https://developer.mozilla.org/docs/Web/API/AbortSignal" class="tsd-signature-type external" target="_blank">AbortSignal</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VerifiedFetchInit.html#window">window</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">RequestInit</span></li><li><a href="https://achingbrain.github.io/progress-events/interfaces/ProgressOptions.html" class="tsd-signature-type external" target="_blank">ProgressOptions</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/BubbledProgressEvents.html" class="tsd-signature-type tsd-kind-type-alias">BubbledProgressEvents</a><span class="tsd-signature-symbol"> | </span><a href="../types/VerifiedFetchProgressEvents.html" class="tsd-signature-type tsd-kind-type-alias">VerifiedFetchProgressEvents</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">VerifiedFetchInit</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-verified-fetch/blob/8fb4a76/packages/verified-fetch/src/index.ts#L597">packages/verified-fetch/src/index.ts:597</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"><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="#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="VerifiedFetchInit.html#body" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>body?</span></a>
<a href="VerifiedFetchInit.html#cache" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>cache?</span></a>
<a href="VerifiedFetchInit.html#credentials" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>credentials?</span></a>
<a href="VerifiedFetchInit.html#headers" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>headers?</span></a>
Expand Down
2 changes: 1 addition & 1 deletion types/BubbledProgressEvents.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion types/Resource.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion types/VerifiedFetchProgressEvents.html

Large diffs are not rendered by default.

0 comments on commit 95659cd

Please sign in to comment.