mirror of https://github.com/waku-org/js-waku.git
1 line
18 KiB
HTML
1 line
18 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>waku_light_push | js-waku</title><meta name="description" content="Documentation for js-waku"/><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 async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">js-waku</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">js-waku</a></li><li><a href="waku_light_push.html">waku_light_push</a></li></ul><h1>Namespace waku_light_push</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Classes</h3><ul class="tsd-index-list"><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku_light_push.WakuLightPush.html" class="tsd-kind-icon">Waku<wbr/>Light<wbr/>Push</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_light_push.CreateOptions.html" class="tsd-kind-icon">Create<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_light_push.PushOptions.html" class="tsd-kind-icon">Push<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_light_push.PushResponse.html" class="tsd-kind-icon">Push<wbr/>Response</a></li></ul></section><section class="tsd-index-section "><h3>Variables</h3><ul class="tsd-index-list"><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku_light_push.html#LightPushCodec" class="tsd-kind-icon">Light<wbr/>Push<wbr/>Codec</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku_light_push.html#PushResponse-1" class="tsd-kind-icon">Push<wbr/>Response</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Variables</h2><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="LightPushCodec" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagConst">Const</span> Light<wbr/>Push<wbr/>Codec<a href="#LightPushCodec" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Light<wbr/>Push<wbr/>Codec<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"/vac/waku/lightpush/2.0.0-beta1"</span><span class="tsd-signature-symbol"> = "/vac/waku/lightpush/2.0.0-beta1"</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/6df9726/src/lib/waku_light_push/index.ts#L15">src/lib/waku_light_push/index.ts:15</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace"><a id="PushResponse-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Push<wbr/>Response<a href="#PushResponse-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/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"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></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"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">Push<wbr/>Response<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>decode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>encode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>fromJSON<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>fromPartial<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span>toJSON<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/6df9726/src/proto/waku/v2/light_push.ts#L100">src/proto/waku/v2/light_push.ts:100</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>decode<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">decode<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Reader</span>, length<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/6df9726/src/proto/waku/v2/light_push.ts#L114">src/proto/waku/v2/light_push.ts:114</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>input: <span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Reader</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> length: <span class="tsd-signature-type">number</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></h4></li></ul></li><li class="tsd-parameter"><h5>encode<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">encode<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a>, writer<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Writer</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Writer</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/6df9726/src/proto/waku/v2/light_push.ts#L101">src/proto/waku/v2/light_push.ts:101</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></h5></li><li><h5>writer: <span class="tsd-signature-type">Writer</span><span class="tsd-signature-symbol"> = ...</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Writer</span></h4></li></ul></li><li class="tsd-parameter"><h5>fromJSON<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">fromJSON<span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/6df9726/src/proto/waku/v2/light_push.ts#L135">src/proto/waku/v2/light_push.ts:135</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>object: <span class="tsd-signature-type">any</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></h4></li></ul></li><li class="tsd-parameter"><h5>from<wbr/>Partial<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal tsd-has-type-parameter"><li class="tsd-signature tsd-kind-icon">from<wbr/>Partial<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span>object<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/6df9726/src/proto/waku/v2/light_push.ts#L149">src/proto/waku/v2/light_push.ts:149</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>I<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>info<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>isSuccess<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span>info<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>isSuccess<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Exclude</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">keyof </span><span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">keyof </span><a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h4></li></ul><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>object: <span class="tsd-signature-type" data-tsd-kind="Type parameter">I</span></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></h4></li></ul></li><li class="tsd-parameter"><h5>toJSON<span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-type-literal"><li class="tsd-signature tsd-kind-icon">toJSON<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/6df9726/src/proto/waku/v2/light_push.ts#L142">src/proto/waku/v2/light_push.ts:142</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>message: <a href="waku_light_push.html" class="tsd-signature-type" data-tsd-kind="Namespace">waku_light_push</a><span class="tsd-signature-symbol">.</span><a href="waku_light_push.html#PushResponse-1" class="tsd-signature-type" data-tsd-kind="Variable">PushResponse</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4></li></ul></li></ul></div></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class=" tsd-kind-namespace"><a href="discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="waku.html">waku</a></li><li class="current tsd-kind-namespace"><a href="waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="waku_relay.html">waku_<wbr/>relay</a></li><li class=" tsd-kind-namespace"><a href="waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-class tsd-parent-kind-namespace"><a href="../classes/waku_light_push.WakuLightPush.html" class="tsd-kind-icon">Waku<wbr/>Light<wbr/>Push</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_light_push.CreateOptions.html" class="tsd-kind-icon">Create<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_light_push.PushOptions.html" class="tsd-kind-icon">Push<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-namespace"><a href="../interfaces/waku_light_push.PushResponse.html" class="tsd-kind-icon">Push<wbr/>Response</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku_light_push.html#LightPushCodec" class="tsd-kind-icon">Light<wbr/>Push<wbr/>Codec</a></li><li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="waku_light_push.html#PushResponse-1" class="tsd-kind-icon">Push<wbr/>Response</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |