Skip to content

Commit 7920140

Browse files
author
aegir[bot]
committed
docs: update documentation [skip ci]
1 parent 9406d6b commit 7920140

9 files changed

+24
-24
lines changed

‎functions/_helia_delegated_routing_v1_http_api_client.createDelegatedRoutingV1HttpApiClient.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ <h5><span class="tsd-kind-parameter">init</span>: <a href="../interfaces/_helia_
3232
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_helia_delegated_routing_v1_http_api_client.DelegatedRoutingV1HttpApiClient.html" class="tsd-signature-type tsd-kind-interface">DelegatedRoutingV1HttpApiClient</a></h4>
3333
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3434
<ul>
35-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L81">index.ts:81</a></li></ul></aside></li></ul></section></div>
35+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L81">index.ts:81</a></li></ul></aside></li></ul></section></div>
3636
<div class="col-sidebar">
3737
<div class="page-menu">
3838
<div class="tsd-navigation settings">

‎functions/_helia_delegated_routing_v1_http_api_server.index.createDelegatedRoutingV1HttpApiServer.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ <h5><span class="tsd-kind-parameter">init</span>: <a href="../interfaces/_helia_
3333
<h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">FastifyInstance</a><span class="tsd-signature-symbol">&gt;</span></h4>
3434
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
3535
<ul>
36-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/server/src/index.ts#L70">index.ts:70</a></li></ul></aside></li></ul></section></div>
36+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/server/src/index.ts#L70">index.ts:70</a></li></ul></aside></li></ul></section></div>
3737
<div class="col-sidebar">
3838
<div class="page-menu">
3939
<div class="tsd-navigation settings">

‎functions/_helia_delegated_routing_v1_http_api_server.routes.default.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ <h1>Function default</h1></div>
2525
<h4 class="tsd-parameters-title">Parameters</h4>
2626
<ul class="tsd-parameter-list">
2727
<li>
28-
<h5><span class="tsd-kind-parameter">fastify</span>: <a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">FastifyInstance</a><span class="tsd-signature-symbol">&lt;</span><a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">RawServerDefault</a><span class="tsd-signature-symbol">, </span><a href="https://www.npmjs.com/package/@types/node" class="tsd-signature-type external" target="_blank">IncomingMessage</a><span class="tsd-signature-symbol">, </span><a href="https://www.npmjs.com/package/@types/node" class="tsd-signature-type external" target="_blank">ServerResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="https://www.npmjs.com/package/@types/node" class="tsd-signature-type external" target="_blank">IncomingMessage</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">FastifyBaseLogger</a><span class="tsd-signature-symbol">, </span><a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">FastifyTypeProviderDefault</a><span class="tsd-signature-symbol">&gt;</span></h5></li>
28+
<h5><span class="tsd-kind-parameter">fastify</span>: <a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">FastifyInstance</a><span class="tsd-signature-symbol">&lt;</span><a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">RawServerDefault</a><span class="tsd-signature-symbol">, </span><a href="https://nodejs.org/dist/latest/docs/api/http.html#class-httpincomingmessage" class="tsd-signature-type external" target="_blank">IncomingMessage</a><span class="tsd-signature-symbol">, </span><a href="https://nodejs.org/dist/latest/docs/api/http.html#class-httpserverresponse" class="tsd-signature-type external" target="_blank">ServerResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="https://nodejs.org/dist/latest/docs/api/http.html#class-httpincomingmessage" class="tsd-signature-type external" target="_blank">IncomingMessage</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">, </span><a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">FastifyBaseLogger</a><span class="tsd-signature-symbol">, </span><a href="https://www.npmjs.com/package/fastify" class="tsd-signature-type external" target="_blank">FastifyTypeProviderDefault</a><span class="tsd-signature-symbol">&gt;</span></h5></li>
2929
<li>
3030
<h5><span class="tsd-kind-parameter">helia</span>: <a href="https://ipfs.github.io/helia/interfaces/helia.Helia.html" class="tsd-signature-type external" target="_blank">Helia</a><span class="tsd-signature-symbol">&lt;</span><a href="https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.index.Libp2p.html" class="tsd-signature-type external" target="_blank">Libp2p</a><span class="tsd-signature-symbol">&lt;</span><a href="https://libp2p.github.io/js-libp2p/types/_libp2p_interface.index.ServiceMap.html" class="tsd-signature-type external" target="_blank">ServiceMap</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
3131
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
3232
<ul>
33-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/server/src/routes/index.ts#L8">routes/index.ts:8</a></li></ul></aside></li></ul></section></div>
33+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/server/src/routes/index.ts#L8">routes/index.ts:8</a></li></ul></aside></li></ul></section></div>
3434
<div class="col-sidebar">
3535
<div class="page-menu">
3636
<div class="tsd-navigation settings">

‎interfaces/_helia_delegated_routing_v1_http_api_client.DelegatedRoutingV1HttpApiClient.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
2121
<ul class="tsd-hierarchy">
2222
<li><span class="target">DelegatedRoutingV1HttpApiClient</span></li></ul></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L48">index.ts:48</a></li></ul></aside>
24+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L48">index.ts:48</a></li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -54,7 +54,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
5454
<h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="https://ipfs.github.io/js-ipns/types/index.IPNSRecord.html" class="tsd-signature-type external" target="_blank">IPNSRecord</a><span class="tsd-signature-symbol">&gt;</span></h4>
5555
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
5656
<ul>
57-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L64">index.ts:64</a></li></ul></aside></li></ul></section>
57+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L64">index.ts:64</a></li></ul></aside></li></ul></section>
5858
<section class="tsd-panel tsd-member"><a id="getPeers" class="tsd-anchor"></a>
5959
<h3 class="tsd-anchor-link"><span>get<wbr/>Peers</span><a href="#getPeers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
6060
<ul class="tsd-signatures">
@@ -73,7 +73,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
7373
<h4 class="tsd-returns-title">Returns <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="_helia_delegated_routing_v1_http_api_client.PeerRecord.html" class="tsd-signature-type tsd-kind-interface">PeerRecord</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
7474
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
7575
<ul>
76-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L59">index.ts:59</a></li></ul></aside></li></ul></section>
76+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L59">index.ts:59</a></li></ul></aside></li></ul></section>
7777
<section class="tsd-panel tsd-member"><a id="getProviders" class="tsd-anchor"></a>
7878
<h3 class="tsd-anchor-link"><span>get<wbr/>Providers</span><a href="#getProviders" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
7979
<ul class="tsd-signatures">
@@ -92,7 +92,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
9292
<h4 class="tsd-returns-title">Returns <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="_helia_delegated_routing_v1_http_api_client.PeerRecord.html" class="tsd-signature-type tsd-kind-interface">PeerRecord</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
9393
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
9494
<ul>
95-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L53">index.ts:53</a></li></ul></aside></li></ul></section>
95+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L53">index.ts:53</a></li></ul></aside></li></ul></section>
9696
<section class="tsd-panel tsd-member"><a id="putIPNS" class="tsd-anchor"></a>
9797
<h3 class="tsd-anchor-link"><span>putIPNS</span><a href="#putIPNS" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
9898
<ul class="tsd-signatures">
@@ -112,7 +112,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-
112112
<h4 class="tsd-returns-title">Returns <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise" class="tsd-signature-type external" target="_blank">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
113113
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
114114
<ul>
115-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L69">index.ts:69</a></li></ul></aside></li></ul></section>
115+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L69">index.ts:69</a></li></ul></aside></li></ul></section>
116116
<section class="tsd-panel tsd-member"><a id="stop" class="tsd-anchor"></a>
117117
<h3 class="tsd-anchor-link"><span>stop</span><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
118118
<ul class="tsd-signatures">
@@ -124,7 +124,7 @@ <h3 class="tsd-anchor-link"><span>stop</span><a href="#stop" aria-label="Permali
124124
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
125125
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
126126
<ul>
127-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L75">index.ts:75</a></li></ul></aside></li></ul></section></section></div>
127+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L75">index.ts:75</a></li></ul></aside></li></ul></section></section></div>
128128
<div class="col-sidebar">
129129
<div class="page-menu">
130130
<div class="tsd-navigation settings">

‎interfaces/_helia_delegated_routing_v1_http_api_client.DelegatedRoutingV1HttpApiClientInit.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
2121
<ul class="tsd-hierarchy">
2222
<li><span class="target">DelegatedRoutingV1HttpApiClientInit</span></li></ul></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L34">index.ts:34</a></li></ul></aside>
24+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L34">index.ts:34</a></li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -43,15 +43,15 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code
4343
<h4>See</h4><p><a href="https://github.com/libp2p/js-libp2p-delegated-content-routing/issues/12">https://github.com/libp2p/js-libp2p-delegated-content-routing/issues/12</a></p>
4444
</div><aside class="tsd-sources">
4545
<ul>
46-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L40">index.ts:40</a></li></ul></aside></section>
46+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L40">index.ts:40</a></li></ul></aside></section>
4747
<section class="tsd-panel tsd-member"><a id="timeout" class="tsd-anchor"></a>
4848
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>timeout</span><a href="#timeout" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4949
<div class="tsd-signature"><span class="tsd-kind-property">timeout</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div>
5050
<div class="tsd-comment tsd-typography"><p>How long a request is allowed to take in ms (default: 30 seconds)</p>
5151
</div>
5252
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
5353
<ul>
54-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L45">index.ts:45</a></li></ul></aside></section></section></div>
54+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L45">index.ts:45</a></li></ul></aside></section></section></div>
5555
<div class="col-sidebar">
5656
<div class="page-menu">
5757
<div class="tsd-navigation settings">

‎interfaces/_helia_delegated_routing_v1_http_api_client.PeerRecord.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ <h4>Hierarchy</h4>
2121
<ul class="tsd-hierarchy">
2222
<li><span class="target">PeerRecord</span></li></ul></section><aside class="tsd-sources">
2323
<ul>
24-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L27">index.ts:27</a></li></ul></aside>
24+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L27">index.ts:27</a></li></ul></aside>
2525
<section class="tsd-panel-group tsd-index-group">
2626
<section class="tsd-panel tsd-index-panel">
2727
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -40,22 +40,22 @@ <h2>Properties</h2>
4040
<h3 class="tsd-anchor-link"><span>Addrs</span><a href="#Addrs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4141
<div class="tsd-signature"><span class="tsd-kind-property">Addrs</span><span class="tsd-signature-symbol">:</span> <a href="https://multiformats.github.io/js-multiaddr/interfaces/index.Multiaddr.html" class="tsd-signature-type external" target="_blank">Multiaddr</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
4242
<ul>
43-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L30">index.ts:30</a></li></ul></aside></section>
43+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L30">index.ts:30</a></li></ul></aside></section>
4444
<section class="tsd-panel tsd-member"><a id="ID" class="tsd-anchor"></a>
4545
<h3 class="tsd-anchor-link"><span>ID</span><a href="#ID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
4646
<div class="tsd-signature"><span class="tsd-kind-property">ID</span><span class="tsd-signature-symbol">:</span> <a href="https://libp2p.github.io/js-libp2p/types/_libp2p_interface.peer_id.PeerId.html" class="tsd-signature-type external" target="_blank">PeerId</a></div><aside class="tsd-sources">
4747
<ul>
48-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L29">index.ts:29</a></li></ul></aside></section>
48+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L29">index.ts:29</a></li></ul></aside></section>
4949
<section class="tsd-panel tsd-member"><a id="Protocols" class="tsd-anchor"></a>
5050
<h3 class="tsd-anchor-link"><span>Protocols</span><a href="#Protocols" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
5151
<div class="tsd-signature"><span class="tsd-kind-property">Protocols</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources">
5252
<ul>
53-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L31">index.ts:31</a></li></ul></aside></section>
53+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L31">index.ts:31</a></li></ul></aside></section>
5454
<section class="tsd-panel tsd-member"><a id="Schema" class="tsd-anchor"></a>
5555
<h3 class="tsd-anchor-link"><span>Schema</span><a href="#Schema" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
5656
<div class="tsd-signature"><span class="tsd-kind-property">Schema</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;peer&quot;</span></div><aside class="tsd-sources">
5757
<ul>
58-
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/ec62768/packages/client/src/index.ts#L28">index.ts:28</a></li></ul></aside></section></section></div>
58+
<li>Defined in <a href="https://github.com/ipfs/helia-delegated-routing-v1-http-api/blob/b130c17/packages/client/src/index.ts#L28">index.ts:28</a></li></ul></aside></section></section></div>
5959
<div class="col-sidebar">
6060
<div class="page-menu">
6161
<div class="tsd-navigation settings">

0 commit comments

Comments
 (0)