mirror of https://github.com/waku-org/js-waku.git
1 line
16 KiB
HTML
1 line
16 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>predefined | 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="discovery.html">discovery</a></li><li><a href="discovery.predefined.html">predefined</a></li></ul><h1>Namespace predefined</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>References</h3><ul class="tsd-index-list"><li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="discovery.predefined.html#getPredefinedBootstrapNodes" class="tsd-kind-icon">get<wbr/>Predefined<wbr/>Bootstrap<wbr/>Nodes</a></li></ul></section><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/discovery.predefined.Fleet.html" class="tsd-kind-icon">Fleet</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="discovery.predefined.html#DefaultWantedNumber" class="tsd-kind-icon">Default<wbr/>Wanted<wbr/>Number</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="discovery.predefined.html#fleets" class="tsd-kind-icon">fleets</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>References</h2><section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-namespace"><a id="getPredefinedBootstrapNodes" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Predefined<wbr/>Bootstrap<wbr/>Nodes<a href="#getPredefinedBootstrapNodes" 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>Re-exports <a href="../modules.html#getPredefinedBootstrapNodes">getPredefinedBootstrapNodes</a></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="DefaultWantedNumber" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Default<wbr/>Wanted<wbr/>Number<a href="#DefaultWantedNumber" 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><div class="tsd-signature tsd-kind-icon">Default<wbr/>Wanted<wbr/>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">1</span><span class="tsd-signature-symbol"> = 1</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/ac56778/src/lib/discovery/predefined.ts#L5">src/lib/discovery/predefined.ts:5</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="fleets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> fleets<a href="#fleets" 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><div class="tsd-signature tsd-kind-icon">fleets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>fleets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>waku-websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.prod<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>wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>waku-websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.test<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-symbol"> }</span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/ac56778/src/lib/discovery/predefined.ts#L48">src/lib/discovery/predefined.ts:48</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>fleets<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>waku-websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.prod<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>wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>waku-websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.test<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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>waku-websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.prod<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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>waku-<wbr/>websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>node-<wbr/>01.ac-<wbr/>cn-<wbr/>hongkong-<wbr/>c.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>node-<wbr/>01.do-<wbr/>ams3.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>node-<wbr/>01.gc-<wbr/>us-<wbr/>central1-<wbr/>a.wakuv2.prod<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></li><li class="tsd-parameter"><h5>wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>waku-websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.test<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></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>waku-<wbr/>websocket<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>node-01.ac-cn-hongkong-c.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.do-ams3.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>node-01.gc-us-central1-a.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></h5><ul class="tsd-parameters"><li class="tsd-parameter"><h5>node-<wbr/>01.ac-<wbr/>cn-<wbr/>hongkong-<wbr/>c.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>node-<wbr/>01.do-<wbr/>ams3.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>node-<wbr/>01.gc-<wbr/>us-<wbr/>central1-<wbr/>a.wakuv2.test<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></li></ul></li></ul></li></ul></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="discovery.html">discovery</a><ul><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="discovery.dns.html">dns</a></li><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="discovery.predefined.html">predefined</a></li></ul></li><li class=" tsd-kind-namespace"><a href="enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-reference tsd-parent-kind-namespace"><a href="discovery.predefined.html#getPredefinedBootstrapNodes" class="tsd-kind-icon">get<wbr/>Predefined<wbr/>Bootstrap<wbr/>Nodes</a></li><li class="tsd-kind-enum tsd-parent-kind-namespace"><a href="../enums/discovery.predefined.Fleet.html" class="tsd-kind-icon">Fleet</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="discovery.predefined.html#DefaultWantedNumber" class="tsd-kind-icon">Default<wbr/>Wanted<wbr/>Number</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="discovery.predefined.html#fleets" class="tsd-kind-icon">fleets</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |