2022-02-23 23:57:01 +00:00
<!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 = "../modules/waku.html" > waku< / a > < / li > < li > < a href = "waku.Waku.html" > Waku< / a > < / li > < / ul > < h1 > Class Waku< / 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" > Waku< / 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 tsd-is-private tsd-is-private-protected" > < h3 > Constructors< / h3 > < ul class = "tsd-index-list" > < li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.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 = "waku.Waku.html#libp2p" class = "tsd-kind-icon" > libp2p< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "waku.Waku.html#lightPush" class = "tsd-kind-icon" > light< wbr / > Push< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.html#pingKeepAliveTimers" class = "tsd-kind-icon" > ping< wbr / > Keep< wbr / > Alive< wbr / > Timers< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "waku.Waku.html#relay" class = "tsd-kind-icon" > relay< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.html#relayKeepAliveTimers" class = "tsd-kind-icon" > relay< wbr / > Keep< wbr / > Alive< wbr / > Timers< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "waku.Waku.html#store" class = "tsd-kind-icon" > store< / 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 = "waku.Waku.html#addDecryptionKey" class = "tsd-kind-icon" > add< wbr / > Decryption< wbr / > Key< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "waku.Waku.html#addPeerToAddressBook" class = "tsd-kind-icon" > add< wbr / > Peer< wbr / > To< wbr / > Address< wbr
2022-01-24 10:13:20 +00:00
< p > Register a decryption key to attempt decryption of messages received via
< a href = "waku_relay.WakuRelay.html" > WakuRelay< / a > and < a href = "waku_store.WakuStore.html" > WakuStore< / a > . This can either be a private key for
asymmetric encryption or a symmetric key.< / p >
< / div > < div > < p > Strings must be in hex format.< / p >
2022-02-23 23:57:01 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > key: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Uint8Array< / span > < / h5 > < / li > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < span class = "tsd-signature-symbol" > { < / span > contentTopics< 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 > method< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../enums/waku_message.DecryptionMethod.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DecryptionMethod< / a > < span class = "tsd-signature-symbol" > }< / span > < / h5 > < ul class = "tsd-parameters" > < li class = "tsd-parameter" > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > content< wbr / > Topics< span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < / h5 > < / li > < li class = "tsd-parameter" > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > method< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../enums/waku_message.DecryptionMethod.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > DecryptionMethod< / a > < / h5 > < / li > < / ul > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "addPeerToAddressBook" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > add< wbr / > Peer< wbr / > To< wbr / > Address< wbr / > Book< a href = "#addPeerToAddressBook" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > add< wbr / > Peer< wbr / > To< wbr / > Address< wbr / > Book< span class = "tsd-signature-symbol" > (< / span > peerId< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > PeerId< / span > , multiaddrs< 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 > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > []< / span > < span class = "tsd-signature-symbol" > )< / 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/b50e211/src/lib/waku.ts#L261" > src/lib/waku.ts:261< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 10:13:20 +00:00
< p > Add peer to address book, it will be auto-dialed in the background.< / p >
2022-02-23 23:57:01 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > peerId: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > PeerId< / span > < / h5 > < / li > < li > < h5 > multiaddrs: < span class = "tsd-signature-type" > Multiaddr< / span > < 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 > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "deleteDecryptionKey" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > delete< wbr / > Decryption< wbr / > Key< a href = "#deleteDecryptionKey" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > delete< wbr / > Decryption< wbr / > Key< span class = "tsd-signature-symbol" > (< / span > 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 > < span class = "tsd-signature-symbol" > )< / 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/b50e211/src/lib/waku.ts#L306" > src/lib/waku.ts:306< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 10:13:20 +00:00
< p > Delete a decryption key that was used to attempt decryption of messages
received via < a href = "waku_relay.WakuRelay.html" > WakuRelay< / a > or < a href = "waku_store.WakuStore.html" > WakuStore< / a > .< / p >
< / div > < div > < p > Strings must be in hex format.< / p >
2022-02-23 23:57:01 +00:00
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > key: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Uint8Array< / span > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "dial" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > dial< a href = "#dial" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > dial< span class = "tsd-signature-symbol" > (< / span > peer< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Multiaddr< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > PeerId< / span > , protocols< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../enums/waku.Protocols.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > Protocols< / a > < 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-symbol" > { < / span > protocol< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > stream< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > MuxedStream< / 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/b50e211/src/lib/waku.ts#L235" > src/lib/waku.ts:235< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 10:13:20 +00:00
< p > Dials to the provided peer.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > peer: < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > Multiaddr< / span > < span class = "tsd-signature-symbol" > | < / span > < span class = "tsd-signature-type" > PeerId< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > The peer to dial< / p >
2022-02-21 09:57:52 +00:00
< / div > < / div > < / li > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > protocols: < a href = "../enums/waku.Protocols.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > Protocols< / a > < span class = "tsd-signature-symbol" > []< / span > < / h5 > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
< p > Waku protocols we expect from the peer; Default to Relay< / p >
2022-02-23 23:57:01 +00:00
< / div > < / div > < / 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-symbol" > { < / span > protocol< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ; < / span > stream< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > MuxedStream< / span > < span class = "tsd-signature-symbol" > }< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "getLocalMultiaddrWithID" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > get< wbr / > Local< wbr / > Multiaddr< wbr / > WithID< a href = "#getLocalMultiaddrWithID" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > get< wbr / > Local< wbr / > Multiaddr< wbr / > WithID< 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 > < / 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/b50e211/src/lib/waku.ts#L316" > src/lib/waku.ts:316< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-01-24 10:13:20 +00:00
< p > Return the local multiaddr with peer id on which libp2p is listening.< / p >
2022-02-21 09:57:52 +00:00
< / div > < dl class = "tsd-comment-tags" > < dt > throws< / dt > < dd > < p > if libp2p is not listening on localhost.< / p >
2022-02-23 23:57:01 +00:00
< / dd > < / dl > < / div > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > string< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private" > < a id = "startKeepAlive" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagPrivate" > Private< / span > start< wbr / > Keep< wbr / > Alive< a href = "#startKeepAlive" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private" > < li class = "tsd-signature tsd-kind-icon" > start< wbr / > Keep< wbr / > Alive< span class = "tsd-signature-symbol" > (< / span > peerId< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > PeerId< / span > , pingPeriodSecs< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > , relayPeriodSecs< span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > number< / span > < span class = "tsd-signature-symbol" > )< / 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/b50e211/src/lib/waku.ts#L407" > src/lib/waku.ts:407< / a > < / li > < / ul > < / aside > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > peerId: < span class = "tsd-signature-type" > PeerId< / span > < / h5 > < / li > < li > < h5 > pingPeriodSecs: < span class = "tsd-signature-type" > number< / span > < / h5 > < / li > < li > < h5 > relayPeriodSecs: < span class = "tsd-signature-type" > number< / span > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > void< / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class" > < a id = "stop" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > stop< a href = "#stop" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class" > < li class = "tsd-signature tsd-kind-icon" > stop< 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" > void< / 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/b50e211/src/lib/waku.ts#L281" > src/lib/waku.ts:281< / a > < / li > < / ul > < / aside > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < span class = "tsd-signature-type" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private" > < a id = "stopKeepAlive" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagPrivate" > Private< / span > stop< wbr / > Keep< wbr / > Alive< a href = "#stopKeepAlive" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" strok
2022-02-01 23:05:22 +00:00
< p > Wait for a remote peer to be ready given the passed protocols.
Useful when using the < a href = "../interfaces/waku.CreateOptions.html#bootstrap" > CreateOptions.bootstrap< / a > with < a href = "waku.Waku.html#create" > Waku.create< / a > .< / p >
< / div > < dl class = "tsd-comment-tags" > < dt > default< / dt > < dd > < p > Remote peer must have Waku Store and Waku Relay enabled.< / p >
2022-02-23 23:57:01 +00:00
< / dd > < / dl > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > protocols: < a href = "../enums/waku.Protocols.html" class = "tsd-signature-type" data-tsd-kind = "Enumeration" > Protocols< / a > < span class = "tsd-signature-symbol" > []< / 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" > void< / span > < span class = "tsd-signature-symbol" > > < / span > < / h4 > < / li > < / ul > < / section > < section class = "tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static" > < a id = "create" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span class = "tsd-flag ts-flagStatic" > Static< / span > create< a href = "#create" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg xmlns = "http://www.w3.org/2000/svg" class = "icon icon-tabler icon-tabler-link" viewBox = "0 0 24 24" stroke-width = "2" stroke = "currentColor" fill = "none" stroke-linecap = "round" stroke-linejoin = "round" > < path stroke = "none" d = "M0 0h24v24H0z" fill = "none" > < / path > < path d = "M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" > < / path > < path d = "M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" > < / path > < / svg > < / a > < / h3 > < ul class = "tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static" > < li class = "tsd-signature tsd-kind-icon" > create< span class = "tsd-signature-symbol" > (< / span > options< span class = "tsd-signature-symbol" > ?: < / span > < a href = "../modules/waku.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > waku< / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "../interfaces/waku.CreateOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CreateOptions< / a > < 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 > < a href = "waku.Waku.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Waku< / a > < 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/b50e211/src/lib/waku.ts#L148" > src/lib/waku.ts:148< / a > < / li > < / ul > < / aside > < div class = "tsd-comment tsd-typography" > < div class = "lead" >
2022-02-21 09:57:52 +00:00
< p > Create and start new waku node.< / p >
< / div > < / div > < h4 class = "tsd-parameters-title" > Parameters< / h4 > < ul class = "tsd-parameters" > < li > < h5 > < span class = "tsd-flag ts-flagOptional" > Optional< / span > options: < a href = "../modules/waku.html" class = "tsd-signature-type" data-tsd-kind = "Namespace" > waku< / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "../interfaces/waku.CreateOptions.html" class = "tsd-signature-type" data-tsd-kind = "Interface" > CreateOptions< / a > < / h5 > < / li > < / ul > < h4 class = "tsd-returns-title" > Returns < span class = "tsd-signature-type" > Promise< / span > < span class = "tsd-signature-symbol" > < < / span > < a href = "waku.Waku.html" class = "tsd-signature-type" data-tsd-kind = "Class" > Waku< / a > < 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 = " 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/utf8.html" > utf8< / 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-class tsd-parent-kind-namespace" > < a href = "waku.Waku.html" class = "tsd-kind-icon" > Waku< / a > < ul > < li class = "tsd-kind-constructor tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.html#constructor" class = "tsd-kind-icon" > constructor< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "waku.Waku.html#libp2p" class = "tsd-kind-icon" > libp2p< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "waku.Waku.html#lightPush" class = "tsd-kind-icon" > light< wbr / > Push< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.html#pingKeepAliveTimers" class = "tsd-kind-icon" > ping< wbr / > Keep< wbr / > Alive< wbr / > Timers< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "waku.Waku.html#relay" class = "tsd-kind-icon" > relay< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.html#relayKeepAliveTimers" class = "tsd-kind-icon" > relay< wbr / > Keep< wbr / > Alive< wbr / > Timers< / a > < / li > < li class = "tsd-kind-property tsd-parent-kind-class" > < a href = "waku.Waku.html#store" class = "tsd-kind-icon" > store< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "waku.Waku.html#addDecryptionKey" class = "tsd-kind-icon" > add< wbr / > Decryption< wbr / > Key< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "waku.Waku.html#addPeerToAddressBook" class = "tsd-kind-icon" > add< wbr / > Peer< wbr / > To< wbr / > Address< wbr / > Book< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "waku.Waku.html#deleteDecryptionKey" class = "tsd-kind-icon" > delete< wbr / > Decryption< wbr / > Key< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "waku.Waku.html#dial" class = "tsd-kind-icon" > dial< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "waku.Waku.html#getLocalMultiaddrWithID" class = "tsd-kind-icon" > get< wbr / > Local< wbr / > Multiaddr< wbr / > WithID< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.html#startKeepAlive" class = "tsd-kind-icon" > start< wbr / > Keep< wbr / > Alive< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class" > < a href = "waku.Waku.html#stop" class = "tsd-kind-icon" > stop< / a > < / li > < li class = "tsd-kind-method tsd-parent-kind-class tsd-is-private" > < a href = "waku.Waku.html#stopKeepAlive" class = "t
