2024-08-29 09:50:18 +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/core - v0.0.31 | 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_core.html" > @waku/core< / a > < / li > < / ul > < h1 > Module @waku/core - v0.0.31< / h1 > < / div > < section class = "tsd-panel tsd-typography" > < p > < a href = "https://npmjs.org/package/@waku/core" > < img src = "https://nodei.co/npm/@waku/core.png" alt = "NPM" > < / a > < / p >
2023-03-20 05:13:47 +00:00
< p > < a href = "https://discord.gg/Nrac59MfSX" > < img src = "https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA" alt = "Discord chat" > < / a > < / p >
2023-09-21 08:59:21 +00:00
< a id = "md:wakucore" class = "tsd-anchor" > < / a > < h1 > < a href = "#md:wakucore" > @waku/core< / a > < / h1 > < p > Core components of js-waku, a TypeScript implementation of the < a href = "https://rfc.vac.dev/spec/10/" > Waku v2 protocol< / a > .< / p >
< a id = "md:documentation" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:documentation" > Documentation< / a > < / h2 > < ul >
2022-12-06 00:06:29 +00:00
< li > < a href = "https://docs.wakuconnect.dev/docs/quick_start/" > Quick start< / a > < / li >
< li > < a href = "https://docs.wakuconnect.dev/" > Full documentation< / a > < / li >
< li > < a href = "https://js.waku.org/" > API documentation (< code > master< / code > branch)< / a > < / li >
< li > < a href = "https://wakuconnect.dev/" > Waku Connect< / a > < / li >
< li > < a href = "https://wakunetwork.com/" > Waku< / a > < / li >
< li > < a href = "https://vac.dev/" > Vac< / a > < / li >
< / ul >
< p > API Documentation can also be generated locally:< / p >
2023-05-17 06:12:41 +00:00
< pre > < code class = "language-shell" > < span class = "hl-0" > git< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > clone< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > https://github.com/waku-org/js-waku.git< / span > < br / > < span class = "hl-0" > cd< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > js-waku< / span > < br / > < span class = "hl-0" > npm< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > install< / span > < br / > < span class = "hl-0" > npm< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > run< / span > < span class = "hl-1" > < / span > < span class = "hl-2" > doc< / span >
2023-09-21 08:59:21 +00:00
< / code > < button > Copy< / button > < / pre >
< a id = "md:changelog" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:changelog" > Changelog< / a > < / h2 > < p > Release changelog can be found in < a href = "https://github.com/waku-org/js-waku/blob/master/packages/core/CHANGELOG.md" > CHANGELOG.md< / a > .< / p >
< a id = "md:bugs-questions-amp-features" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:bugs-questions-amp-features" > Bugs, Questions & Features< / a > < / h2 > < p > If you encounter any bug or would like to propose new features, feel free to < a href = "https://github.com/waku-org/js-waku/issues/new/" > open an issue< / a > .< / p >
2023-03-20 05:13:47 +00:00
< p > For general discussion, get help or latest news, join < strong > #js-waku< / strong > on < a href = "https://discord.gg/Nrac59MfSX" > Vac Discord< / a > or the < a href = "https://t.me/waku_org" > Waku Telegram Group< / a > .< / p >
2023-09-21 08:59:21 +00:00
< a id = "md:roadmap" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:roadmap" > Roadmap< / a > < / h2 > < p > You can track progress on the < a href = "https://github.com/orgs/waku-org/projects/2/views/1" > project board< / a > .< / p >
< a id = "md:contributing" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:contributing" > Contributing< / a > < / h2 > < p > See < a href = "https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md" > CONTRIBUTING.md< / a > .< / p >
< a id = "md:license" class = "tsd-anchor" > < / a > < h2 > < a href = "#md:license" > License< / a > < / h2 > < p > Licensed and distributed under either of< / p >
2022-12-06 00:06:29 +00:00
< ul >
< li > MIT license: < a href = "https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT" > LICENSE-MIT< / a > or < a href = "http://opensource.org/licenses/MIT" > http://opensource.org/licenses/MIT< / a > < / li >
< / ul >
< p > or< / p >
< ul >
< li > Apache License, Version 2.0, (< a href = "https://github.com/waku-org/js-waku/blob/master/LICENSE-APACHE-v2" > LICENSE-APACHE-v2< / a > or < a href = "http://www.apache.org/licenses/LICENSE-2.0" > http://www.apache.org/licenses/LICENSE-2.0< / a > )< / li >
< / ul >
< p > at your option. These files may not be copied, modified, or distributed except according to those terms.< / p >
2024-04-07 07:56:46 +00:00
< / section > < 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_core.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 >
2024-04-19 11:52:00 +00:00
< a href = "_waku_core.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 >
2024-04-07 07:56:46 +00:00
< a href = "_waku_core.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_core.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_core.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 >
< / div > < / section > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Namespaces< / h3 > < div class = "tsd-index-list" > < a href = "_waku_core.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_core.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_core.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_core.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_core.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_core.DecodedMessage.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 > Decoded< wbr / > Message< / span > < / a >
< a href = "../classes/_waku_core.Decoder.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 > Decoder< / span > < / a >
< a href = "../classes/_waku_core.Encoder.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 > Encoder< / span > < / a >
< a href = "../classes/_waku_core.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_core.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_core.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_core.createDecoder.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 > create< wbr / > Decoder< / span > < / a >
< a href = "../functions/_waku_core.createEncoder.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 > create< wbr / > Encoder< / span > < / a >
2024-07-27 12:59:11 +00:00
< a href = "../functions/_waku_core.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 >
2024-04-07 07:56:46 +00:00
< a href = "../functions/_waku_core.waitForRemotePeer.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 > wait< wbr / > For< wbr / > Remote< wbr / > Peer< / span > < / a >
< a href = "../functions/_waku_core.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 >
2024-08-13 22:54:21 +00:00
< / 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 = "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_core.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_core.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_core.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_core.waku_light_push.LightPushCore.html" > LightPushCore< / 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_core.waku_store.StoreCore.html" > StoreCore< / 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 > < /labe
