2024-03-07 22:11:55 +00:00
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>LocalPeerCacheDiscovery | 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_local_peer_cache_discovery.html">@waku/local-peer-cache-discovery</a></li><li><a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html">LocalPeerCacheDiscovery</a></li></ul><h1>Class LocalPeerCacheDiscovery</h1></div><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">TypedEventEmitter</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">PeerDiscoveryEvents</span><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li><span class="target">LocalPeerCacheDiscovery</span></li></ul></li></ul></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">PeerDiscovery</span></li><li><span class="tsd-signature-type">Startable</span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/fb41f4c72/packages/local-peer-cache-discovery/src/index.ts#L31">packages/local-peer-cache-discovery/src/index.ts:31</a></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_local_peer_cache_discovery.LocalPeerCacheDiscovery.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>
|
2024-02-28 19:37:18 +00:00
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#_private" class="tsd-index-link tsd-is-private tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#private</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#components" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>components</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#isStarted" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>is<wbr/>Started</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#options" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>options?</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#peers" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>peers</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#_toStringTag_" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>[to<wbr/>String<wbr/>Tag]</span></a>
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#addEventListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>add<wbr/>Event<wbr/>Listener</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#dispatchEvent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>dispatch<wbr/>Event</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#getPeersFromLocalStorage" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Peers<wbr/>From<wbr/>Local<wbr/>Storage</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#handleNewPeers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>handle<wbr/>New<wbr/>Peers</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#listenerCount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#removeEventListener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>remove<wbr/>Event<wbr/>Listener</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#safeDispatchEvent" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>safe<wbr/>Dispatch<wbr/>Event</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html#savePeersToLocalStorage" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>save<wbr/>Peers<wbr/>To<wbr/>Local<wbr/>Storage</span></a>
|
|
|
|
|
<a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.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_local_peer_cache_discovery.LocalPeerCacheDiscovery.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>
|
2024-03-07 22:11:55 +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_LocalPeerCacheDiscovery" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Local<wbr/>Peer<wbr/>Cache<wbr/>Discovery</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">components</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html" class="tsd-signature-type tsd-kind-class">LocalPeerCacheDiscovery</a><a href="#constructor.new_LocalPeerCacheDiscovery" 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><span><span class="tsd-kind-parameter">components</span>: <span class="tsd-signature-type">Components</span></span></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">LocalPeerCacheDiscoveryOptions</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="_waku_local_peer_cache_discovery.LocalPeerCacheDiscovery.html" class="tsd-signature-type tsd-kind-class">LocalPeerCacheDiscovery</a></h4><aside class="tsd-sources"><p>Overrides TypedEventEmitter<PeerDiscoveryEvents>.constructor</p><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/fb41f4c72/packages/local-peer-cache-discovery/src/index.ts#L38">packages/local-peer-cache-discovery/src/index.ts:38</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private tsd-is-inherited tsd-is-external"><a id="_private" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#private</span><a href="#_private" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">#private</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div><aside class="tsd-sources"><p>Inherited from TypedEventEmitter.#private</p><ul><li>Defined in node_modules/@libp2p/interface/dist/src/event-target.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="components" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>components</span><a href="#components" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">components</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Components</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/fb41f4c72/packages/local-peer-cache-discovery/src/index.ts#L39">packages/local-peer-cache-discovery/src/index.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-private"><a id="isStarted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>is<wbr/>Started</span><a href="#isStarted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"
|
