waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
js-waku/modules/_waku_sdk.html

145 lines
34 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@waku/sdk - v0.0.29 | Documentation</title><meta name="description" content="Documentation for Documentation"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Documentation</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Documentation</a></li><li><a href="_waku_sdk.html">@waku/sdk</a></li></ul><h1>Module @waku/sdk - v0.0.29</h1></div><section class="tsd-panel tsd-typography"><p><img src="https://img.shields.io/github/actions/workflow/status/waku-org/js-waku/ci.yml?branch=master" alt="GitHub Action">
<img src="https://img.shields.io/codeclimate/maintainability/waku-org/js-waku" alt="Code Climate">
<a href="https://discord.waku.org"><img src="https://img.shields.io/discord/1110799176264056863.svg?logo=discord&colorB=7289DA" alt="Discord chat"></a></p>
<a id="md:js-waku" class="tsd-anchor"></a><h1><a href="#md:js-waku">js-waku</a></h1><p>A TypeScript implementation of the <a href="https://rfc.vac.dev/spec/10/">Waku v2 protocol</a>.</p>
<a id="md:documentation" class="tsd-anchor"></a><h2><a href="#md:documentation">Documentation</a></h2><ul>
<li><a href="https://docs.waku.org/guides/js-waku/#getting-started">Quick start</a></li>
<li><a href="https://docs.waku.org/guides/js-waku">Full documentation</a></li>
<li><a href="https://js.waku.org/">API documentation (<code>master</code> branch)</a></li>
<li><a href="https://waku.org/">Waku</a></li>
<li><a href="https://vac.dev/">Vac</a></li>
</ul>
<p>API Documentation can also be generated locally:</p>
<pre><code class="language-shell"><span class="hl-0">git</span><span class="hl-1"> </span><span class="hl-2">clone</span><span class="hl-1"> </span><span class="hl-2">https://github.com/waku-org/js-waku.git</span><br/><span class="hl-0">cd</span><span class="hl-1"> </span><span class="hl-2">js-waku</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">doc</span>
</code><button>Copy</button></pre>
<a id="md:bugs-questions-amp-features" class="tsd-anchor"></a><h2><a href="#md:bugs-questions-amp-features">Bugs, Questions &amp; Features</a></h2><p>If you encounter any bug or would like to propose new features, feel free to <a href="https://github.com/waku-org/js-waku/issues/new/">open an issue</a>.</p>
<p>For general discussion, get help or latest news, join us on <a href="https://discord.gg/Nrac59MfSX">Vac Discord</a> or the <a href="https://t.me/waku_org">Waku Telegram Group</a>.</p>
<a id="md:roadmap" class="tsd-anchor"></a><h2><a href="#md:roadmap">Roadmap</a></h2><p>You can track progress on the <a href="https://github.com/orgs/waku-org/projects/2/views/1">project board</a>.</p>
<a id="md:contributing" class="tsd-anchor"></a><h2><a href="#md:contributing">Contributing</a></h2><p>See <a href="https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>.</p>
<a id="md:license" class="tsd-anchor"></a><h2><a href="#md:license">License</a></h2><p>Licensed and distributed under either of</p>
<ul>
<li>MIT license: <a href="https://github.com/waku-org/js-waku/blob/master/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="https://github.com/waku-org/js-waku/blob/master/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>
</section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Namespaces</h3><div class="tsd-index-list"><a href="_waku_sdk.utils.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4"></use></svg><span>utils</span></a>
<a href="_waku_sdk.waku.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4"></use></svg><span>waku</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="../enums/_waku_sdk.EConnectionStateEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>EConnection<wbr/>State<wbr/>Events</span></a>
<a href="../enums/_waku_sdk.EPeersByDiscoveryEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>EPeers<wbr/>By<wbr/>Discovery<wbr/>Events</span></a>
<a href="../enums/_waku_sdk.HealthStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Health<wbr/>Status</span></a>
<a href="../enums/_waku_sdk.ProtocolError.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Protocol<wbr/>Error</span></a>
<a href="../enums/_waku_sdk.Protocols.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Protocols</span></a>
<a href="../enums/_waku_sdk.Tags.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-8"></use></svg><span>Tags</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_waku_sdk.DecodedMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Decoded<wbr/>Message</span></a>
<a href="../classes/_waku_sdk.Decoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Decoder</span></a>
<a href="../classes/_waku_sdk.Encoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Encoder</span></a>
<a href="../classes/_waku_sdk.WakuNode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Waku<wbr/>Node</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Interfaces</h3><div class="tsd-index-list"><a href="../interfaces/_waku_sdk.ConnectionManagerOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Connection<wbr/>Manager<wbr/>Options</span></a>
<a href="../interfaces/_waku_sdk.DiscoveryTrigger.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Discovery<wbr/>Trigger</span></a>
<a href="../interfaces/_waku_sdk.DnsClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Dns<wbr/>Client</span></a>
<a href="../interfaces/_waku_sdk.DnsDiscOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Dns<wbr/>Disc<wbr/>Options</span></a>
<a href="../interfaces/_waku_sdk.DnsDiscoveryComponents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Dns<wbr/>Discovery<wbr/>Components</span></a>
<a href="../interfaces/_waku_sdk.EncoderOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Encoder<wbr/>Options</span></a>
<a href="../interfaces/_waku_sdk.Failure.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Failure</span></a>
<a href="../interfaces/_waku_sdk.IAsyncIterator.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IAsync<wbr/>Iterator</span></a>
<a href="../interfaces/_waku_sdk.IConnectionManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IConnection<wbr/>Manager</span></a>
<a href="../interfaces/_waku_sdk.IConnectionStateEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IConnection<wbr/>State<wbr/>Events</span></a>
<a href="../interfaces/_waku_sdk.IDecodedMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IDecoded<wbr/>Message</span></a>
<a href="../interfaces/_waku_sdk.IDecoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IDecoder</span></a>
<a href="../interfaces/_waku_sdk.IEncoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IEncoder</span></a>
<a href="../interfaces/_waku_sdk.IEnr.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IEnr</span></a>
<a href="../interfaces/_waku_sdk.IHealthManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IHealth<wbr/>Manager</span></a>
<a href="../interfaces/_waku_sdk.IMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IMessage</span></a>
<a href="../interfaces/_waku_sdk.IMetaSetter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IMeta<wbr/>Setter</span></a>
<a href="../interfaces/_waku_sdk.IMetadata.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IMetadata</span></a>
<a href="../interfaces/_waku_sdk.IPeerExchange.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IPeer<wbr/>Exchange</span></a>
<a href="../interfaces/_waku_sdk.IPeersByDiscoveryEvents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IPeers<wbr/>By<wbr/>Discovery<wbr/>Events</span></a>
<a href="../interfaces/_waku_sdk.IProtoMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IProto<wbr/>Message</span></a>
<a href="../interfaces/_waku_sdk.IRateLimitProof.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IRate<wbr/>Limit<wbr/>Proof</span></a>
<a href="../interfaces/_waku_sdk.IReceiver.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IReceiver</span></a>
<a href="../interfaces/_waku_sdk.IRelayAPI.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IRelayAPI</span></a>
<a href="../interfaces/_waku_sdk.ISender.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>ISender</span></a>
<a href="../interfaces/_waku_sdk.ISubscription.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>ISubscription</span></a>
<a href="../interfaces/_waku_sdk.IWaku.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>IWaku</span></a>
<a href="../interfaces/_waku_sdk.KeepAliveOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Keep<wbr/>Alive<wbr/>Options</span></a>
<a href="../interfaces/_waku_sdk.LightNode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Light<wbr/>Node</span></a>
<a href="../interfaces/_waku_sdk.NodeCapabilityCount.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Node<wbr/>Capability<wbr/>Count</span></a>
<a href="../interfaces/_waku_sdk.PeerExchangeComponents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Peer<wbr/>Exchange<wbr/>Components</span></a>
<a href="../interfaces/_waku_sdk.PeerExchangeQueryParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Peer<wbr/>Exchange<wbr/>Query<wbr/>Params</span></a>
<a href="../interfaces/_waku_sdk.PeerExchangeResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Peer<wbr/>Exchange<wbr/>Response</span></a>
<a href="../interfaces/_waku_sdk.PeerInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Peer<wbr/>Info</span></a>
<a href="../interfaces/_waku_sdk.PeersByDiscoveryResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Peers<wbr/>By<wbr/>Discovery<wbr/>Result</span></a>
<a href="../interfaces/_waku_sdk.RelayNode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Relay<wbr/>Node</span></a>
<a href="../interfaces/_waku_sdk.SingleShardInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Single<wbr/>Shard<wbr/>Info</span></a>
<a href="../interfaces/_waku_sdk.Waku2.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Waku2</span></a>
<a href="../interfaces/_waku_sdk.WakuOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-256"></use></svg><span>Waku<wbr/>Options</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Type Aliases</h3><div class="tsd-index-list"><a href="../types/_waku_sdk.ActiveSubscriptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Active<wbr/>Subscriptions</span></a>
<a href="../types/_waku_sdk.AutoSharding.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Auto<wbr/>Sharding</span></a>
<a href="../types/_waku_sdk.Callback.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Callback</span></a>
<a href="../types/_waku_sdk.ContentTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Content<wbr/>Topic</span></a>
<a href="../types/_waku_sdk.ContentTopicInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Content<wbr/>Topic<wbr/>Info</span></a>
<a href="../types/_waku_sdk.CoreProtocolResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Core<wbr/>Protocol<wbr/>Result</span></a>
<a href="../types/_waku_sdk.CreateLibp2pOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Create<wbr/>Libp2p<wbr/>Options</span></a>
<a href="../types/_waku_sdk.CreateSubscriptionResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Create<wbr/>Subscription<wbr/>Result</span></a>
<a href="../types/_waku_sdk.CreateWakuNodeOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Create<wbr/>Waku<wbr/>Node<wbr/>Options</span></a>
<a href="../types/_waku_sdk.ENRKey.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ENRKey</span></a>
<a href="../types/_waku_sdk.ENRValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ENRValue</span></a>
<a href="../types/_waku_sdk.IBaseProtocolCore.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IBase<wbr/>Protocol<wbr/>Core</span></a>
<a href="../types/_waku_sdk.IBaseProtocolSDK.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IBase<wbr/>ProtocolSDK</span></a>
<a href="../types/_waku_sdk.IFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IFilter</span></a>
<a href="../types/_waku_sdk.ILightPush.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ILight<wbr/>Push</span></a>
<a href="../types/_waku_sdk.IRelay.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IRelay</span></a>
<a href="../types/_waku_sdk.ISenderOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>ISender<wbr/>Options</span></a>
<a href="../types/_waku_sdk.IStore.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IStore</span></a>
<a href="../types/_waku_sdk.IStoreCore.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>IStore<wbr/>Core</span></a>
<a href="../types/_waku_sdk.Libp2p.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Libp2p</span></a>
<a href="../types/_waku_sdk.Libp2pComponents.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Libp2p<wbr/>Components</span></a>
<a href="../types/_waku_sdk.Libp2pServices.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Libp2p<wbr/>Services</span></a>
<a href="../types/_waku_sdk.LocalStoragePeerInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Local<wbr/>Storage<wbr/>Peer<wbr/>Info</span></a>
<a href="../types/_waku_sdk.MetadataQueryResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Metadata<wbr/>Query<wbr/>Result</span></a>
<a href="../types/_waku_sdk.NetworkConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Network<wbr/>Config</span></a>
<a href="../types/_waku_sdk.NodeHealth.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Node<wbr/>Health</span></a>
<a href="../types/_waku_sdk.NodeId.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Node<wbr/>Id</span></a>
<a href="../types/_waku_sdk.PeerExchangeQueryResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Peer<wbr/>Exchange<wbr/>Query<wbr/>Result</span></a>
<a href="../types/_waku_sdk.PeerIdStr.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Peer<wbr/>Id<wbr/>Str</span></a>
<a href="../types/_waku_sdk.ProtocolCreateOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Protocol<wbr/>Create<wbr/>Options</span></a>
<a href="../types/_waku_sdk.ProtocolHealth.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Protocol<wbr/>Health</span></a>
<a href="../types/_waku_sdk.ProtocolUseOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Protocol<wbr/>Use<wbr/>Options</span></a>
<a href="../types/_waku_sdk.ProtocolsHealthStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Protocols<wbr/>Health<wbr/>Status</span></a>
<a href="../types/_waku_sdk.PubsubTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Pubsub<wbr/>Topic</span></a>
<a href="../types/_waku_sdk.QueryRequestParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Query<wbr/>Request<wbr/>Params</span></a>
<a href="../types/_waku_sdk.SDKProtocolResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>SDKProtocol<wbr/>Result</span></a>
<a href="../types/_waku_sdk.SearchContext.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Search<wbr/>Context</span></a>
<a href="../types/_waku_sdk.SequenceNumber.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Sequence<wbr/>Number</span></a>
<a href="../types/_waku_sdk.ShardInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Shard<wbr/>Info</span></a>
<a href="../types/_waku_sdk.StaticSharding.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Static<wbr/>Sharding</span></a>
<a href="../types/_waku_sdk.StoreCursor.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Store<wbr/>Cursor</span></a>
<a href="../types/_waku_sdk.SubscribeOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Subscribe<wbr/>Options</span></a>
<a href="../types/_waku_sdk.SubscribeResult.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Subscribe<wbr/>Result</span></a>
<a href="../types/_waku_sdk.SubscriptionCallback.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Subscription<wbr/>Callback</span></a>
<a href="../types/_waku_sdk.ThisAndThat.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>This<wbr/>And<wbr/>That</span></a>
<a href="../types/_waku_sdk.ThisOrThat.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>This<wbr/>Or<wbr/>That</span></a>
<a href="../types/_waku_sdk.Unsubscribe.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2097152"></use></svg><span>Unsubscribe</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_waku_sdk.DEFAULT_CLUSTER_ID.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>DEFAULT_<wbr/>CLUSTER_<wbr/>ID</span></a>
<a href="../variables/_waku_sdk.DNS_DISCOVERY_TAG.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>DNS_<wbr/>DISCOVERY_<wbr/>TAG</span></a>
<a href="../variables/_waku_sdk.DefaultNetworkConfig.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Default<wbr/>Network<wbr/>Config</span></a>
<a href="../variables/_waku_sdk.DefaultPingKeepAliveValueSecs.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Default<wbr/>Ping<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</span></a>
<a href="../variables/_waku_sdk.DefaultPingMaxInboundStreams.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Default<wbr/>Ping<wbr/>Max<wbr/>Inbound<wbr/>Streams</span></a>
<a href="../variables/_waku_sdk.DefaultRelayKeepAliveValueSecs.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Default<wbr/>Relay<wbr/>Keep<wbr/>Alive<wbr/>Value<wbr/>Secs</span></a>
<a href="../variables/_waku_sdk.DefaultShardInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Default<wbr/>Shard<wbr/>Info</span></a>
<a href="../variables/_waku_sdk.DefaultUserAgent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Default<wbr/>User<wbr/>Agent</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_waku_sdk.bytesToUtf8.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>bytes<wbr/>To<wbr/>Utf8</span></a>
<a href="../functions/_waku_sdk.createDecoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Decoder</span></a>
<a href="../functions/_waku_sdk.createEncoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Encoder</span></a>
<a href="../functions/_waku_sdk.createLibp2pAndUpdateOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Libp2p<wbr/>And<wbr/>Update<wbr/>Options</span></a>
<a href="../functions/_waku_sdk.createLightNode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>create<wbr/>Light<wbr/>Node</span></a>
<a href="../functions/_waku_sdk.defaultLibp2p.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>default<wbr/>Libp2p</span></a>
<a href="../functions/_waku_sdk.utf8ToBytes.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>utf8<wbr/>To<wbr/>Bytes</span></a>
<a href="../functions/_waku_sdk.waitForRemotePeer.html" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>wait<wbr/>For<wbr/>Remote<wbr/>Peer</span></a>
<a href="../functions/_waku_sdk.wakuFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>waku<wbr/>Filter</span></a>
<a href="../functions/_waku_sdk.wakuLightPush.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>waku<wbr/>Light<wbr/>Push</span></a>
<a href="../functions/_waku_sdk.wakuStore.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>waku<wbr/>Store</span></a>
</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:js-waku"><span>js-<wbr/>waku</span></a><ul><li><a href="#md:documentation"><span>Documentation</span></a></li><li><a href="#md:bugs-questions-amp-features"><span>Bugs, <wbr/>Questions &amp; <wbr/>Features</span></a></li><li><a href="#md:roadmap"><span>Roadmap</span></a></li><li><a href="#md:contributing"><span>Contributing</span></a></li><li><a href="#md:license"><span>License</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Documentation</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink