docs: update documentation [skip ci]

ipfs · Jan 8, 2024 · 0509fa1 · 0509fa1
1 parent 275e759
commit 0509fa1
Show file tree

Hide file tree

Showing 30 changed files with 95 additions and 95 deletions.
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 b/functions/index.globSource.html
diff --git a/functions/index.unixfs-1.html b/functions/index.unixfs-1.html
diff --git a/functions/index.urlSource.html b/functions/index.urlSource.html
diff --git a/index.html b/index.html
diff --git a/interfaces/index.AddOptions.html b/interfaces/index.AddOptions.html
diff --git a/interfaces/index.CatOptions.html b/interfaces/index.CatOptions.html
diff --git a/interfaces/index.ChmodOptions.html b/interfaces/index.ChmodOptions.html
diff --git a/interfaces/index.CpOptions.html b/interfaces/index.CpOptions.html
diff --git a/interfaces/index.LsOptions.html b/interfaces/index.LsOptions.html
diff --git a/interfaces/index.MkdirOptions.html b/interfaces/index.MkdirOptions.html
diff --git a/interfaces/index.RmOptions.html b/interfaces/index.RmOptions.html
diff --git a/interfaces/index.StatOptions.html b/interfaces/index.StatOptions.html
diff --git a/interfaces/index.TouchOptions.html b/interfaces/index.TouchOptions.html
diff --git a/interfaces/index.UnixFS.html b/interfaces/index.UnixFS.html
diff --git a/interfaces/index.UnixFSComponents.html b/interfaces/index.UnixFSComponents.html
diff --git a/interfaces/index.UnixFSStats.html b/interfaces/index.UnixFSStats.html
diff --git a/modules/errors.html b/modules/errors.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>errors | @helia/unixfs</title><meta name="description" content="Documentation for @helia/unixfs"/><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/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"</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"><use href="#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">@helia/unixfs</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="#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="../index.html">@helia/unixfs</a></li><li><a href="errors.html">errors</a></li></ul><h1>Module errors</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-unixfs/blob/12f4c75/packages/unixfs/src/errors.ts#L1">packages/unixfs/src/errors.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/errors.AlreadyExistsError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Already<wbr/>Exists<wbr/>Error</span></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>errors | @helia/unixfs</title><meta name="description" content="Documentation for @helia/unixfs"/><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/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"</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"><use href="#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">@helia/unixfs</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="#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="../index.html">@helia/unixfs</a></li><li><a href="errors.html">errors</a></li></ul><h1>Module errors</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-unixfs/blob/d9fbd55/packages/unixfs/src/errors.ts#L1">packages/unixfs/src/errors.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/errors.AlreadyExistsError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Already<wbr/>Exists<wbr/>Error</span></a>
 <a href="../classes/errors.DoesNotExistError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Does<wbr/>Not<wbr/>Exist<wbr/>Error</span></a>
 <a href="../classes/errors.InvalidPBNodeError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>InvalidPBNode<wbr/>Error</span></a>
 <a href="../classes/errors.InvalidParametersError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Invalid<wbr/>Parameters<wbr/>Error</span></a>

diff --git a/modules/index.html b/modules/index.html
@@ -5,7 +5,7 @@
 <h4>Example: Recursively adding a directory</h4><p>Node.js-compatibly environments only:</p>
 <pre><code class="language-typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">globSource</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@helia/unixfs&#39;</span><br/><br/><span class="hl-0">for</span><span class="hl-1"> </span><span class="hl-0">await</span><span class="hl-1"> (</span><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">entry</span><span class="hl-1"> </span><span class="hl-4">of</span><span class="hl-1"> </span><span class="hl-2">fs</span><span class="hl-1">.</span><span class="hl-6">addAll</span><span class="hl-1">(</span><span class="hl-6">globSource</span><span class="hl-1">(</span><span class="hl-3">&#39;path/to/containing/dir&#39;</span><span class="hl-1">, </span><span class="hl-3">&#39;glob-pattern&#39;</span><span class="hl-1">))) {</span><br/><span class="hl-1">  </span><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">info</span><span class="hl-1">(</span><span class="hl-2">entry</span><span class="hl-1">)</span><br/><span class="hl-1">}</span>
 </code><button>Copy</button></pre>
-</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-unixfs/blob/12f4c75/packages/unixfs/src/index.ts#L1">packages/unixfs/src/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/index.AddOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Add<wbr/>Options</span></a>
+</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-unixfs/blob/d9fbd55/packages/unixfs/src/index.ts#L1">packages/unixfs/src/index.ts:1</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/index.AddOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Add<wbr/>Options</span></a>
 <a href="../interfaces/index.CatOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cat<wbr/>Options</span></a>
 <a href="../interfaces/index.ChmodOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Chmod<wbr/>Options</span></a>
 <a href="../interfaces/index.CpOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Cp<wbr/>Options</span></a>

diff --git a/types/index.AddEvents.html b/types/index.AddEvents.html
diff --git a/types/index.GetEvents.html b/types/index.GetEvents.html