logos-messaging/js-waku
1
0
Fork 0
mirror of https://github.com/logos-messaging/js-waku.git synced 2026-08-25 07:01:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates

Browse Source
This commit is contained in:
status-im-auto
2023-03-07 23:00:50 +00:00
committed by Jenkins
parent 6506eb32c3
commit 6bbbcb91a7
306 changed files with 895 additions and 884 deletions
Download Patch File Download Diff File Expand all files Collapse all files
functions/_waku_core.createEncoder.html
+5 -3
View File
@@ -18,7 +18,7 @@
<h1>Function createEncoder</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-anchor-link" id="createEncoder">create<wbr/>Encoder<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/_waku_core._internal_.EncoderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncoderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../modules/_waku_core.message.html" class="tsd-signature-type" data-tsd-kind="Namespace">message</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_core.message.version_0.html" class="tsd-signature-type" data-tsd-kind="Namespace">version_0</a><span class="tsd-signature-symbol">.</span><a href="../classes/_waku_core.message.version_0.Encoder.html" class="tsd-signature-type" data-tsd-kind="Class">Encoder</a><a href="#createEncoder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></li>
<li class="tsd-signature tsd-anchor-link" id="createEncoder">create<wbr/>Encoder<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/_waku_core._internal_.EncoderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncoderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/_waku_core.Encoder.html" class="tsd-signature-type" data-tsd-kind="Class">Encoder</a><a href="#createEncoder" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></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>
<p>An encoder is used to encode messages in the [`14/WAKU2-MESSAGE](<a href="https://rfc.vac.dev/spec/14/">https://rfc.vac.dev/spec/14/</a>)
@@ -32,9 +32,9 @@ messages.</p>
<ul class="tsd-parameter-list">
<li>
<h5>__namedParameters: <a href="../interfaces/_waku_core._internal_.EncoderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">EncoderOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../modules/_waku_core.message.html" class="tsd-signature-type" data-tsd-kind="Namespace">message</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_core.message.version_0.html" class="tsd-signature-type" data-tsd-kind="Namespace">version_0</a><span class="tsd-signature-symbol">.</span><a href="../classes/_waku_core.message.version_0.Encoder.html" class="tsd-signature-type" data-tsd-kind="Class">Encoder</a></h4><aside class="tsd-sources">
<h4 class="tsd-returns-title">Returns <a href="../classes/_waku_core.Encoder.html" class="tsd-signature-type" data-tsd-kind="Class">Encoder</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/waku-org/js-waku/blob/abe1e204/packages/core/src/lib/message/version_0.ts#L94">packages/core/src/lib/message/version_0.ts:94</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/waku-org/js-waku/blob/b7bc09d4/packages/core/src/lib/message/version_0.ts#L94">packages/core/src/lib/message/version_0.ts:94</a></li></ul></aside></li></ul></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -158,6 +158,8 @@ messages.</p>
<li class="tsd-kind-reference tsd-parent-kind-module"><a href="../modules/_waku_core.html#wakuStore" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>waku<wbr/>Store</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_waku_core.ConnectionManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-128-path"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)" id="icon-128-text"></path></svg>Connection<wbr/>Manager</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_waku_core.DecodedMessage.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Decoded<wbr/>Message</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_waku_core.Decoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Decoder</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_waku_core.Encoder.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Encoder</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_waku_core.KeepAliveManager.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-128-path"></use><use href="#icon-128-text"></use></svg>Keep<wbr/>Alive<wbr/>Manager</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_waku_core.KeepAliveOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg>Keep<wbr/>Alive<wbr/>Options</a></li>
<li class="tsd-kind-variable tsd-parent-kind-module"><a href="../variables/_waku_core.DefaultPubSubTopic.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-32-path"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)" id="icon-32-text"></path></svg>Default<wbr/>Pub<wbr/>Sub<wbr/>Topic</a></li>