mirror of https://github.com/waku-org/js-waku.git
deploy: 96cf24d34e
This commit is contained in:
D4nte
parent
ba661825f7
commit
760a864e37
|
|
@ -0,0 +1 @@
|
|||
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|
||||
|
|
@ -0,0 +1,36 @@
|
|||
:root {
|
||||
--light-hl-0: #000000;
|
||||
--dark-hl-0: #D4D4D4;
|
||||
--light-hl-1: #795E26;
|
||||
--dark-hl-1: #DCDCAA;
|
||||
--light-code-background: #FFFFFF;
|
||||
--dark-code-background: #1E1E1E;
|
||||
}
|
||||
|
||||
@media (prefers-color-scheme: light) { :root {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--code-background: var(--light-code-background);
|
||||
} }
|
||||
|
||||
@media (prefers-color-scheme: dark) { :root {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--code-background: var(--dark-code-background);
|
||||
} }
|
||||
|
||||
body.light {
|
||||
--hl-0: var(--light-hl-0);
|
||||
--hl-1: var(--light-hl-1);
|
||||
--code-background: var(--light-code-background);
|
||||
}
|
||||
|
||||
body.dark {
|
||||
--hl-0: var(--dark-hl-0);
|
||||
--hl-1: var(--dark-hl-1);
|
||||
--code-background: var(--dark-code-background);
|
||||
}
|
||||
|
||||
.hl-0 { color: var(--hl-0); }
|
||||
.hl-1 { color: var(--hl-1); }
|
||||
pre, code { background: var(--code-background); }
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
After Width: | Height: | Size: 9.4 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 28 KiB |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
After Width: | Height: | Size: 480 B |
Binary file not shown.
|
After Width: | Height: | Size: 855 B |
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,8 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DnsOverHttps | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="../modules/discovery.html">discovery</a></li><li><a href="discovery.DnsOverHttps.html">DnsOverHttps</a></li></ul><h1>Class DnsOverHttps</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">DnsOverHttps</span></li></ul></section><section class="tsd-panel"><h3>Implements</h3><ul class="tsd-hierarchy"><li><a href="../interfaces/discovery.DnsClient.html" class="tsd-signature-type" data-tsd-kind="Interface">DnsClient</a></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="discovery.DnsOverHttps.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-class"><a href="discovery.DnsOverHttps.html#endpoints" class="tsd-kind-icon">endpoints</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="discovery.DnsOverHttps.html#resolveTXT" class="tsd-kind-icon">resolveTXT</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3>constructor</h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new <wbr/>Dns<wbr/>Over<wbr/>Https<span class="tsd-signature-symbol">(</span>endpoints<span class="tsd-signature-symbol">?: </span><a href="../modules/discovery.html#Endpoints" class="tsd-signature-type" data-tsd-kind="Type alias">Endpoints</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="discovery.DnsOverHttps.html" class="tsd-signature-type" data-tsd-kind="Class">DnsOverHttps</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/discovery/dns_over_https.ts#L28">src/lib/discovery/dns_over_https.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Create new Dns-Over-Http DNS client.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>{code: string} If DNS query fails.</p>
|
||||
</dd></dl></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>endpoints: <a href="../modules/discovery.html#Endpoints" class="tsd-signature-type" data-tsd-kind="Type alias">Endpoints</a><span class="tsd-signature-symbol"> = ...</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The endpoints for Dns-Over-Https queries.
|
||||
See <a href="https://www.npmjs.com/package/dns-query">dns-query</a> for details.
|
||||
Defaults to cloudflare, google and opendns.</p>
|
||||
</div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="discovery.DnsOverHttps.html" class="tsd-signature-type" data-tsd-kind="Class">DnsOverHttps</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="endpoints" class="tsd-anchor"></a><h3>endpoints</h3><div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="../modules/discovery.html#Endpoints" class="tsd-signature-type" data-tsd-kind="Type alias">Endpoints</a><span class="tsd-signature-symbol"> = ...</span></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="resolveTXT" class="tsd-anchor"></a><h3>resolveTXT</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">resolveTXT<span class="tsd-signature-symbol">(</span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/discovery.DnsClient.html">DnsClient</a>.<a href="../interfaces/discovery.DnsClient.html#resolveTXT">resolveTXT</a></p><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/discovery/dns_over_https.ts#L32">src/lib/discovery/dns_over_https.ts:32</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>domain: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class tsd-parent-kind-namespace"><a href="discovery.DnsOverHttps.html" class="tsd-kind-icon">Dns<wbr/>Over<wbr/>Https</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="discovery.DnsOverHttps.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-property tsd-parent-kind-class"><a href="discovery.DnsOverHttps.html#endpoints" class="tsd-kind-icon">endpoints</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="discovery.DnsOverHttps.html#resolveTXT" class="tsd-kind-icon">resolveTXT</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,56 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><h1>js-waku</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography"><p><a href="https://npmjs.org/package/js-waku"><img src="https://nodei.co/npm/js-waku.png" alt="NPM"></a></p>
|
||||
<p><img src="https://img.shields.io/github/workflow/status/status-im/js-waku/CI" alt="GitHub Action">
|
||||
<a href="https://discord.gg/j5pGbn7MHZ"><img src="https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA" alt="Discord chat"></a></p>
|
||||
|
||||
<a href="#js-waku" id="js-waku" style="color: inherit; text-decoration: none;">
|
||||
<h1>js-waku</h1>
|
||||
</a>
|
||||
<p>A JavaScript implementation of the <a href="https://rfc.vac.dev/spec/10/">Waku v2 protocol</a>.</p>
|
||||
|
||||
<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
|
||||
<h2>Documentation</h2>
|
||||
</a>
|
||||
<ul>
|
||||
<li><a href="https://docs.dappconnect.dev/docs/quick_start/">Quick start</a></li>
|
||||
<li><a href="https://docs.dappconnect.dev/">Full documentation</a></li>
|
||||
<li><a href="https://status-im.github.io/js-waku/docs/">API documentation (<code>master</code> branch)</a></li>
|
||||
</ul>
|
||||
<p>API Documentation can also be generated locally:</p>
|
||||
<pre><code class="language-shell"><span class="hl-0">git clone https://github.com/status-im/js-waku.git</span><br/><span class="hl-1">cd</span><span class="hl-0"> js-waku</span><br/><span class="hl-0">npm install</span><br/><span class="hl-0">npm run doc</span>
|
||||
</code></pre>
|
||||
|
||||
<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
|
||||
<h2>Changelog</h2>
|
||||
</a>
|
||||
<p>Release changelog can be found in <a href="https://github.com/status-im/js-waku/blob/master/CHANGELOG.md">CHANGELOG.md</a>.</p>
|
||||
|
||||
<a href="#bugs-questions-amp-features" id="bugs-questions-amp-features" style="color: inherit; text-decoration: none;">
|
||||
<h2>Bugs, Questions & Features</h2>
|
||||
</a>
|
||||
<p>If you encounter any bug or would like to propose new features, feel free to <a href="https://github.com/status-im/js-waku/issues/new/">open an issue</a>.</p>
|
||||
<p>To get help, join <strong>#dappconnect-support</strong> on <a href="https://discord.gg/j5pGbn7MHZ">Vac Discord</a> or <a href="https://t.me/dappconnectsupport">Telegram</a>.</p>
|
||||
<p>For more general discussion and latest news, join <strong>#dappconnect</strong> on <a href="https://discord.gg/9DgykdmpZ6">Vac Discord</a> or <a href="https://t.me/dappconnect">Telegram</a>.</p>
|
||||
|
||||
<a href="#roadmap" id="roadmap" style="color: inherit; text-decoration: none;">
|
||||
<h2>Roadmap</h2>
|
||||
</a>
|
||||
<p>You can track progress on the <a href="https://github.com/status-im/js-waku/projects/1">project board</a>.</p>
|
||||
|
||||
<a href="#contributing" id="contributing" style="color: inherit; text-decoration: none;">
|
||||
<h2>Contributing</h2>
|
||||
</a>
|
||||
<p>See <a href="https://github.com/status-im/js-waku/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
|
||||
|
||||
<a href="#license" id="license" style="color: inherit; text-decoration: none;">
|
||||
<h2>License</h2>
|
||||
</a>
|
||||
<p>Licensed and distributed under either of</p>
|
||||
<ul>
|
||||
<li>MIT license: <a href="LICENSE-MIT">LICENSE-MIT</a> or <a href="http://opensource.org/licenses/MIT">http://opensource.org/licenses/MIT</a></li>
|
||||
</ul>
|
||||
<p>or</p>
|
||||
<ul>
|
||||
<li>Apache License, Version 2.0, (<a href="LICENSE-APACHE-v2">LICENSE-APACHE-v2</a> or <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a>)</li>
|
||||
</ul>
|
||||
<p>at your option. These files may not be copied, modified, or distributed except according to those terms.</p>
|
||||
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-reference"><a href="modules.html#DefaultPubSubTopic" class="tsd-kind-icon">Default<wbr/>Pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-reference"><a href="modules.html#LightPushCodec" class="tsd-kind-icon">Light<wbr/>Push<wbr/>Codec</a></li><li class="tsd-kind-reference"><a href="modules.html#PageDirection" class="tsd-kind-icon">Page<wbr/>Direction</a></li><li class="tsd-kind-reference"><a href="modules.html#PushResponse" class="tsd-kind-icon">Push<wbr/>Response</a></li><li class="tsd-kind-reference"><a href="modules.html#RelayCodecs" class="tsd-kind-icon">Relay<wbr/>Codecs</a></li><li class="tsd-kind-reference"><a href="modules.html#StoreCodec" class="tsd-kind-icon">Store<wbr/>Codec</a></li><li class="tsd-kind-reference"><a href="modules.html#Waku" class="tsd-kind-icon">Waku</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuLightPush" class="tsd-kind-icon">Waku<wbr/>Light<wbr/>Push</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuMessage" class="tsd-kind-icon">Waku<wbr/>Message</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuRelay" class="tsd-kind-icon">Waku<wbr/>Relay</a></li><li class="tsd-kind-reference"><a href="modules.html#WakuStore" class="tsd-kind-icon">Waku<wbr/>Store</a></li><li class="tsd-kind-function"><a href="modules.html#generatePrivateKey" class="tsd-kind-icon">generate<wbr/>Private<wbr/>Key</a></li><li class="tsd-kind-function"><a href="modules.html#generateSymmetricKey" class="tsd-kind-icon">generate<wbr/>Symmetric<wbr/>Key</a></li><li class="tsd-kind-function"><a href="modules.html#getNodesFromHostedJson" class="tsd-kind-icon">get<wbr/>Nodes<wbr/>From<wbr/>Hosted<wbr/>Json</a></li><li class="tsd-kind-function"><a href="modules.html#getPublicKey" class="tsd-kind-icon">get<wbr/>Public<wbr/>Key</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="assets/main.js"></script></body></html>
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>BootstrapOptions | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="../modules/discovery.html">discovery</a></li><li><a href="discovery.BootstrapOptions.html">BootstrapOptions</a></li></ul><h1>Interface BootstrapOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Setup discovery method used to bootstrap.</p>
|
||||
</div><div><p>Only one method is used. <code>default</code>, <code>peers</code>, <code>getPeers</code> and <code>enr</code> options are mutually exclusive.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">BootstrapOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#default" class="tsd-kind-icon">default</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#enrUrl" class="tsd-kind-icon">enr<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#maxPeers" class="tsd-kind-icon">max<wbr/>Peers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#peers" class="tsd-kind-icon">peers</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#getPeers" class="tsd-kind-icon">get<wbr/>Peers</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="default" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> default</h3><div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/discovery/bootstrap.ts#L30">src/lib/discovery/bootstrap.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Use the default discovery method. Overrides all other options but <code>maxPeers</code></p>
|
||||
</div><div><p>The default discovery method is likely to change overtime as new discovery
|
||||
methods are implemented.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p>false</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="enrUrl" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> enr<wbr/>Url</h3><div class="tsd-signature tsd-kind-icon">enr<wbr/>Url<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/discovery/bootstrap.ts#L43">src/lib/discovery/bootstrap.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>An EIP-1459 ENR Tree URL. For example:
|
||||
"enrtree://<a href="mailto:AOFTICU2XWDULNLZGRMQS4RIZPAZEHYMV4FYHAPW563HNRAOERP7C@test.nodes.vac.dev">AOFTICU2XWDULNLZGRMQS4RIZPAZEHYMV4FYHAPW563HNRAOERP7C@test.nodes.vac.dev</a>"</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="maxPeers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> max<wbr/>Peers</h3><div class="tsd-signature tsd-kind-icon">max<wbr/>Peers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/discovery/bootstrap.ts#L21">src/lib/discovery/bootstrap.ts:21</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The maximum of peers to connect to as part of the bootstrap process.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../classes/discovery.Bootstrap.html#DefaultMaxPeers">Bootstrap.DefaultMaxPeers</a></p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="peers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> peers</h3><div class="tsd-signature tsd-kind-icon">peers<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/discovery/bootstrap.ts#L34">src/lib/discovery/bootstrap.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Multiaddrs of peers to connect to.</p>
|
||||
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="getPeers" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr/>Peers</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">get<wbr/>Peers<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Multiaddr</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/discovery/bootstrap.ts#L38">src/lib/discovery/bootstrap.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Getter that retrieve multiaddrs of peers to connect to.</p>
|
||||
</div></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Multiaddr</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="discovery.BootstrapOptions.html" class="tsd-kind-icon">Bootstrap<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#default" class="tsd-kind-icon">default</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#enrUrl" class="tsd-kind-icon">enr<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#maxPeers" class="tsd-kind-icon">max<wbr/>Peers</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#peers" class="tsd-kind-icon">peers</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="discovery.BootstrapOptions.html#getPeers" class="tsd-kind-icon">get<wbr/>Peers</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,35 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateOptions | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="../modules/waku.html">waku</a></li><li><a href="waku.CreateOptions.html">CreateOptions</a></li></ul><h1>Interface CreateOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CreateOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#bootstrap" class="tsd-kind-icon">bootstrap</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#decryptionKeys" class="tsd-kind-icon">decryption<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#libp2p" class="tsd-kind-icon">libp2p</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#pingKeepAlive" class="tsd-kind-icon">ping<wbr/>Keep<wbr/>Alive</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#relayKeepAlive" class="tsd-kind-icon">relay<wbr/>Keep<wbr/>Alive</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#staticNoiseKey" class="tsd-kind-icon">static<wbr/>Noise<wbr/>Key</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="bootstrap" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> bootstrap</h3><div class="tsd-signature tsd-kind-icon">bootstrap<span class="tsd-signature-symbol">?:</span> <a href="discovery.BootstrapOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">BootstrapOptions</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L94">src/lib/waku.ts:94</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Use libp2p-bootstrap to discover and connect to new nodes.</p>
|
||||
</div><div><p>See <a href="discovery.BootstrapOptions.html">BootstrapOptions</a> for available parameters.</p>
|
||||
<p>Note: It overrides any other peerDiscovery modules that may have been set via
|
||||
<a href="waku.CreateOptions.html#libp2p">CreateOptions.libp2p</a>.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="decryptionKeys" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> decryption<wbr/>Keys</h3><div class="tsd-signature tsd-kind-icon">decryption<wbr/>Keys<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L95">src/lib/waku.ts:95</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="libp2p" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> libp2p</h3><div class="tsd-signature tsd-kind-icon">libp2p<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Libp2pOptions</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">CreateOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">"modules"</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>modules<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Libp2pModules</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L77">src/lib/waku.ts:77</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>You can pass options to the <code>Libp2p</code> instance used by <a href="../classes/waku.Waku.html">Waku</a> using the <a href="waku.CreateOptions.html#libp2p">CreateOptions.libp2p</a> property.
|
||||
This property is the same type than the one passed to <a href="https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#create"><code>Libp2p.create</code></a>
|
||||
apart that we made the <code>modules</code> property optional and partial,
|
||||
allowing its omission and letting Waku set good defaults.
|
||||
Notes that some values are overridden by <a href="../classes/waku.Waku.html">Waku</a> to ensure it implements the Waku protocol.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pingKeepAlive" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ping<wbr/>Keep<wbr/>Alive</h3><div class="tsd-signature tsd-kind-icon">ping<wbr/>Keep<wbr/>Alive<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L62">src/lib/waku.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Set keep alive frequency in seconds: Waku will send a <code>/ipfs/ping/1.0.0</code>
|
||||
request to each peer after the set number of seconds. Set to 0 to disable.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../modules/waku.html#DefaultPingKeepAliveValueSecs">DefaultPingKeepAliveValueSecs</a></p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pubSubTopic" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> pub<wbr/>Sub<wbr/>Topic</h3><div class="tsd-signature tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L55">src/lib/waku.ts:55</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The PubSub Topic to use. Defaults to <a href="../modules/waku.html#DefaultPubSubTopic">DefaultPubSubTopic</a>.</p>
|
||||
</div><div><p>One and only one pubsub topic is used by Waku. This is used by:</p>
|
||||
<ul>
|
||||
<li>WakuRelay to receive, route and send messages,</li>
|
||||
<li>WakuLightPush to send messages,</li>
|
||||
<li>WakuStore to retrieve messages.</li>
|
||||
</ul>
|
||||
<p>The usage of the default pubsub topic is recommended.
|
||||
See <a href="https://rfc.vac.dev/spec/23/">Waku v2 Topic Usage Recommendations</a> for details.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../modules/waku.html#DefaultPubSubTopic">DefaultPubSubTopic</a></p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="relayKeepAlive" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> relay<wbr/>Keep<wbr/>Alive</h3><div class="tsd-signature tsd-kind-icon">relay<wbr/>Keep<wbr/>Alive<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L69">src/lib/waku.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Set keep alive frequency in seconds: Waku will send a ping message over
|
||||
relay to each peer after the set number of seconds. Set to 0 to disable.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../modules/waku.html#DefaultRelayKeepAliveValueSecs">DefaultRelayKeepAliveValueSecs</a></p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="staticNoiseKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> static<wbr/>Noise<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">static<wbr/>Noise<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Buffer</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L85">src/lib/waku.ts:85</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Byte array used as key for the noise protocol used for connection encryption
|
||||
by <a href="https://github.com/libp2p/js-libp2p/blob/master/doc/API.md#create"><code>Libp2p.create</code></a>
|
||||
This is only used for test purposes to not run out of entropy during CI runs.</p>
|
||||
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class="current tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="waku.CreateOptions.html" class="tsd-kind-icon">Create<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#bootstrap" class="tsd-kind-icon">bootstrap</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#decryptionKeys" class="tsd-kind-icon">decryption<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#libp2p" class="tsd-kind-icon">libp2p</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#pingKeepAlive" class="tsd-kind-icon">ping<wbr/>Keep<wbr/>Alive</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#relayKeepAlive" class="tsd-kind-icon">relay<wbr/>Keep<wbr/>Alive</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku.CreateOptions.html#staticNoiseKey" class="tsd-kind-icon">static<wbr/>Noise<wbr/>Key</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateOptions | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="../modules/waku_light_push.html">waku_light_push</a></li><li><a href="waku_light_push.CreateOptions.html">CreateOptions</a></li></ul><h1>Interface CreateOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CreateOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_light_push.CreateOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pubSubTopic" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> pub<wbr/>Sub<wbr/>Topic</h3><div class="tsd-signature tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_light_push/index.ts#L27">src/lib/waku_light_push/index.ts:27</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The PubSub Topic to use. Defaults to <a href="../modules/waku.html#DefaultPubSubTopic">DefaultPubSubTopic</a>.</p>
|
||||
</div><div><p>The usage of the default pubsub topic is recommended.
|
||||
See <a href="https://rfc.vac.dev/spec/23/">Waku v2 Topic Usage Recommendations</a> for details.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../modules/waku.html#DefaultPubSubTopic">DefaultPubSubTopic</a></p>
|
||||
</dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class="current tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="waku_light_push.CreateOptions.html" class="tsd-kind-icon">Create<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_light_push.CreateOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,12 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Options | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="../modules/waku_message.html">waku_message</a></li><li><a href="waku_message.Options.html">Options</a></li></ul><h1>Interface Options</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">Options</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#encPublicKey" class="tsd-kind-icon">enc<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#sigPrivKey" class="tsd-kind-icon">sig<wbr/>Priv<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#symKey" class="tsd-kind-icon">sym<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#timestamp" class="tsd-kind-icon">timestamp</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="encPublicKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> enc<wbr/>Public<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">enc<wbr/>Public<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_message/index.ts#L30">src/lib/waku_message/index.ts:30</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Public Key to use to encrypt the messages using ECIES (Asymmetric Encryption).</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>if both <code>encPublicKey</code> and <code>symKey</code> are passed</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="sigPrivKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> sig<wbr/>Priv<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">sig<wbr/>Priv<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Uint8Array</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_message/index.ts#L41">src/lib/waku_message/index.ts:41</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Private key to use to sign the message, either <code>encPublicKey</code> or <code>symKey</code> must be provided as only
|
||||
encrypted messages are signed.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="symKey" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> sym<wbr/>Key</h3><div class="tsd-signature tsd-kind-icon">sym<wbr/>Key<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_message/index.ts#L36">src/lib/waku_message/index.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Key to use to encrypt the messages using AES (Symmetric Encryption).</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>throws</dt><dd><p>if both <code>encPublicKey</code> and <code>symKey</code> are passed</p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="timestamp" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> timestamp</h3><div class="tsd-signature tsd-kind-icon">timestamp<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Date</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_message/index.ts#L24">src/lib/waku_message/index.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Timestamp to set on the message, defaults to now if not passed.</p>
|
||||
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class="current tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="waku_message.Options.html" class="tsd-kind-icon">Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#encPublicKey" class="tsd-kind-icon">enc<wbr/>Public<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#sigPrivKey" class="tsd-kind-icon">sig<wbr/>Priv<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#symKey" class="tsd-kind-icon">sym<wbr/>Key</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_message.Options.html#timestamp" class="tsd-kind-icon">timestamp</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,6 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreateOptions | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="../modules/waku_store.html">waku_store</a></li><li><a href="waku_store.CreateOptions.html">CreateOptions</a></li></ul><h1>Interface CreateOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">CreateOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.CreateOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pubSubTopic" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> pub<wbr/>Sub<wbr/>Topic</h3><div class="tsd-signature tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L34">src/lib/waku_store/index.ts:34</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The PubSub Topic to use. Defaults to <a href="../modules/waku.html#DefaultPubSubTopic">DefaultPubSubTopic</a>.</p>
|
||||
</div><div><p>The usage of the default pubsub topic is recommended.
|
||||
See <a href="https://rfc.vac.dev/spec/23/">Waku v2 Topic Usage Recommendations</a> for details.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../modules/waku.html#DefaultPubSubTopic">DefaultPubSubTopic</a></p>
|
||||
</dd></dl></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class="current tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="waku_store.CreateOptions.html" class="tsd-kind-icon">Create<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.CreateOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryOptions | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="../modules/waku_store.html">waku_store</a></li><li><a href="waku_store.QueryOptions.html">QueryOptions</a></li></ul><h1>Interface QueryOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">QueryOptions</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#decryptionKeys" class="tsd-kind-icon">decryption<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageDirection" class="tsd-kind-icon">page<wbr/>Direction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageSize" class="tsd-kind-icon">page<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#peerId" class="tsd-kind-icon">peer<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#timeFilter" class="tsd-kind-icon">time<wbr/>Filter</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#callback" class="tsd-kind-icon">callback</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="decryptionKeys" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> decryption<wbr/>Keys</h3><div class="tsd-signature tsd-kind-icon">decryption<wbr/>Keys<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L91">src/lib/waku_store/index.ts:91</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Keys that will be used to decrypt messages.</p>
|
||||
</div><div><p>It can be Asymmetric Private Keys and Symmetric Keys in the same array,
|
||||
all keys will be tried with both methods.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pageDirection" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> page<wbr/>Direction</h3><div class="tsd-signature tsd-kind-icon">page<wbr/>Direction<span class="tsd-signature-symbol">?:</span> <a href="../enums/waku_store.PageDirection.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PageDirection</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L62">src/lib/waku_store/index.ts:62</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The direction in which pages are retrieved:</p>
|
||||
<ul>
|
||||
<li><a href="../enums/waku_store.PageDirection.html#BACKWARD">PageDirection.BACKWARD</a>: Most recent page first.</li>
|
||||
<li><a href="../enums/waku_store.PageDirection.html#FORWARD">PageDirection.FORWARD</a>: Oldest page first.</li>
|
||||
</ul>
|
||||
</div><div><p>Note: This does not affect the ordering of messages with the page
|
||||
(oldest message is always first).</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../enums/waku_store.PageDirection.html#BACKWARD">PageDirection.BACKWARD</a></p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pageSize" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> page<wbr/>Size</h3><div class="tsd-signature tsd-kind-icon">page<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L68">src/lib/waku_store/index.ts:68</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The number of message per page.</p>
|
||||
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../modules/waku_store.html#DefaultPageSize">DefaultPageSize</a></p>
|
||||
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="peerId" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> peer<wbr/>Id</h3><div class="tsd-signature tsd-kind-icon">peer<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerId</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L46">src/lib/waku_store/index.ts:46</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The peer to query. If undefined, a pseudo-random peer is selected from the connected Waku Store peers.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pubSubTopic" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> pub<wbr/>Sub<wbr/>Topic</h3><div class="tsd-signature tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L51">src/lib/waku_store/index.ts:51</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>The pubsub topic to pass to the query.
|
||||
See <a href="https://rfc.vac.dev/spec/23/">Waku v2 Topic Usage Recommendations</a>.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="timeFilter" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> time<wbr/>Filter</h3><div class="tsd-signature tsd-kind-icon">time<wbr/>Filter<span class="tsd-signature-symbol">?:</span> <a href="waku_store.TimeFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">TimeFilter</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L72">src/lib/waku_store/index.ts:72</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Retrieve messages with a timestamp within the provided values.</p>
|
||||
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="callback" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> callback</h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">callback<span class="tsd-signature-symbol">(</span>messages<span class="tsd-signature-symbol">: </span><a href="../modules/waku_message.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_message</a><span class="tsd-signature-symbol">.</span><a href="../classes/waku_message.WakuMessage.html" class="tsd-signature-type" data-tsd-kind="Class">WakuMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_store/index.ts#L84">src/lib/waku_store/index.ts:84</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>Callback called on pages of stored messages as they are retrieved.</p>
|
||||
</div><div><p>Allows for a faster access to the results as it is called as soon as a page
|
||||
is received. Traversal of the pages is done automatically so this function
|
||||
will invoked for each retrieved page.</p>
|
||||
<p>If the call on a page returns <code>true</code>, then traversal of the pages is aborted.
|
||||
For example, this can be used for the caller to stop the query after a
|
||||
specific message is found.</p>
|
||||
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>messages: <a href="../modules/waku_message.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_message</a><span class="tsd-signature-symbol">.</span><a href="../classes/waku_message.WakuMessage.html" class="tsd-signature-type" data-tsd-kind="Class">WakuMessage</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class="current tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="waku_store.QueryOptions.html" class="tsd-kind-icon">Query<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#decryptionKeys" class="tsd-kind-icon">decryption<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageDirection" class="tsd-kind-icon">page<wbr/>Direction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageSize" class="tsd-kind-icon">page<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#peerId" class="tsd-kind-icon">peer<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#timeFilter" class="tsd-kind-icon">time<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#callback" class="tsd-kind-icon">callback</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,3 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>waku | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="waku.html">waku</a></li></ul><h1>Namespace waku</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku.Waku.html" class="tsd-kind-icon">Waku</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku.CreateOptions.html" class="tsd-kind-icon">Create<wbr/>Options</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku.html#DefaultPingKeepAliveValueSecs" class="tsd-kind-icon">Default<wbr/>Ping<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku.html#DefaultPubSubTopic" class="tsd-kind-icon">Default<wbr/>Pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku.html#DefaultRelayKeepAliveValueSecs" class="tsd-kind-icon">Default<wbr/>Relay<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="DefaultPingKeepAliveValueSecs" class="tsd-anchor"></a><h3>Default<wbr/>Ping<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</h3><div class="tsd-signature tsd-kind-icon">Default<wbr/>Ping<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">0</span><span class="tsd-signature-symbol"> = 0</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L31">src/lib/waku.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="DefaultPubSubTopic" class="tsd-anchor"></a><h3>Default<wbr/>Pub<wbr/>Sub<wbr/>Topic</h3><div class="tsd-signature tsd-kind-icon">Default<wbr/>Pub<wbr/>Sub<wbr/>Topic<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"/waku/2/default-waku/proto"</span><span class="tsd-signature-symbol"> = '/waku/2/default-waku/proto'</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L37">src/lib/waku.ts:37</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>DefaultPubSubTopic is the default gossipsub topic to use for Waku.</p>
|
||||
</div></div></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="DefaultRelayKeepAliveValueSecs" class="tsd-anchor"></a><h3>Default<wbr/>Relay<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</h3><div class="tsd-signature tsd-kind-icon">Default<wbr/>Relay<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku.ts#L32">src/lib/waku.ts:32</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="utils.html">utils</a></li><li class="current tsd-kind-namespace"><a href="waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku.Waku.html" class="tsd-kind-icon">Waku</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku.CreateOptions.html" class="tsd-kind-icon">Create<wbr/>Options</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku.html#DefaultPingKeepAliveValueSecs" class="tsd-kind-icon">Default<wbr/>Ping<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku.html#DefaultPubSubTopic" class="tsd-kind-icon">Default<wbr/>Pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku.html#DefaultRelayKeepAliveValueSecs" class="tsd-kind-icon">Default<wbr/>Relay<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>waku_message | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="waku_message.html">waku_message</a></li></ul><h1>Namespace waku_message</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/waku_message.DecryptionMethod.html" class="tsd-kind-icon">Decryption<wbr/>Method</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku_message.WakuMessage.html" class="tsd-kind-icon">Waku<wbr/>Message</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_message.Options.html" class="tsd-kind-icon">Options</a></li></ul></section></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class="current tsd-kind-namespace"><a href="waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/waku_message.DecryptionMethod.html" class="tsd-kind-icon">Decryption<wbr/>Method</a></li><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku_message.WakuMessage.html" class="tsd-kind-icon">Waku<wbr/>Message</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_message.Options.html" class="tsd-kind-icon">Options</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>waku_relay | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="waku_relay.html">waku_relay</a></li></ul><h1>Namespace waku_relay</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku_relay.WakuRelay.html" class="tsd-kind-icon">Waku<wbr/>Relay</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_relay.GossipOptions.html" class="tsd-kind-icon">Gossip<wbr/>Options</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku_relay.html#RelayCodecs" class="tsd-kind-icon">Relay<wbr/>Codecs</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="RelayCodecs" class="tsd-anchor"></a><h3>Relay<wbr/>Codecs</h3><div class="tsd-signature tsd-kind-icon">Relay<wbr/>Codecs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/96cf24d/src/lib/waku_relay/constants.ts#L7">src/lib/waku_relay/constants.ts:7</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
||||
<p>RelayCodec is the libp2p identifier for the waku relay protocol</p>
|
||||
</div></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="proto.html">proto</a></li><li class=" tsd-kind-namespace"><a href="utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="waku_message.html">waku_<wbr/>message</a></li><li class="current tsd-kind-namespace"><a href="waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku_relay.WakuRelay.html" class="tsd-kind-icon">Waku<wbr/>Relay</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_relay.GossipOptions.html" class="tsd-kind-icon">Gossip<wbr/>Options</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku_relay.html#RelayCodecs" class="tsd-kind-icon">Relay<wbr/>Codecs</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
|
||||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue