Skip to content

Commit 95a9a7c

Browse files
author
aegir[bot]
committed
docs: update documentation [skip ci]
1 parent 6ee2e93 commit 95a9a7c

12 files changed

+22
-22
lines changed

‎functions/_helia_delegated_routing_v1_http_api_client.createDelegatedRoutingV1HttpApiClient.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎functions/_helia_delegated_routing_v1_http_api_server.index.createDelegatedRoutingV1HttpApiServer.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎functions/_helia_delegated_routing_v1_http_api_server.routes.default.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎interfaces/_helia_delegated_routing_v1_http_api_client.DelegatedRoutingV1HttpApiClient.html‎

Lines changed: 6 additions & 6 deletions
Large diffs are not rendered by default.

‎interfaces/_helia_delegated_routing_v1_http_api_client.DelegatedRoutingV1HttpApiClientInit.html‎

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

‎interfaces/_helia_delegated_routing_v1_http_api_client.GetIPNSOptions.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎interfaces/_helia_delegated_routing_v1_http_api_client.PeerRecord.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎interfaces/_helia_delegated_routing_v1_http_api_server.index.ServerInit.html‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎modules/_helia_delegated_routing_v1_http_api_client.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@helia/delegated-routing-v1-http-api-client - v2.1.0 | Helia Routing V1 HTTP API</title><meta name="description" content="Documentation for Helia Routing V1 HTTP API"/><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 Routing V1 HTTP API</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 Routing V1 HTTP API</a></li><li><a href="_helia_delegated_routing_v1_http_api_client.html">@helia/delegated-routing-v1-http-api-client</a></li></ul><h1>Module @helia/delegated-routing-v1-http-api-client - v2.1.0</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A client implementation of the IPFS <a href="https://specs.ipfs.tech/routing/http-routing-v1/">Delegated Routing V1 HTTP API</a> that can be used to interact with any compliant server implementation.</p>
1+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@helia/delegated-routing-v1-http-api-client - v3.0.0 | Helia Routing V1 HTTP API</title><meta name="description" content="Documentation for Helia Routing V1 HTTP API"/><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 Routing V1 HTTP API</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 Routing V1 HTTP API</a></li><li><a href="_helia_delegated_routing_v1_http_api_client.html">@helia/delegated-routing-v1-http-api-client</a></li></ul><h1>Module @helia/delegated-routing-v1-http-api-client - v3.0.0</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A client implementation of the IPFS <a href="https://specs.ipfs.tech/routing/http-routing-v1/">Delegated Routing V1 HTTP API</a> that can be used to interact with any compliant server implementation.</p>
22
</div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-typescript"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">createDelegatedRoutingV1HttpApiClient</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@helia/delegated-routing-v1-http-api-client&#39;</span><br/><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">CID</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">&#39;multiformats/cid&#39;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">client</span><span class="hl-1"> = </span><span class="hl-6">createDelegatedRoutingV1HttpApiClient</span><span class="hl-1">(</span><span class="hl-3">&#39;https://example.org&#39;</span><span class="hl-1">)</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">prov</span><span class="hl-1"> </span><span class="hl-4">of</span><span class="hl-1"> </span><span class="hl-6">getProviders</span><span class="hl-1">(</span><span class="hl-5">CID</span><span class="hl-1">.</span><span class="hl-6">parse</span><span class="hl-1">(</span><span class="hl-3">&#39;QmFoo&#39;</span><span class="hl-1">))) {</span><br/><span class="hl-1"> </span><span class="hl-7">// ...</span><br/><span class="hl-1">}</span>
33
</code><button>Copy</button></pre>
44
<a id="md:how-to-use-with-libp2p" class="tsd-anchor"></a><h3><a href="#md:how-to-use-with-libp2p">How to use with libp2p</a></h3><p>The client can be configured as a libp2p service, this will enable it as both a <a href="https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.content_routing.ContentRouting.html">ContentRouting</a> and a <a href="https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.peer_routing.PeerRouting.html">PeerRouting</a> implementation</p>

‎modules/_helia_delegated_routing_v1_http_api_server.html‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)