docs: update documentation [skip ci]

multiformats · Feb 29, 2024 · d7adb3a · d7adb3a
1 parent 6dff717
commit d7adb3a
Show file tree

Hide file tree

Showing 26 changed files with 79 additions and 64 deletions.
diff --git a/assets/main.js b/assets/main.js
diff --git a/classes/index.MultiaddrFilter.html b/classes/index.MultiaddrFilter.html
diff --git a/functions/convert.convert.html b/functions/convert.convert.html
diff --git a/functions/convert.convertToBytes.html b/functions/convert.convertToBytes.html
diff --git a/functions/convert.convertToIpNet.html b/functions/convert.convertToIpNet.html
diff --git a/functions/convert.convertToString.html b/functions/convert.convertToString.html
diff --git a/functions/index.fromNodeAddress.html b/functions/index.fromNodeAddress.html
diff --git a/functions/index.isMultiaddr.html b/functions/index.isMultiaddr.html
diff --git a/functions/index.isName.html b/functions/index.isName.html
diff --git a/functions/index.multiaddr-1.html b/functions/index.multiaddr-1.html
diff --git a/functions/index.protocols.html b/functions/index.protocols.html
diff --git a/functions/resolvers.dnsaddrResolver.html b/functions/resolvers.dnsaddrResolver.html
diff --git a/index.html b/index.html
@@ -4,7 +4,22 @@
 <blockquote>
 <p>multiaddr implementation (binary + string representation of network addresses)</p>
 </blockquote>
-<a id="md:about" class="tsd-anchor"></a><h1><a href="#md:about">About</a></h1><p>A standard way to represent addresses that</p>
+<a id="md:about" class="tsd-anchor"></a><h1><a href="#md:about">About</a></h1><!--
+
+!IMPORTANT!
+
+Everything in this README between "# About" and "# Install" is automatically
+generated and will be overwritten the next time the doc generator is run.
+
+To make changes to this section, please update the  section
+of src/index.js or src/index.ts
+
+To experiment with formatting, please run "npm run docs" from the root of this
+repo and examine the changes made.
+
+-->
+
+<p>A standard way to represent addresses that</p>
 <ul>
 <li>support any standard network protocol</li>
 <li>are self-describing</li>

diff --git a/interfaces/index.AbortOptions.html b/interfaces/index.AbortOptions.html
diff --git a/interfaces/index.Multiaddr.html b/interfaces/index.Multiaddr.html
diff --git a/interfaces/index.MultiaddrObject.html b/interfaces/index.MultiaddrObject.html
diff --git a/interfaces/index.NodeAddress.html b/interfaces/index.NodeAddress.html
diff --git a/interfaces/index.Protocol.html b/interfaces/index.Protocol.html
diff --git a/interfaces/index.Resolver.html b/interfaces/index.Resolver.html
diff --git a/modules/convert.html b/modules/convert.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>convert | @multiformats/multiaddr</title><meta name="description" content="Documentation for @multiformats/multiaddr"/><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">@multiformats/multiaddr</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">@multiformats/multiaddr</a></li><li><a href="convert.html">convert</a></li></ul><h1>Module convert</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Provides methods for converting</p>
-</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/multiformats/js-multiaddr/blob/7661e33/src/convert.ts#L1">convert.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">Functions</h3><div class="tsd-index-list"><a href="../functions/convert.convert.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert</span></a>
+</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/multiformats/js-multiaddr/blob/f61dec7/src/convert.ts#L1">convert.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">Functions</h3><div class="tsd-index-list"><a href="../functions/convert.convert.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert</span></a>
 <a href="../functions/convert.convertToBytes.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>To<wbr/>Bytes</span></a>
 <a href="../functions/convert.convertToIpNet.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>To<wbr/>Ip<wbr/>Net</span></a>
 <a href="../functions/convert.convertToString.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>convert<wbr/>To<wbr/>String</span></a>

diff --git a/modules/index.html b/modules/index.html
@@ -28,7 +28,7 @@
 </tr>
 </tbody></table>
 <p>A resolver receives a <code>Multiaddr</code> as a parameter and returns a <code>Promise&lt;Array&lt;string&gt;&gt;</code>.</p>
-</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/multiformats/js-multiaddr/blob/7661e33/src/index.ts#L1">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">Classes</h3><div class="tsd-index-list"><a href="../classes/index.MultiaddrFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Multiaddr<wbr/>Filter</span></a>
+</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/multiformats/js-multiaddr/blob/f61dec7/src/index.ts#L1">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">Classes</h3><div class="tsd-index-list"><a href="../classes/index.MultiaddrFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Multiaddr<wbr/>Filter</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/index.AbortOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Abort<wbr/>Options</span></a>
 <a href="../interfaces/index.Multiaddr.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Multiaddr</span></a>
 <a href="../interfaces/index.MultiaddrObject.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Multiaddr<wbr/>Object</span></a>

diff --git a/modules/resolvers.html b/modules/resolvers.html
diff --git a/types/index.MultiaddrInput.html b/types/index.MultiaddrInput.html
diff --git a/types/index.StringTuple.html b/types/index.StringTuple.html
diff --git a/types/index.Tuple.html b/types/index.Tuple.html
diff --git a/variables/index.resolvers.html b/variables/index.resolvers.html