docs: update documentation [skip ci]

ipfs · Dec 8, 2023 · 87a8474 · 87a8474
1 parent 81a1d46
commit 87a8474
Show file tree

Hide file tree

Showing 22 changed files with 39 additions and 39 deletions.
diff --git a/functions/index.ipns-1.html b/functions/index.ipns-1.html
diff --git a/functions/routing.dht.html b/functions/routing.dht.html
diff --git a/functions/routing.pubsub.html b/functions/routing.pubsub.html
diff --git a/interfaces/index.DNSResolver.html b/interfaces/index.DNSResolver.html
diff --git a/interfaces/index.IPNS.html b/interfaces/index.IPNS.html
diff --git a/interfaces/index.IPNSComponents.html b/interfaces/index.IPNSComponents.html
diff --git a/interfaces/index.IPNSOptions.html b/interfaces/index.IPNSOptions.html
diff --git a/interfaces/index.PublishOptions.html b/interfaces/index.PublishOptions.html
diff --git a/interfaces/index.RepublishOptions.html b/interfaces/index.RepublishOptions.html
diff --git a/interfaces/index.ResolveDNSOptions.html b/interfaces/index.ResolveDNSOptions.html
diff --git a/interfaces/index.ResolveDnsLinkOptions.html b/interfaces/index.ResolveDnsLinkOptions.html
diff --git a/interfaces/index.ResolveOptions.html b/interfaces/index.ResolveOptions.html
diff --git a/interfaces/routing.GetOptions.html b/interfaces/routing.GetOptions.html
diff --git a/interfaces/routing.IPNSRouting.html b/interfaces/routing.IPNSRouting.html
diff --git a/interfaces/routing.PutOptions.html b/interfaces/routing.PutOptions.html
diff --git a/modules/index.html b/modules/index.html
@@ -18,7 +18,7 @@ <h4>Example</h4><p>DNS-JSON-Over-HTTPS resolvers use the RFC 8427 <code>applicat
 result in a smaller browser bundle due to the response being plain JSON.</p>
 <pre><code class="language-typescript"><span class="hl-7">// use DNS-JSON-Over-HTTPS</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">dnsJsonOverHttps</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@helia/ipns/dns-resolvers&#39;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">cid</span><span class="hl-1"> = </span><span class="hl-2">name</span><span class="hl-1">.</span><span class="hl-6">resolveDns</span><span class="hl-1">(</span><span class="hl-3">&#39;ipfs.io&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1">  </span><span class="hl-2">resolvers:</span><span class="hl-1"> [</span><br/><span class="hl-1">    </span><span class="hl-6">dnsJsonOverHttps</span><span class="hl-1">(</span><span class="hl-3">&#39;https://mozilla.cloudflare-dns.com/dns-query&#39;</span><span class="hl-1">)</span><br/><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-ipns/blob/6ab5ddc/packages/ipns/src/index.ts#L1">packages/ipns/src/index.ts:1</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">References</h3><div class="tsd-index-list"><a href="index.html#IPNSRouting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPNSRouting</span></a>
+</div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-ipns/blob/ae6354b/packages/ipns/src/index.ts#L1">packages/ipns/src/index.ts:1</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">References</h3><div class="tsd-index-list"><a href="index.html#IPNSRouting" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>IPNSRouting</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.DNSResolver.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DNSResolver</span></a>
 <a href="../interfaces/index.IPNS.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPNS</span></a>
 <a href="../interfaces/index.IPNSComponents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPNSComponents</span></a>

diff --git a/modules/routing.html b/modules/routing.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>routing | @helia/ipns</title><meta name="description" content="Documentation for @helia/ipns"/><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/ipns</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/ipns</a></li><li><a href="routing.html">routing</a></li></ul><h1>Module routing</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-ipns/blob/6ab5ddc/packages/ipns/src/routing/index.ts#L1">packages/ipns/src/routing/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/routing.GetOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Get<wbr/>Options</span></a>
+<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>routing | @helia/ipns</title><meta name="description" content="Documentation for @helia/ipns"/><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/ipns</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/ipns</a></li><li><a href="routing.html">routing</a></li></ul><h1>Module routing</h1></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/ipfs/helia-ipns/blob/ae6354b/packages/ipns/src/routing/index.ts#L1">packages/ipns/src/routing/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/routing.GetOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Get<wbr/>Options</span></a>
 <a href="../interfaces/routing.IPNSRouting.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>IPNSRouting</span></a>
 <a href="../interfaces/routing.PutOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Put<wbr/>Options</span></a>
 </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/routing.IPNSRoutingEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>IPNSRouting<wbr/>Events</span></a>

diff --git a/types/index.PublishProgressEvents.html b/types/index.PublishProgressEvents.html
diff --git a/types/index.RepublishProgressEvents.html b/types/index.RepublishProgressEvents.html
diff --git a/types/index.ResolveDnsLinkProgressEvents.html b/types/index.ResolveDnsLinkProgressEvents.html
diff --git a/types/index.ResolveProgressEvents.html b/types/index.ResolveProgressEvents.html
diff --git a/types/routing.IPNSRoutingEvents.html b/types/routing.IPNSRoutingEvents.html