2023-11-28 15:58:49 +00:00
<!DOCTYPE html> < html class = "default" lang = "en" > < head > < meta charSet = "utf-8" / > < meta http-equiv = "x-ua-compatible" content = "IE=edge" / > < title > IMessage | 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/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" < / 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 = "#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 = "#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.IMessage.html" > IMessage< / a > < / li > < / ul > < h1 > Interface IMessage< / h1 > < / div > < section class = "tsd-panel tsd-comment" > < div class = "tsd-comment tsd-typography" > < p > Interface for messages to encode and send.< / p >
2024-04-04 13:44:40 +00:00
< / div > < div class = "tsd-comment tsd-typography" > < / div > < / section > < div class = "tsd-signature" > < span class = "tsd-signature-keyword" > interface < / span > < span class = "tsd-kind-interface" > IMessage< / span > < span class = "tsd-signature-symbol" > { < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "_waku_interfaces.IMessage.html#payload" > payload< / a > < span class = "tsd-signature-symbol" > : < / span > < span class = "tsd-signature-type" > Uint8Array< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "_waku_interfaces.IMessage.html#rateLimitProof" > rateLimitProof< / a > < span class = "tsd-signature-symbol" > ?: < / span > < a href = "_waku_interfaces.IRateLimitProof.html" class = "tsd-signature-type tsd-kind-interface" > IRateLimitProof< / a > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span > < / span > < a class = "tsd-kind-property" href = "_waku_interfaces.IMessage.html#timestamp" > timestamp< / a > < span class = "tsd-signature-symbol" > ?: < / span > < span class = "tsd-signature-type" > Date< / span > < span class = "tsd-signature-symbol" > ; < / span > < br / > < span class = "tsd-signature-symbol" > }< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/0b54d2e3d/packages/interfaces/src/message.ts#L38" > packages/interfaces/src/message.ts:38< / a > < / 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 = "#icon-chevronSmall" > < / use > < / svg > Index< / h5 > < / summary > < div class = "tsd-accordion-details" > < section class = "tsd-index-section" > < h3 class = "tsd-index-heading" > Properties< / h3 > < div class = "tsd-index-list" > < a href = "_waku_interfaces.IMessage.html#payload" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > payload< / span > < / a >
2023-09-21 08:59:21 +00:00
< a href = "_waku_interfaces.IMessage.html#rateLimitProof" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > rate< wbr / > Limit< wbr / > Proof?< / span > < / a >
< a href = "_waku_interfaces.IMessage.html#timestamp" class = "tsd-index-link" > < svg class = "tsd-kind-icon" viewBox = "0 0 24 24" > < use href = "#icon-1024" > < / use > < / svg > < span > timestamp?< / span > < / a >
2024-04-04 13:44:40 +00:00
< / 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 = "payload" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < span > payload< / span > < a href = "#payload" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > payload< / span > < span class = "tsd-signature-symbol" > :< / span > < span class = "tsd-signature-type" > Uint8Array< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/0b54d2e3d/packages/interfaces/src/message.ts#L39" > packages/interfaces/src/message.ts:39< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "rateLimitProof" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span > rate< wbr / > Limit< wbr / > Proof< / span > < a href = "#rateLimitProof" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > rate< wbr / > Limit< wbr / > Proof< / span > < span class = "tsd-signature-symbol" > ?:< / span > < a href = "_waku_interfaces.IRateLimitProof.html" class = "tsd-signature-type tsd-kind-interface" > IRateLimitProof< / a > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/0b54d2e3d/packages/interfaces/src/message.ts#L41" > packages/interfaces/src/message.ts:41< / a > < / li > < / ul > < / aside > < / section > < section class = "tsd-panel tsd-member" > < a id = "timestamp" class = "tsd-anchor" > < / a > < h3 class = "tsd-anchor-link" > < code class = "tsd-tag ts-flagOptional" > Optional< / code > < span > timestamp< / span > < a href = "#timestamp" aria-label = "Permalink" class = "tsd-anchor-icon" > < svg viewBox = "0 0 24 24" > < use href = "#icon-anchor" > < / use > < / svg > < / a > < / h3 > < div class = "tsd-signature" > < span class = "tsd-kind-property" > timestamp< / span > < span class = "tsd-signature-symbol" > ?:< / span > < span class = "tsd-signature-type" > Date< / span > < / div > < aside class = "tsd-sources" > < ul > < li > Defined in < a href = "https://github.com/waku-org/js-waku/blob/0b54d2e3d/packages/interfaces/src/message.ts#L40" > packages/interfaces/src/message.ts:40< / 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 = "#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 . 8214