2025-04-18 18:12:32 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" >< head >< meta charSet = "utf-8" />< meta http-equiv = "x-ua-compatible" content = "IE=edge" />< title > EncoderOptions | 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.EncoderOptions.html" > EncoderOptions</ a ></ li ></ ul >< h1 > Interface EncoderOptions</ h1 ></ div >< div class = "tsd-signature" >< span class = "tsd-signature-keyword" > interface </ span >< span class = "tsd-kind-interface" > EncoderOptions</ span > < span class = "tsd-signature-symbol" > { </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.EncoderOptions.html#contentTopic" > contentTopic</ a >< span class = "tsd-signature-symbol" > : </ span >< span class = "tsd-signature-type" > string</ span >< span class = "tsd-signature-symbol" > ; </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.EncoderOptions.html#ephemeral" > ephemeral</ a >< span class = "tsd-signature-symbol" > ?: </ span >< span class = "tsd-signature-type" > boolean</ span >< span class = "tsd-signature-symbol" > ; </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.EncoderOptions.html#metaSetter" > metaSetter</ a >< span class = "tsd-signature-symbol" > ?: </ span >< a href = "_waku_interfaces.IMetaSetter.html" class = "tsd-signature-type tsd-kind-interface" > IMetaSetter</ a >< span class = "tsd-signature-symbol" > ; </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.EncoderOptions.html#pubsubTopic" > pubsubTopic</ a >< span class = "tsd-signature-symbol" > ?: </ span >< span class = "tsd-signature-type" > string</ span >< span class = "tsd-signature-symbol" > ; </ span >< br />< span > </ span >< a class = "tsd-kind-property" href = "_waku_interfaces.EncoderOptions.html#pubsubTopicShardInfo" > pubsubTopicShardInfo</ a >< span class = "tsd-signature-symbol" > ?: </ span >< a href = "_waku_interfaces.SingleShardInfo.html" class = "tsd-signature-type tsd-kind-interface" > SingleShardInfo</ a >< span class = "tsd-signature-symbol" > ; </ span >< br />< span class = "tsd-signature-symbol" > }</ span ></ div >< section class = "tsd-panel tsd-hierarchy" >< h4 > Hierarchy</ h4 >< ul class = "tsd-hierarchy" >< li >< span class = "target" > EncoderOptions</ span >< ul class = "tsd-hierarchy" ></ ul ></ li ></ ul >
2024-04-07 07:56:46 +00:00
< a href = "_waku_interfaces.EncoderOptions.html#ephemeral" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "../assets/icons.svg#icon-1024" ></ use ></ svg >< span > ephemeral?</ span ></ a >
< a href = "_waku_interfaces.EncoderOptions.html#metaSetter" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "../assets/icons.svg#icon-1024" ></ use ></ svg >< span > meta< wbr /> Setter?</ span ></ a >
< a href = "_waku_interfaces.EncoderOptions.html#pubsubTopic" class = "tsd-index-link deprecated" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "../assets/icons.svg#icon-1024" ></ use ></ svg >< span > pubsub< wbr /> Topic?</ span ></ a >
< a href = "_waku_interfaces.EncoderOptions.html#pubsubTopicShardInfo" class = "tsd-index-link" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "../assets/icons.svg#icon-1024" ></ use ></ svg >< span > pubsub< wbr /> Topic< wbr /> Shard< wbr /> Info?</ span ></ a >
</ 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 = "contentTopic" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< span > content< wbr /> Topic</ span >< a href = "#contentTopic" 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" > content< wbr /> Topic</ span >< span class = "tsd-signature-symbol" > :</ span > < span class = "tsd-signature-type" > string</ span ></ div >< div class = "tsd-comment tsd-typography" >< p > The content topic to set on outgoing messages.</ p >
2025-04-18 18:12:32 +00:00
</ div >< div class = "tsd-comment tsd-typography" ></ div >< aside class = "tsd-sources" >< ul >< li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/551238006c82547394f49fb842c27a91aa1b89d1/packages/interfaces/src/message.ts#L55" > packages/interfaces/src/message.ts:55</ a ></ li ></ ul ></ aside ></ section >< section class = "tsd-panel tsd-member" >< a id = "ephemeral" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< code class = "tsd-tag ts-flagOptional" > Optional</ code > < span > ephemeral</ span >< a href = "#ephemeral" 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" > ephemeral</ span >< span class = "tsd-signature-symbol" > ?:</ span > < span class = "tsd-signature-type" > boolean</ span ></ div >< div class = "tsd-comment tsd-typography" >< p > An optional flag to mark message as ephemeral, i.e., not to be stored by Waku Store nodes.</ p >
2023-11-28 15:58:49 +00:00
</ div >< div class = "tsd-comment tsd-typography" >< h4 > Default Value</ h4 >< p >< code > false</ code ></ p >
2025-04-18 18:12:32 +00:00
</ div >< aside class = "tsd-sources" >< ul >< li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/551238006c82547394f49fb842c27a91aa1b89d1/packages/interfaces/src/message.ts#L60" > packages/interfaces/src/message.ts:60</ a ></ li ></ ul ></ aside ></ section >< section class = "tsd-panel tsd-member" >< a id = "metaSetter" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< code class = "tsd-tag ts-flagOptional" > Optional</ code > < span > meta< wbr /> Setter</ span >< a href = "#metaSetter" 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" > meta< wbr /> Setter</ span >< span class = "tsd-signature-symbol" > ?:</ span > < a href = "_waku_interfaces.IMetaSetter.html" class = "tsd-signature-type tsd-kind-interface" > IMetaSetter</ a ></ div >< div class = "tsd-comment tsd-typography" >< p > A function called when encoding messages to set the meta field.</ p >
2023-11-28 15:58:49 +00:00
</ div >< div class = "tsd-comment tsd-typography" >< h4 > Param: IProtoMessage</ h4 >< p > The message encoded for wire, without the meta field.
2023-03-14 00:27:58 +00:00
If encryption is used, < code > metaSetter</ code > only accesses < em > encrypted</ em > payload.</ p >
2025-04-18 18:12:32 +00:00
</ div >< aside class = "tsd-sources" >< ul >< li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/551238006c82547394f49fb842c27a91aa1b89d1/packages/interfaces/src/message.ts#L66" > packages/interfaces/src/message.ts:66</ a ></ li ></ ul ></ aside ></ section >< section class = "tsd-panel tsd-member" >< a id = "pubsubTopic" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< code class = "tsd-tag ts-flagOptional" > Optional</ code > < span class = "deprecated" > pubsub< wbr /> Topic</ span >< a href = "#pubsubTopic" 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" > pubsub< wbr /> Topic</ span >< span class = "tsd-signature-symbol" > ?:</ span > < span class = "tsd-signature-type" > string</ span ></ div >< div class = "tsd-comment tsd-typography" >< h4 > Deprecated</ h4 ></ div >< aside class = "tsd-sources" >< ul >< li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/551238006c82547394f49fb842c27a91aa1b89d1/packages/interfaces/src/message.ts#L52" > packages/interfaces/src/message.ts:52</ a ></ li ></ ul ></ aside ></ section >< section class = "tsd-panel tsd-member" >< a id = "pubsubTopicShardInfo" class = "tsd-anchor" ></ a >< h3 class = "tsd-anchor-link" >< code class = "tsd-tag ts-flagOptional" > Optional</ code > < span > pubsub< wbr /> Topic< wbr /> Shard< wbr /> Info</ span >< a href = "#pubsubTopicShardInfo" 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" > pubsub< wbr /> Topic< wbr /> Shard< wbr /> Info</ span >< span class = "tsd-signature-symbol" > ?:</ span > < a href = "_waku_interfaces.SingleShardInfo.html" class = "tsd-signature-type tsd-kind-interface" > SingleShardInfo</ a ></ div >< aside class = "tsd-sources" >< ul >< li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/551238006c82547394f49fb842c27a91aa1b89d1/packages/interfaces/src/message.ts#L53" > packages/interfaces/src/message.ts:53</ a ></ li ></ ul ></ aside ></ 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
