mirror of https://github.com/waku-org/js-waku.git
22 lines
17 KiB
HTML
22 lines
17 KiB
HTML
<!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="_waku_sdk.html">@waku/sdk</a></li><li><a href="_waku_sdk.waku.html">waku</a></li></ul><h1>Namespace waku</h1></div><aside class="tsd-sources"><ul><li>Defined in packages/core/dist/index.d.ts:1</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="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">References</h3><div class="tsd-index-list"><a href="_waku_sdk.waku.html#DecodedMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Decoded<wbr/>Message</span></a>
|
|
<a href="_waku_sdk.waku.html#Decoder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Decoder</span></a>
|
|
<a href="_waku_sdk.waku.html#Encoder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Encoder</span></a>
|
|
<a href="_waku_sdk.waku.html#FilterCodecs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Filter<wbr/>Codecs</span></a>
|
|
<a href="_waku_sdk.waku.html#FilterCore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Filter<wbr/>Core</span></a>
|
|
<a href="_waku_sdk.waku.html#LightPushCodec" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Light<wbr/>Push<wbr/>Codec</span></a>
|
|
<a href="_waku_sdk.waku.html#LightPushCore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Light<wbr/>Push<wbr/>Core</span></a>
|
|
<a href="_waku_sdk.waku.html#StoreCodec" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Store<wbr/>Codec</span></a>
|
|
<a href="_waku_sdk.waku.html#StoreCore" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Store<wbr/>Core</span></a>
|
|
<a href="_waku_sdk.waku.html#createDecoder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>create<wbr/>Decoder</span></a>
|
|
<a href="_waku_sdk.waku.html#createEncoder" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>create<wbr/>Encoder</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Namespaces</h3><div class="tsd-index-list"><a href="_waku_sdk.waku.message.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4"></use></svg><span>message</span></a>
|
|
<a href="_waku_sdk.waku.waku_filter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4"></use></svg><span>waku_<wbr/>filter</span></a>
|
|
<a href="_waku_sdk.waku.waku_light_push.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4"></use></svg><span>waku_<wbr/>light_<wbr/>push</span></a>
|
|
<a href="_waku_sdk.waku.waku_store.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4"></use></svg><span>waku_<wbr/>store</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="../classes/_waku_sdk.waku.ConnectionManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Connection<wbr/>Manager</span></a>
|
|
<a href="../classes/_waku_sdk.waku.KeepAliveManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Keep<wbr/>Alive<wbr/>Manager</span></a>
|
|
<a href="../classes/_waku_sdk.waku.StreamManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-128"></use></svg><span>Stream<wbr/>Manager</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Variables</h3><div class="tsd-index-list"><a href="../variables/_waku_sdk.waku.MetadataCodec.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-32"></use></svg><span>Metadata<wbr/>Codec</span></a>
|
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Functions</h3><div class="tsd-index-list"><a href="../functions/_waku_sdk.waku.getHealthManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>get<wbr/>Health<wbr/>Manager</span></a>
|
|
<a href="../functions/_waku_sdk.waku.wakuMetadata.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-64"></use></svg><span>waku<wbr/>Metadata</span></a>
|
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>References</h2><section class="tsd-panel tsd-member"><a id="DecodedMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Decoded<wbr/>Message</span><a href="#DecodedMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/_waku_sdk.DecodedMessage.html">DecodedMessage</a></section><section class="tsd-panel tsd-member"><a id="Decoder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Decoder</span><a href="#Decoder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/_waku_sdk.Decoder.html">Decoder</a></section><section class="tsd-panel tsd-member"><a id="Encoder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Encoder</span><a href="#Encoder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/_waku_sdk.Encoder.html">Encoder</a></section><section class="tsd-panel tsd-member"><a id="FilterCodecs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Filter<wbr/>Codecs</span><a href="#FilterCodecs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/_waku_sdk.waku.waku_filter.FilterCodecs.html">FilterCodecs</a></section><section class="tsd-panel tsd-member"><a id="FilterCore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Filter<wbr/>Core</span><a href="#FilterCore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/_waku_sdk.waku.waku_filter.FilterCore.html">FilterCore</a></section><section class="tsd-panel tsd-member"><a id="LightPushCodec" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Light<wbr/>Push<wbr/>Codec</span><a href="#LightPushCodec" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/_waku_sdk.waku.waku_light_push.LightPushCodec.html">LightPushCodec</a></section><section class="tsd-panel tsd-member"><a id="LightPushCore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Light<wbr/>Push<wbr/>Core</span><a href="#LightPushCore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/_waku_sdk.waku.waku_light_push.LightPushCore.html">LightPushCore</a></section><section class="tsd-panel tsd-member"><a id="StoreCodec" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Store<wbr/>Codec</span><a href="#StoreCodec" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../variables/_waku_sdk.waku.waku_store.StoreCodec.html">StoreCodec</a></section><section class="tsd-panel tsd-member"><a id="StoreCore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Store<wbr/>Core</span><a href="#StoreCore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../classes/_waku_sdk.waku.waku_store.StoreCore.html">StoreCore</a></section><section class="tsd-panel tsd-member"><a id="createDecoder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Decoder</span><a href="#createDecoder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../functions/_waku_sdk.createDecoder.html">createDecoder</a></section><section class="tsd-panel tsd-member"><a id="createEncoder" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Encoder</span><a href="#createEncoder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>Re-exports <a href="../functions/_waku_sdk.createEncoder.html">createEncoder</a></section></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><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DecodedMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Decoded<wbr/>Message</span></a><a href="#Decoder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Decoder</span></a><a href="#Encoder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Encoder</span></a><a href="#FilterCodecs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Filter<wbr/>Codecs</span></a><a href="#FilterCore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Filter<wbr/>Core</span></a><a href="#LightPushCodec" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Light<wbr/>Push<wbr/>Codec</span></a><a href="#LightPushCore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Light<wbr/>Push<wbr/>Core</span></a><a href="#StoreCodec" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Store<wbr/>Codec</span></a><a href="#StoreCore" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>Store<wbr/>Core</span></a><a href="#createDecoder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>create<wbr/>Decoder</span></a><a href="#createEncoder" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-4194304"></use></svg><span>create<wbr/>Encoder</span></a></div></details></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> |