docs: update documentation [skip ci]

ipfs · Aug 14, 2023 · ef6fe4d · ef6fe4d
1 parent 814ddfd
commit ef6fe4d
Show file tree

Hide file tree

Showing 39 changed files with 939 additions and 2,011 deletions.
diff --git a/assets/highlight.css b/assets/highlight.css
@@ -1,32 +1,32 @@
 :root {
-    --light-hl-0: #795E26;
-    --dark-hl-0: #DCDCAA;
+    --light-hl-0: #AF00DB;
+    --dark-hl-0: #C586C0;
     --light-hl-1: #000000;
     --dark-hl-1: #D4D4D4;
-    --light-hl-2: #A31515;
-    --dark-hl-2: #CE9178;
-    --light-hl-3: #800000;
-    --dark-hl-3: #808080;
-    --light-hl-4: #800000;
+    --light-hl-2: #001080;
+    --dark-hl-2: #9CDCFE;
+    --light-hl-3: #A31515;
+    --dark-hl-3: #CE9178;
+    --light-hl-4: #0000FF;
     --dark-hl-4: #569CD6;
-    --light-hl-5: #000000FF;
-    --dark-hl-5: #D4D4D4;
-    --light-hl-6: #E50000;
-    --dark-hl-6: #9CDCFE;
-    --light-hl-7: #0000FF;
-    --dark-hl-7: #CE9178;
-    --light-hl-8: #AF00DB;
-    --dark-hl-8: #C586C0;
-    --light-hl-9: #001080;
-    --dark-hl-9: #9CDCFE;
-    --light-hl-10: #0000FF;
+    --light-hl-5: #0070C1;
+    --dark-hl-5: #4FC1FF;
+    --light-hl-6: #795E26;
+    --dark-hl-6: #DCDCAA;
+    --light-hl-7: #008000;
+    --dark-hl-7: #6A9955;
+    --light-hl-8: #098658;
+    --dark-hl-8: #B5CEA8;
+    --light-hl-9: #800000;
+    --dark-hl-9: #808080;
+    --light-hl-10: #800000;
     --dark-hl-10: #569CD6;
-    --light-hl-11: #0070C1;
-    --dark-hl-11: #4FC1FF;
-    --light-hl-12: #008000;
-    --dark-hl-12: #6A9955;
-    --light-hl-13: #098658;
-    --dark-hl-13: #B5CEA8;
+    --light-hl-11: #000000FF;
+    --dark-hl-11: #D4D4D4;
+    --light-hl-12: #E50000;
+    --dark-hl-12: #9CDCFE;
+    --light-hl-13: #0000FF;
+    --dark-hl-13: #CE9178;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }

diff --git a/assets/search.js b/assets/search.js
diff --git a/classes/errors.AlreadyExistsError.html b/classes/errors.AlreadyExistsError.html
diff --git a/classes/errors.DoesNotExistError.html b/classes/errors.DoesNotExistError.html
diff --git a/classes/errors.InvalidPBNodeError.html b/classes/errors.InvalidPBNodeError.html
diff --git a/classes/errors.InvalidParametersError.html b/classes/errors.InvalidParametersError.html
diff --git a/classes/errors.NoContentError.html b/classes/errors.NoContentError.html
diff --git a/classes/errors.NotADirectoryError.html b/classes/errors.NotADirectoryError.html
diff --git a/classes/errors.NotAFileError.html b/classes/errors.NotAFileError.html
diff --git a/classes/errors.NotUnixFSError.html b/classes/errors.NotUnixFSError.html
diff --git a/classes/errors.UnixFSError.html b/classes/errors.UnixFSError.html
diff --git a/classes/errors.UnknownError.html b/classes/errors.UnknownError.html
diff --git a/functions/index.globSource.html → functions/_helia_unixfs.globSource.html b/functions/index.globSource.html → functions/_helia_unixfs.globSource.html
diff --git a/functions/index.unixfs-1.html → functions/_helia_unixfs.unixfs-1.html b/functions/index.unixfs-1.html → functions/_helia_unixfs.unixfs-1.html
diff --git a/functions/_helia_unixfs.urlSource.html b/functions/_helia_unixfs.urlSource.html
@@ -0,0 +1,77 @@
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>urlSource | Documentation</title><meta name="description" content="Documentation for Documentation"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
+<div class="tsd-toolbar-contents container">
+<div class="table-cell" id="tsd-search" data-base="..">
+<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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></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">Documentation</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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header>
+<div class="container container-main">
+<div class="col-8 col-content">
+<div class="tsd-page-title">
+<ul class="tsd-breadcrumb">
+<li><a href="../modules.html">Documentation</a></li>
+<li><a href="../modules/_helia_unixfs.html">@helia/unixfs</a></li>
+<li><a href="_helia_unixfs.urlSource.html">urlSource</a></li></ul>
+<h1>Function urlSource</h1></div>
+<section class="tsd-panel">
+<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
+<li class="tsd-signature tsd-anchor-link" id="urlSource">url<wbr/>Source<span class="tsd-signature-symbol">(</span>url<span class="tsd-signature-symbol">: </span><a href="https://developer.mozilla.org/en-US/docs/Web/API/URL" class="tsd-signature-type external" target="_blank">URL</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">RequestInit</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="https://ipfs.github.io/js-ipfs-unixfs/interfaces/ipfs_unixfs_importer.FileCandidate.html" class="tsd-signature-type external" target="_blank">FileCandidate</a><span class="tsd-signature-symbol">&lt;</span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator" class="tsd-signature-type external" target="_blank">AsyncGenerator</a><span class="tsd-signature-symbol">&lt;</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><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#urlSource" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></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" id="icon-anchor-c"></path></svg></a></li>
+<li class="tsd-description">
+<div class="tsd-parameters">
+<h4 class="tsd-parameters-title">Parameters</h4>
+<ul class="tsd-parameter-list">
+<li>
+<h5>url: <a href="https://developer.mozilla.org/en-US/docs/Web/API/URL" class="tsd-signature-type external" target="_blank">URL</a></h5></li>
+<li>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">RequestInit</span></h5></li></ul></div>
+<h4 class="tsd-returns-title">Returns <a href="https://ipfs.github.io/js-ipfs-unixfs/interfaces/ipfs_unixfs_importer.FileCandidate.html" class="tsd-signature-type external" target="_blank">FileCandidate</a><span class="tsd-signature-symbol">&lt;</span><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/AsyncGenerator" class="tsd-signature-type external" target="_blank">AsyncGenerator</a><span class="tsd-signature-symbol">&lt;</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><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</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-unixfs/blob/master/packages/unixfs/src/utils/url-source.ts#L4">unixfs/src/utils/url-source.ts:4</a></li></ul></aside></li></ul></section></div>
+<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
+<div class="tsd-navigation settings">
+<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary>
+<div class="tsd-accordion-details">
+<div class="tsd-filter-visibility">
+<h4 class="uppercase">Member Visibility</h4><form>
+<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-private" name="private"/><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>Private</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></form></div>
+<div class="tsd-theme-toggle">
+<h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
+<nav class="tsd-navigation primary">
+<details class="tsd-index-accordion" open><summary class="tsd-accordion-summary">
+<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary>
+<div class="tsd-accordion-details">
+<ul>
+<li class="current"><a href="../modules.html">Documentation</a>
+<ul>
+<li class="current tsd-kind-module"><a href="../modules/_helia_unixfs.html">@helia/unixfs -<wbr/> v1.4.1</a>
+<ul>
+<li class="tsd-kind-module tsd-parent-kind-module"><a href="../modules/_helia_unixfs._internal_.html">&lt;internal&gt;</a></li></ul></li>
+<li class="tsd-kind-module"><a href="../modules/_helia_unixfs_interop.html">@helia/unixfs-<wbr/>interop -<wbr/> v0.0.0</a></li></ul></li></ul></div></details></nav>
+<nav class="tsd-navigation secondary menu-sticky">
+<ul>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.AddOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Add<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.CatOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Cat<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.ChmodOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Chmod<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.CpOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Cp<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.LsOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Ls<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.MkdirOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Mkdir<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.RmOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Rm<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.StatOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Stat<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.TouchOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Touch<wbr/>Options</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.UnixFS.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>UnixFS</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.UnixFSComponents.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>UnixFSComponents</a></li>
+<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_helia_unixfs.UnixFSStats.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>UnixFSStats</a></li>
+<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/_helia_unixfs.AddEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-4194304-path"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)" id="icon-4194304-text"></path></svg>Add<wbr/>Events</a></li>
+<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="../types/_helia_unixfs.GetEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-4194304-path"></use><use href="#icon-4194304-text"></use></svg>Get<wbr/>Events</a></li>
+<li class="tsd-kind-function tsd-parent-kind-module"><a href="_helia_unixfs.globSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-64-path"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)" id="icon-64-text"></path></svg>glob<wbr/>Source</a></li>
+<li class="tsd-kind-function tsd-parent-kind-module"><a href="_helia_unixfs.unixfs-1.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>unixfs</a></li>
+<li class="current tsd-kind-function tsd-parent-kind-module"><a href="_helia_unixfs.urlSource.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>url<wbr/>Source</a></li></ul></nav></div></div>
+<div class="overlay"></div><script src="../assets/main.js"></script></body></html>