2025-11-06 17:00:49 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" data-base = "../" > < head > < meta charset = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > @waku/core - v0.0.40 | 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 > < script async src = "../assets/hierarchy.js" id = "tsd-hierarchy-script" > < / script > < / head > < body > < script > document . documentElement . dataset . theme = localStorage . getItem ( "tsd-theme" ) || "os" ; document . body . style . display = "none" ; setTimeout ( ( ) => window . app ? app . showPage ( ) : document . body . style . removeProperty ( "display" ) , 500 ) < / script > < header class = "tsd-page-toolbar" > < div class = "tsd-toolbar-contents container" > < a href = "../index.html" class = "title" > Documentation< / a > < div id = "tsd-toolbar-links" > < / div > < button id = "tsd-search-trigger" class = "tsd-widget" aria-label = "Search" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-search" > < / use > < / svg > < / button > < dialog id = "tsd-search" aria-label = "Search" > < input role = "combobox" id = "tsd-search-input" aria-controls = "tsd-search-results" aria-autocomplete = "list" aria-expanded = "true" autocapitalize = "off" autocomplete = "off" placeholder = "Search the docs" maxLength = "100" / > < ul role = "listbox" id = "tsd-search-results" > < / ul > < div id = "tsd-search-status" aria-live = "polite" aria-atomic = "true" > < div > Preparing search index...< / div > < / div > < / dialog > < a href = "#" class = "tsd-widget menu" id = "tsd-toolbar-menu-trigger" data-toggle = "menu" aria-label = "Menu" > < svg width = "16" height = "16" viewBox = "0 0 16 16" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-menu" > < / use > < / svg > < / a > < / div > < / header > < div class = "container container-main" > < div class = "col-content" > < div class = "tsd-page-title" > < ul class = "tsd-breadcrumb" aria-label = "Breadcrumb" > < li > < a href = "" aria-current = "page" > @waku/core< / a > < / li > < / ul > < h1 > Module @waku/core - v0.0.40< / 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 >
< 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 >
< h1 id = "wakucore" class = "tsd-anchor-link" > @waku/core< a href = "#wakucore" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / 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 >
< h2 id = "documentation" class = "tsd-anchor-link" > Documentation< a href = "#documentation" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / 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 >
2025-11-06 17:00:49 +00:00
< pre > < code class = "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 >
< / code > < button type = "button" > Copy< / button > < / pre >
< h2 id = "changelog" class = "tsd-anchor-link" > Changelog< a href = "#changelog" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / 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 >
< h2 id = "bugs-questions--features" class = "tsd-anchor-link" > Bugs, Questions & Features< a href = "#bugs-questions--features" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / 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 >
2025-11-06 17:00:49 +00:00
< h2 id = "roadmap" class = "tsd-anchor-link" > Roadmap< a href = "#roadmap" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / 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 >
< h2 id = "contributing" class = "tsd-anchor-link" > Contributing< a href = "#contributing" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / h2 > < p > See < a href = "https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md" > CONTRIBUTING.md< / a > .< / p >
< h2 id = "license" class = "tsd-anchor-link" > License< a href = "#license" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / 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 >
2025-11-06 17:00:49 +00:00
< / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Namespaces" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Namespaces< / h2 > < / summary > < dl class = "tsd-member-summaries" > < dt class = "tsd-member-summary" id = "message" > < span class = "tsd-member-summary-name" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Namespace" > < use href = "../assets/icons.svg#icon-4" > < / use > < / svg > < a href = "_waku_core.message.html" > message< / a > < a href = "#message" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / span > < / dt > < dd class = "tsd-member-summary" > < / dd > < dt class = "tsd-member-summary" id = "waku_filter" > < span class = "tsd-member-summary-name" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Namespace" > < use href = "../assets/icons.svg#icon-4" > < / use > < / svg > < a href = "_waku_core.waku_filter.html" > waku_filter< / a > < a href = "#waku_filter" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / span > < / dt > < dd class = "tsd-member-summary" > < / dd > < dt class = "tsd-member-summary" id = "waku_light_push" > < span class = "tsd-member-summary-name" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Namespace" > < use href = "../assets/icons.svg#icon-4" > < / use > < / svg > < a href = "_waku_core.waku_light_push.html" > waku_light_push< / a > < a href = "#waku_light_push" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / span > < / dt > < dd class = "tsd-member-summary" > < / dd > < dt class = "tsd-member-summary" id = "waku_store" > < span class = "tsd-member-summary-name" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Namespace" > < use href = "../assets/icons.svg#icon-4" > < / use > < / svg > < a href = "_waku_core.waku_store.html" > waku_store< / a > < a href = "#waku_store" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / span > < / dt > < dd class = "tsd-member-summary" > < / dd > < / dl > < / details > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Classes" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h2 > Classes< / h2 > < / summary > < dl class = "tsd-member-summaries" > < dt class = "tsd-member-summary" id = "connectionmanager" > < span class = "tsd-member-summary-name" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Class" > < use href = "../assets/icons.svg#icon-128" > < / use > < / svg > < a href = "../classes/_waku_core.ConnectionManager.html" > ConnectionManager< / a > < a href = "#connectionmanager" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / span > < / dt > < dd class = "tsd-member-summary" > < / dd > < dt class = "tsd-member-summary" id = "decodedmessage" > < span class = "tsd-member-summary-name" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Class" > < use href = "../assets/icons.svg#icon-128" > < / use > < / svg > < a href = "../classes/_waku_core.DecodedMessage.html" > DecodedMessage< / a > < a href = "#decodedmessage" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / span > < / dt > < dd class = "tsd-member-summary" > < / dd > < dt class = "tsd-member-summary" id = "decoder" > < span class = "tsd-member-summary-name" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Class" > < use href = "../assets/icons.svg#icon-128" > < / use > < / svg > < a href = "../classes/_waku_core.Decoder.html" > Decoder< / a > < a href = "#decoder" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-anchor" > < / use > < / svg > < / a > < / span > < / dt > < dd class = "tsd-
