2024-08-12 23:54:43 +00:00
|
|
|
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Waku | 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_interfaces.html">@waku/interfaces</a></li><li><a href="_waku_interfaces.Waku.html">Waku</a></li></ul><h1>Interface Waku</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">Waku</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="_waku_interfaces.Waku.html#connectionManager">connectionManager</a><span class="tsd-signature-symbol">: </span><a href="_waku_interfaces.IConnectionManager.html" class="tsd-signature-type tsd-kind-interface">IConnectionManager</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_waku_interfaces.Waku.html#filter">filter</a><span class="tsd-signature-symbol">?: </span><a href="../types/_waku_interfaces.IFilterSDK.html" class="tsd-signature-type tsd-kind-type-alias">IFilterSDK</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_waku_interfaces.Waku.html#health">health</a><span class="tsd-signature-symbol">: </span><a href="_waku_interfaces.IHealthManager.html" class="tsd-signature-type tsd-kind-interface">IHealthManager</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_waku_interfaces.Waku.html#libp2p">libp2p</a><span class="tsd-signature-symbol">: </span><a href="../types/_waku_interfaces.Libp2p.html" class="tsd-signature-type tsd-kind-type-alias">Libp2p</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_waku_interfaces.Waku.html#lightPush">lightPush</a><span class="tsd-signature-symbol">?: </span><a href="../types/_waku_interfaces.ILightPushSDK.html" class="tsd-signature-type tsd-kind-type-alias">ILightPushSDK</a><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="_waku_interfaces.Waku.html#relay">relay</a><span class="tsd-signature-symbol">?: </span><a hr
|
2024-04-07 07:56:46 +00:00
|
|
|
|
<a href="_waku_interfaces.Waku.html#filter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>filter?</span></a>
|
2024-07-27 12:59:11 +00:00
|
|
|
|
<a href="_waku_interfaces.Waku.html#health" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>health</span></a>
|
2024-04-07 07:56:46 +00:00
|
|
|
|
<a href="_waku_interfaces.Waku.html#libp2p" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>libp2p</span></a>
|
|
|
|
|
|
<a href="_waku_interfaces.Waku.html#lightPush" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>light<wbr/>Push?</span></a>
|
|
|
|
|
|
<a href="_waku_interfaces.Waku.html#relay" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>relay?</span></a>
|
|
|
|
|
|
<a href="_waku_interfaces.Waku.html#store" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>store?</span></a>
|
|
|
|
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="_waku_interfaces.Waku.html#dial" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>dial</span></a>
|
|
|
|
|
|
<a href="_waku_interfaces.Waku.html#isConnected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Connected</span></a>
|
|
|
|
|
|
<a href="_waku_interfaces.Waku.html#isStarted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Started</span></a>
|
|
|
|
|
|
<a href="_waku_interfaces.Waku.html#start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start</span></a>
|
|
|
|
|
|
<a href="_waku_interfaces.Waku.html#stop" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop</span></a>
|
2024-08-12 23:54:43 +00:00
|
|
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="connectionManager" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connection<wbr/>Manager</span><a href="#connectionManager" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">connection<wbr/>Manager</span><span class="tsd-signature-symbol">:</span> <a href="_waku_interfaces.IConnectionManager.html" class="tsd-signature-type tsd-kind-interface">IConnectionManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/5ce36c8f1/packages/interfaces/src/waku.ts#L20">packages/interfaces/src/waku.ts:20</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="filter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>filter</span><a href="#filter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_waku_interfaces.IFilterSDK.html" class="tsd-signature-type tsd-kind-type-alias">IFilterSDK</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/5ce36c8f1/packages/interfaces/src/waku.ts#L17">packages/interfaces/src/waku.ts:17</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="health" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>health</span><a href="#health" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">health</span><span class="tsd-signature-symbol">:</span> <a href="_waku_interfaces.IHealthManager.html" class="tsd-signature-type tsd-kind-interface">IHealthManager</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/5ce36c8f1/packages/interfaces/src/waku.ts#L32">packages/interfaces/src/waku.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="libp2p" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>libp2p</span><a href="#libp2p" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">libp2p</span><span class="tsd-signature-symbol">:</span> <a href="../types/_waku_interfaces.Libp2p.html" class="tsd-signature-type tsd-kind-type-alias">Libp2p</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/5ce36c8f1/packages/interfaces/src/waku.ts#L14">packages/interfaces/src/waku.ts:14</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lightPush" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>light<wbr/>Push</span><a href="#lightPush" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">light<wbr/>Push</span><span class="tsd-signature-symbol">?:</span> <a href="../types/_waku_interfaces.ILightPushSDK.html" class="tsd-signature-type tsd-kind-type-alias">ILightPushSDK</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/waku-org/js-waku/blob/5ce36c8f1/packages/interfaces/src/waku.ts#L18">packages/interfaces/src/waku.ts:18</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="relay" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>relay</sp
|
