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/functions/_waku_sdk.waitForRemotePeer...

16 lines
9.0 KiB
HTML
Raw Normal View History

Updates
2024-04-07 07:56:46 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>waitForRemotePeer | 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="../modules/_waku_sdk.html">@waku/sdk</a></li><li><a href="_waku_sdk.waitForRemotePeer.html">waitForRemotePeer</a></li></ul><h1>Function waitForRemotePeer</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="waitForRemotePeer" class="tsd-anchor"></a><span class="tsd-kind-call-signature">wait<wbr/>For<wbr/>Remote<wbr/>Peer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">waku</span>, <span class="tsd-kind-parameter">protocols</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">timeoutMs</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="#waitForRemotePeer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Wait for a remote peer to be ready given the passed protocols.
Updates
2023-06-05 11:41:59 +00:00
Must be used after attempting to connect to nodes, using
Updates
2024-02-28 15:28:34 +00:00
<a href="../classes/_waku_sdk.WakuNode.html#dial" class="tsd-kind-method">@waku/sdk!WakuNode.dial</a> or a bootstrap method with
Updates
2023-09-21 08:59:21 +00:00
<a href="_waku_sdk.createLightNode.html" class="tsd-kind-function">@waku/sdk!createLightNode</a>.</p>
Updates
2023-06-05 11:41:59 +00:00
<p>If the passed protocols is a GossipSub protocol, then it resolves only once
a peer is in a mesh, to help ensure that other peers will send and receive
message to us.</p>
Updates
2024-02-26 21:11:31 +00:00
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">waku</span>: <a href="../interfaces/_waku_sdk.Waku-1.html" class="tsd-signature-type tsd-kind-interface">Waku</a></span><div class="tsd-comment tsd-typography"><p>The Waku Node</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><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></span><div class="tsd-comment tsd-typography"><p>The protocols that need to be enabled by remote peers.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">timeoutMs</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>A timeout value in milliseconds..</p>
Updates
2024-02-01 23:33:30 +00:00
</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">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>A promise that <strong>resolves</strong> if all desired protocols are fulfilled by
Updates
2023-09-21 08:59:21 +00:00
remote nodes, <strong>rejects</strong> if the timeoutMs is reached.</p>
Updates
2023-11-28 15:58:49 +00:00
<div class="tsd-comment tsd-typography"><h4>Throws</h4><p>If passing a protocol that is not mounted</p>
Updates
2024-08-12 23:54:43 +00:00
<h4>Default</h4><pre><code class="language-ts"><span class="hl-8">Wait</span><span class="hl-1"> </span><span class="hl-8">for</span><span class="hl-1"> </span><span class="hl-8">remote</span><span class="hl-1"> </span><span class="hl-8">peers</span><span class="hl-1"> </span><span class="hl-6">with</span><span class="hl-1"> </span><span class="hl-8">protocols</span><span class="hl-1"> </span><span class="hl-8">enabled</span><span class="hl-1"> </span><span class="hl-8">locally</span><span class="hl-1"> </span><span class="hl-8">and</span><span class="hl-1"> </span><span class="hl-8">no</span><span class="hl-1"> </span><span class="hl-8">time</span><span class="hl-1"> </span><span class="hl-8">out</span><span class="hl-1"> </span><span class="hl-8">is</span><span class="hl-1"> </span><span class="hl-8">applied</span><span class="hl-1">.</span>
Updates
2023-09-21 08:59:21 +00:00
</code><button>Copy</button></pre>
Updates
2024-10-04 23:51:11 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/d37e0245cf265697d89319b5efb1e5535af30cd5/packages/sdk/src/wait_for_remote_peer.ts#L29">packages/sdk/src/wait_for_remote_peer.ts:29</a></li></ul></aside></li></ul></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></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>