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 > createEncoder | 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_core.html" > @waku/core</ a ></ li >< li >< a href = "_waku_core.createEncoder.html" > createEncoder</ a ></ li ></ ul >< h1 > Function createEncoder</ h1 ></ div >< section class = "tsd-panel" >< ul class = "tsd-signatures" >< li class = "tsd-signature tsd-anchor-link" >< a id = "createEncoder" class = "tsd-anchor" ></ a >< span class = "tsd-kind-call-signature" > create< wbr /> Encoder</ span >< span class = "tsd-signature-symbol" > (</ span >< span class = "tsd-kind-parameter" > __namedParameters</ span >< span class = "tsd-signature-symbol" > )</ span >< span class = "tsd-signature-symbol" > : </ span >< a href = "../classes/_waku_core.Encoder.html" class = "tsd-signature-type tsd-kind-class" > Encoder</ a >< a href = "#createEncoder" aria-label = "Permalink" class = "tsd-anchor-icon" >< svg viewBox = "0 0 24 24" >< use href = "#icon-anchor" ></ use ></ svg ></ a ></ li >< li class = "tsd-description" >< div class = "tsd-comment tsd-typography" >< p > Creates an encoder that encode messages without Waku level encryption or signature.</ p >
2023-09-21 08:59:21 +00:00
< p > An encoder is used to encode messages in the < a href = "https://rfc.vac.dev/spec/14/" > 14/WAKU2-MESSAGE</ a >
2022-12-06 00:06:29 +00:00
format to be sent over the Waku network. The resulting encoder can then be
2023-09-21 08:59:21 +00:00
pass to < a href = "../interfaces/_waku_interfaces.ISender.html#send" class = "tsd-kind-property" > @waku/interfaces!ISender.send</ a > to automatically encode outgoing
2022-12-06 00:06:29 +00:00
messages.</ p >
2024-02-05 21:59:03 +00:00
</ div >< div class = "tsd-parameters" >< h4 class = "tsd-parameters-title" > Parameters</ h4 >< ul class = "tsd-parameter-list" >< li >< h5 >< span class = "tsd-kind-parameter" > __namedParameters</ span > : < a href = "../interfaces/_waku_interfaces.EncoderOptions.html" class = "tsd-signature-type tsd-kind-interface" > EncoderOptions</ a ></ h5 ></ li ></ ul ></ div >< h4 class = "tsd-returns-title" > Returns < a href = "../classes/_waku_core.Encoder.html" class = "tsd-signature-type tsd-kind-class" > Encoder</ a ></ h4 >< 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/749d84d5e/packages/core/src/lib/message/version_0.ts#L120" > packages/core/src/lib/message/version_0.ts:120</ a ></ li ></ ul ></ aside ></ li ></ ul ></ 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.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 value = "os" > OS</ option >< option value = "light" > Light</ option >< option value = "dark" > Dark</ option ></ select ></ div ></ div ></ details ></ div ></ div >< div class = "site-menu" >< nav class = "tsd-navigation" >< a href = "../index.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-1" ></ use ></ svg >< span > Documentation</ span ></ a >< ul class = "tsd-small-nested-navigation" id = "tsd-nav-container" data-base = ".." >< details class = "tsd-index-accordion" data-key = "@waku" >< summary class = "tsd-accordion-summary" >< svg width = "20" height = "20" viewBox = "0 0 24 24" fill = "none" >< use href = "#icon-chevronDown" ></ use ></ svg >< span > @waku</ span ></ summary >< div class = "tsd-accordion-details" >< ul class = "tsd-nested-navigation" >< li >< a href = "../modules/_waku_interfaces.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2" ></ use ></ svg > interfaces</ a ></ li >< li >< a href = "../modules/_waku_utils.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2" ></ use ></ svg > utils</ a ></ li >< li >< a href = "../modules/_waku_message_hash.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2" ></ use ></ svg > message-hash</ a ></ li >< li >< a href = "../modules/_waku_proto.html" >< svg class = "tsd-kind-icon" viewBox = "0 0 24 24" >< use href = "#icon-2" ></ use ></ svg > proto</ a ></ li >< li >< a href = "../modules/_waku_enr.html" > <
