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>discovery | 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></ul><h1>Namespace discovery</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.html#getPredefinedBootstrapNodes" class="tsd-kind-icon">get<wbr/>Predefined<wbr/>Bootstrap<wbr/>Nodes</a></li></ul></section><section class="tsd-index-section "><h3>Namespaces</h3><ul class="tsd-index-list"><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="discovery.dns.html" class="tsd-kind-icon">dns</a></li><li class="tsd-kind-namespace tsd-parent-kind-namespace"><a href="discovery.predefined.html" class="tsd-kind-icon">predefined</a></li></ul></section><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/discovery.Bootstrap.html" class="tsd-kind-icon">Bootstrap</a></li><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/discovery.DnsOverHttps.html" class="tsd-kind-icon">Dns<wbr/>Over<wbr/>Https</a></li><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/discovery.ENRTree.html" class="tsd-kind-icon">ENRTree</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/discovery.BootstrapOptions.html" class="tsd-kind-icon">Bootstrap<wbr/>Options</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="discovery.html#ENRRootValues" class="tsd-kind-icon">ENRRoot<wbr/>Values</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="discovery.html#ENRTreeValues" class="tsd-kind-icon">ENRTree<wbr/>Values</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="discovery.html#Endpoints" class="tsd-kind-icon">Endpoints</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="discovery.html#getPseudoRandomSubset" class="tsd-kind-icon">get<wbr/>Pseudo<wbr/>Random<wbr/>Subset</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>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="ENRRootValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ENRRoot<wbr/>Values<a href="#ENRRootValues" 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">ENRRoot<wbr/>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>eRoot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>lRoot<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/enrtree.ts#L8">src/lib/discovery/enrtree.ts:8</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>e<wbr/>Root<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>l<wbr/>Root<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>seq<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>signature<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="ENRTreeValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link">ENRTree<wbr/>Values<a href="#ENRTreeValues" 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">ENRTree<wbr/>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>publicKey<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/enrtree.ts#L15">src/lib/discovery/enrtree.ts:15</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>domain<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li><li class="tsd-parameter"><h5>public<wbr/>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-namespace"><a id="Endpoints" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Endpoints<a href="#Endpoints" 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">Endpoints<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"doh"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dns"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Endpoint</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">EndpointProps</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</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/dns_over_https.ts#L15">src/lib/discovery/dns_over_https.ts:15</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a id="getPseudoRandomSubset" class="tsd-anchor"></a><h3 class="tsd-anchor-link">get<wbr/>Pseudo<wbr/>Random<wbr/>Subset<a href="#getPseudoRandomSubset" 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-function tsd-parent-kind-namespace tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">get<wbr/>Pseudo<wbr/>Random<wbr/>Subset<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>values<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span>, wantedNumber<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" data-tsd-kind="Type parameter">T</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/ac56778/src/lib/discovery/index.ts#L10">src/lib/discovery/index.ts:10</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>values: <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">[]</span></h5></li><li><h5>wantedNumber: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><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="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=" 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.html#getPredefinedBootstrapNodes" class="tsd-kind-icon">get<wbr/>Predefined<wbr/>Bootstrap<wbr/>Nodes</a></li><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/discovery.Bootstrap.html" class="tsd-kind-icon">Bootstrap</a></li><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/discovery.DnsOverHttps.html" class="tsd-kind-icon">Dns<wbr/>Over<wbr/>Https</a></li><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/discovery.ENRTree.html" class="tsd-kind-icon">ENRTree</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/discovery.BootstrapOptions.html" class="tsd-kind-icon">Bootstrap<wbr/>Options</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="discovery.html#ENRRootValues" class="tsd-kind-icon">ENRRoot<wbr/>Values</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="discovery.html#ENRTreeValues" class="tsd-kind-icon">ENRTree<wbr/>Values</a></li><li class="tsd-kind-type-alias tsd-parent-kind-namespace"><a href="discovery.html#Endpoints" class="tsd-kind-icon">Endpoints</a></li><li class="tsd-kind-function tsd-parent-kind-namespace tsd-has-type-parameter"><a href="discovery.html#getPseudoRandomSubset" class="tsd-kind-icon">get<wbr/>Pseudo<wbr/>Random<wbr/>Subset</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> |