waku-org/js-waku
1
0
Fork 0
mirror of https://github.com/waku-org/js-waku.git synced 2025-01-16 15:34:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
js-waku/classes/_waku_sdk.WakuNode.html

20 lines
48 KiB
HTML
Raw Normal View History

Updates
2023-11-28 15:58:49 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WakuNode | 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/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">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="#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="../modules/_waku_sdk.html">@waku/sdk</a></li><li><a href="_waku_sdk.WakuNode.html">WakuNode</a></li></ul><h1>Class WakuNode</h1></div><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../interfaces/_waku_sdk.Waku-1.html" class="tsd-signature-type tsd-kind-interface">Waku</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in packages/core/dist/lib/waku.d.ts:31</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="_waku_sdk.WakuNode.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_waku_sdk.WakuNode.html#connectionManager" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>connection<wbr/>Manager</span></a>
Updates
2023-09-21 08:59:21 +00:00
<a href="_waku_sdk.WakuNode.html#filter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>filter?</span></a>
<a href="_waku_sdk.WakuNode.html#libp2p" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>libp2p</span></a>
<a href="_waku_sdk.WakuNode.html#lightPush" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>light<wbr/>Push?</span></a>
Updates
2023-10-16 07:24:41 +00:00
<a href="_waku_sdk.WakuNode.html#pubsubTopics" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>pubsub<wbr/>Topics</span></a>
Updates
2023-09-21 08:59:21 +00:00
<a href="_waku_sdk.WakuNode.html#relay" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>relay?</span></a>
<a href="_waku_sdk.WakuNode.html#store" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>store?</span></a>
Updates
2023-11-28 15:58:49 +00:00
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_waku_sdk.WakuNode.html#dial" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>dial</span></a>
Updates
2023-09-21 08:59:21 +00:00
<a href="_waku_sdk.WakuNode.html#getLocalMultiaddrWithID" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Local<wbr/>Multiaddr<wbr/>WithID</span></a>
Updates
2023-11-27 11:46:51 +00:00
<a href="_waku_sdk.WakuNode.html#isConnected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Connected</span></a>
Updates
2023-09-21 08:59:21 +00:00
<a href="_waku_sdk.WakuNode.html#isStarted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>is<wbr/>Started</span></a>
<a href="_waku_sdk.WakuNode.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>start</span></a>
<a href="_waku_sdk.WakuNode.html#stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>stop</span></a>
Updates
2024-01-10 07:37:02 +00:00
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_WakuNode" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Waku<wbr/>Node</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span>, <span class="tsd-kind-parameter">pubsubTopics</span>, <span class="tsd-kind-parameter">libp2p</span>, <span class="tsd-kind-parameter">pubsubShardInfo</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">store</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">lightPush</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">relay</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_waku_sdk.WakuNode.html" class="tsd-signature-type tsd-kind-class">WakuNode</a><a href="#constructor.new_WakuNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">options</span>: <a href="../modules/_waku_sdk.waku.html" class="tsd-signature-type tsd-kind-namespace">waku</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_sdk.waku.waku.html" class="tsd-signature-type tsd-kind-namespace">waku</a><span class="tsd-signature-symbol">.</span><a href="../interfaces/_waku_sdk.waku.waku.WakuOptions.html" class="tsd-signature-type tsd-kind-interface">WakuOptions</a></h5></li><li><h5><span class="tsd-kind-parameter">pubsubTopics</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5><span class="tsd-kind-parameter">libp2p</span>: <a href="../types/_waku_sdk.Libp2p.html" class="tsd-signature-type tsd-kind-type-alias">Libp2p</a></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">pubsubShardInfo</span>: <a href="../types/_waku_sdk.ShardingParams.html" class="tsd-signature-type tsd-kind-type-alias">ShardingParams</a></h5></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">store</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">libp2p</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="../interfaces/_waku_sdk.IStore.html" class="tsd-signature-type tsd-kind-interface">IStore</a><span class="tsd-signature-symbol">)</span></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">libp2p</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_waku_sdk.IStore.html" class="tsd-signature-type tsd-kind-interface">IStore</a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">libp2p</span>: <a href="../types/_waku_sdk.Libp2p.html" class="tsd-signature-type tsd-kind-type-alias">Libp2p</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../i
Updates
2023-11-28 15:58:49 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">peer</span>: <span class="tsd-signature-type ">PeerId</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">MultiaddrInput</span></h5><div class="tsd-comment tsd-typography"><p>The peer to dial</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">protocols</span>: <a href="../enums/_waku_sdk.Protocols.html" class="tsd-signature-type tsd-kind-enum">Protocols</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Waku protocols we expect from the peer; Defaults to mounted protocols</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Stream</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_sdk.Waku-1.html">Waku</a>.<a href="../interfaces/_waku_sdk.Waku-1.html#dial">dial</a></p><ul><li>Defined in packages/core/dist/lib/waku.d.ts:46</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getLocalMultiaddrWithID" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Local<wbr/>Multiaddr<wbr/>WithID</span><a href="#getLocalMultiaddrWithID" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getLocalMultiaddrWithID.getLocalMultiaddrWithID-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Local<wbr/>Multiaddr<wbr/>WithID</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#getLocalMultiaddrWithID.getLocalMultiaddrWithID-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Return the local multiaddr with peer id on which libp2p is listening.</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"><h4>Throws</h4><p>if libp2p is not listening on localhost.</p>
</div><aside class="tsd-sources"><ul><li>Defined in packages/core/dist/lib/waku.d.ts:56</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isConnected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Connected</span><a href="#isConnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isConnected.isConnected-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Connected</span><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><a href="#isConnected.isConnected-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_sdk.Waku-1.html">Waku</a>.<a href="../interfaces/_waku_sdk.Waku-1.html#isConnected">isConnected</a></p><ul><li>Defined in packages/core/dist/lib/waku.d.ts:50</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isStarted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Started</span><a href="#isStarted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isStarted.isStarted-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Started</span><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><a href="#isStarted.isStarted-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_sdk.Waku-1.html">Waku</a>.<a href="../interfaces/_waku_sdk.Waku-1.html#isStarted">isStarted</a></p><ul><li>Defined in packages/core/dist/lib/waku.d.ts:49</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start</span><a href="#start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="start.start-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start</span><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#start.start-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources"><p>Implementation of <a href="../interfaces/_waku_sdk.Waku-1.html">Waku</a>.<a href="../interfaces/_waku_sdk.Waku-1.html#start">start</a></p><ul><li>Defined in packages/core/dist/lib/waku.d.ts:47</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stop" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stop</span><a href="#stop" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="
Reference in New Issue Copy Permalink