2025-11-15 22:00:20 +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 > 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 > < 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 = "../modules/_waku_interfaces.html" > @waku/interfaces< / a > < / li > < li > < a href = "" aria-current = "page" > 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 / > < a class = "tsd-kind-property" href = "#contenttopic" > contentTopic< / a > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > string< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "#ephemeral" > ephemeral< / a > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > boolean< / span > < span class = "tsd-signature-symbol" > ;< / span > < br / > < a class = "tsd-kind-property" href = "#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 / > < a class = "tsd-kind-property" href = "#routinginfo" > routingInfo< / a > < span class = "tsd-signature-symbol" > :< / span > < a href = "_waku_interfaces.IRoutingInfo.html" class = "tsd-signature-type tsd-kind-interface" > IRoutingInfo< / a > < span class = "tsd-signature-symbol" > ;< / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < section class = "tsd-panel tsd-hierarchy" data-refl = "6402" > < h4 > Hierarchy (< a href = "../hierarchy.html#@waku/interfaces.EncoderOptions" > View Summary< / a > )< / h4 > < ul class = "tsd-hierarchy" > < li class = "tsd-hierarchy-item" > < span class = "tsd-hierarchy-target" > EncoderOptions< / span > < ul class = "tsd-hierarchy" > < li class = "tsd-hierarchy-item" > < a href = "../modules/_waku_message-encryption.ecies.html" class = "tsd-signature-type tsd-kind-namespace" > ecies< / a > < span class = "tsd-signature-symbol" > .< / span > < a href = "_waku_message-encryption.e
2025-11-06 17:00:49 +00:00
< a href = "#ephemeral" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > ephemeral?< / span > < / a >
< a href = "#metasetter" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > meta< wbr / > Setter?< / span > < / a >
< a href = "#routinginfo" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > routing< wbr / > Info< / span > < / a >
< / div > < / section > < / div > < / details > < / section > < / section > < details class = "tsd-panel-group tsd-member-group tsd-accordion" open > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < 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 > Properties< / h2 > < / summary > < section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "contenttopic" > < span > content< wbr / > Topic< / span > < a href = "#contenttopic" 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 > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > contentTopic< / 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-11-15 22:00:20 +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/e5f51d7df101020a1a6d0787ce68fab4f28922f5/packages/interfaces/src/message.ts#L82" > packages/interfaces/src/message.ts:82< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "ephemeral" > < code class = "tsd-tag" > Optional< / code > < span > ephemeral< / span > < a href = "#ephemeral" 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 > < / 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 >
2025-11-06 17:00:49 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < div class = "tsd-tag-defaultValue" > < h4 class = "tsd-anchor-link" id = "default-value" > Default Value< a href = "#default-value" 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 > < / h4 > < p > < code > false< / code > < / p >
2025-11-15 22:00:20 +00:00
< / div > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/e5f51d7df101020a1a6d0787ce68fab4f28922f5/packages/interfaces/src/message.ts#L87" > packages/interfaces/src/message.ts:87< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "metasetter" > < code class = "tsd-tag" > Optional< / code > < span > meta< wbr / > Setter< / span > < a href = "#metasetter" 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 > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > metaSetter< / 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 >
2025-11-06 17:00:49 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < div class = "tsd-tag-param" > < h4 class = "tsd-anchor-link" id = "param-iprotomessage" > Param: IProtoMessage< a href = "#param-iprotomessage" 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 > < / 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-11-15 22:00:20 +00:00
< / div > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/e5f51d7df101020a1a6d0787ce68fab4f28922f5/packages/interfaces/src/message.ts#L93" > packages/interfaces/src/message.ts:93< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < h3 class = "tsd-anchor-link" id = "routinginfo" > < span > routing< wbr / > Info< / span > < a href = "#routinginfo" 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 > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > routingInfo< / span > < span class = "tsd-signature-symbol" > :< / span > < a href = "_waku_interfaces.IRoutingInfo.html" class = "tsd-signature-type tsd-kind-interface" > IRoutingInfo< / a > < / div > < div class = "tsd-comment tsd-typography" > < p > The routing information for the message (cluster id, shard id, pubsubTopic)< / p >
< / 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/e5f51d7df101020a1a6d0787ce68fab4f28922f5/packages/interfaces/src/message.ts#L80" > packages/interfaces/src/message.ts:80< / a > < / li > < / ul > < / aside > < / section > < / section > < / details > < / div > < div class = "col-sidebar" > < div class = "page-menu" > < div class = "tsd-navigation settings" > < details class = "tsd-accordion" > < summary class = "tsd-accordion-summary" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h3 > Settings< / h3 > < / summary > < div class = "tsd-accordion-details" > < div class = "tsd-filter-visibility" > < span class = "settings-label" > Member Visibility< / span > < 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-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 > < / div > < div class = "tsd-theme-toggle" > < label class = "settings-label" for = "tsd-theme" > Theme< / label > < 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-accordion tsd-page-navigation" > < summary class = "tsd-accordion-summary" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > < h3 > On This Page< / h3 > < / summary > < div class = "tsd-accordion-details" > < details open class = "tsd-accordion tsd-page-navigation-section" > < summary class = "tsd-accordion-summary" data-key = "section-Properties" > < svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" aria-hidden = "true" > < use href = "../assets/icons.svg#icon-chevronDown" > < / use > < / svg > Properties< / summary > < div > < a href = "#contenttopic" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > content< wbr / > Topic< / span > < / a > < a href = "#ephemeral" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > ephemeral< / span > < / a > < a href = "#metasetter" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > meta< wbr / > Setter< / span > < / a > < a href = "#routinginfo" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" aria-label = "Property" > < use href = "../assets/icons.svg#icon-1024" > < / use > < / svg > < span > routing< wbr / > Info< / span > < / a > < / div > < / details > < / div > < / details > < / div > < div class = "site-menu" > < nav class = "tsd-navigation" > < a href = "../modules.html" > Documentation< / a > < ul class = "tsd-small-nested-navigation" id = "tsd-nav-container" > < 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 >
