mirror of https://github.com/waku-org/js-waku.git
32 lines
18 KiB
HTML
32 lines
18 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryOptions | 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="../modules/waku_store.html">waku_store</a></li><li><a href="waku_store.QueryOptions.html">QueryOptions</a></li></ul><h1>Interface QueryOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">QueryOptions</span></li></ul></section><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>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#decryptionKeys" class="tsd-kind-icon">decryption<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageDirection" class="tsd-kind-icon">page<wbr/>Direction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageSize" class="tsd-kind-icon">page<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#peerId" class="tsd-kind-icon">peer<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#timeFilter" class="tsd-kind-icon">time<wbr/>Filter</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#callback" class="tsd-kind-icon">callback</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="decryptionKeys" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> decryption<wbr/>Keys<a href="#decryptionKeys" 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">decryption<wbr/>Keys<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span><span class="tsd-signature-symbol">)</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/10d2533c/src/lib/waku_store/index.ts#L88">src/lib/waku_store/index.ts:88</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Keys that will be used to decrypt messages.</p>
|
|
</div><div><p>It can be Asymmetric Private Keys and Symmetric Keys in the same array,
|
|
all keys will be tried with both methods.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pageDirection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> page<wbr/>Direction<a href="#pageDirection" 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">page<wbr/>Direction<span class="tsd-signature-symbol">?:</span> <a href="../enums/waku_store.PageDirection.html" class="tsd-signature-type" data-tsd-kind="Enumeration">PageDirection</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/10d2533c/src/lib/waku_store/index.ts#L59">src/lib/waku_store/index.ts:59</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The direction in which pages are retrieved:</p>
|
|
<ul>
|
|
<li><a href="../enums/waku_store.PageDirection.html#BACKWARD">PageDirection.BACKWARD</a>: Most recent page first.</li>
|
|
<li><a href="../enums/waku_store.PageDirection.html#FORWARD">PageDirection.FORWARD</a>: Oldest page first.</li>
|
|
</ul>
|
|
</div><div><p>Note: This does not affect the ordering of messages with the page
|
|
(oldest message is always first).</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../enums/waku_store.PageDirection.html#BACKWARD">PageDirection.BACKWARD</a></p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pageSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> page<wbr/>Size<a href="#pageSize" 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">page<wbr/>Size<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/10d2533c/src/lib/waku_store/index.ts#L65">src/lib/waku_store/index.ts:65</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The number of message per page.</p>
|
|
</div><dl class="tsd-comment-tags"><dt>default</dt><dd><p><a href="../modules/waku_store.html#DefaultPageSize">DefaultPageSize</a></p>
|
|
</dd></dl></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="peerId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> peer<wbr/>Id<a href="#peerId" 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">peer<wbr/>Id<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">PeerId</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/10d2533c/src/lib/waku_store/index.ts#L43">src/lib/waku_store/index.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The peer to query. If undefined, a pseudo-random peer is selected from the connected Waku Store peers.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="pubSubTopic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> pub<wbr/>Sub<wbr/>Topic<a href="#pubSubTopic" 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">pub<wbr/>Sub<wbr/>Topic<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/10d2533c/src/lib/waku_store/index.ts#L48">src/lib/waku_store/index.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>The pubsub topic to pass to the query.
|
|
See <a href="https://rfc.vac.dev/spec/23/">Waku v2 Topic Usage Recommendations</a>.</p>
|
|
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="timeFilter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> time<wbr/>Filter<a href="#timeFilter" 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">time<wbr/>Filter<span class="tsd-signature-symbol">?:</span> <a href="waku_store.TimeFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">TimeFilter</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/status-im/js-waku/blob/10d2533c/src/lib/waku_store/index.ts#L69">src/lib/waku_store/index.ts:69</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Retrieve messages with a timestamp within the provided values.</p>
|
|
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="callback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> callback<a href="#callback" 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><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">callback<span class="tsd-signature-symbol">(</span>messages<span class="tsd-signature-symbol">: </span><a href="../classes/waku_message.WakuMessage.html" class="tsd-signature-type" data-tsd-kind="Class">WakuMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</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/10d2533c/src/lib/waku_store/index.ts#L81">src/lib/waku_store/index.ts:81</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Callback called on pages of stored messages as they are retrieved.</p>
|
|
</div><div><p>Allows for a faster access to the results as it is called as soon as a page
|
|
is received. Traversal of the pages is done automatically so this function
|
|
will invoked for each retrieved page.</p>
|
|
<p>If the call on a page returns <code>true</code>, then traversal of the pages is aborted.
|
|
For example, this can be used for the caller to stop the query after a
|
|
specific message is found.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>messages: <a href="../classes/waku_message.WakuMessage.html" class="tsd-signature-type" data-tsd-kind="Class">WakuMessage</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span></h4></li></ul></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="../modules/discovery.html">discovery</a></li><li class=" tsd-kind-namespace"><a href="../modules/enr.html">enr</a></li><li class=" tsd-kind-namespace"><a href="../modules/utils.html">utils</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku.html">waku</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_light_push.html">waku_<wbr/>light_<wbr/>push</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_message.html">waku_<wbr/>message</a></li><li class=" tsd-kind-namespace"><a href="../modules/waku_relay.html">waku_<wbr/>relay</a></li><li class="current tsd-kind-namespace"><a href="../modules/waku_store.html">waku_<wbr/>store</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="waku_store.QueryOptions.html" class="tsd-kind-icon">Query<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#decryptionKeys" class="tsd-kind-icon">decryption<wbr/>Keys</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageDirection" class="tsd-kind-icon">page<wbr/>Direction</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pageSize" class="tsd-kind-icon">page<wbr/>Size</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#peerId" class="tsd-kind-icon">peer<wbr/>Id</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#pubSubTopic" class="tsd-kind-icon">pub<wbr/>Sub<wbr/>Topic</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#timeFilter" class="tsd-kind-icon">time<wbr/>Filter</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="waku_store.QueryOptions.html#callback" class="tsd-kind-icon">callback</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><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> |