waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
js-waku/interfaces/_waku_sdk.waku.waku_store.Q...

21 lines
14 KiB
HTML
Raw Normal View History

Updates
2024-04-07 07:56:46 +00:00
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryOptions | 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/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#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="../assets/icons.svg#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_sdk.html">@waku/sdk</a></li><li><a href="../modules/_waku_sdk.waku.html">waku</a></li><li><a href="../modules/_waku_sdk.waku.waku_store.html">waku_store</a></li><li><a href="_waku_sdk.waku.waku_store.QueryOptions.html">QueryOptions</a></li></ul><h1>Interface QueryOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">QueryOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="_waku_sdk.waku.waku_store.QueryOptions.html#cursor">cursor</a><span class="tsd-signature-symbol">?: </span><a href="_waku_sdk.Cursor.html" class="tsd-signature-type tsd-kind-interface">Cursor</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_waku_sdk.waku.waku_store.QueryOptions.html#pageDirection">pageDirection</a><span class="tsd-signature-symbol">?: </span><a href="../modules/_waku_sdk.waku.html" class="tsd-signature-type tsd-kind-namespace">waku</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_sdk.waku.waku_store.html" class="tsd-signature-type tsd-kind-namespace">waku_store</a><span class="tsd-signature-symbol">.</span><a href="../enums/_waku_sdk.waku.waku_store.PageDirection.html" class="tsd-signature-type tsd-kind-enum">PageDirection</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_waku_sdk.waku.waku_store.QueryOptions.html#pageSize">pageSize</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="_waku_sdk.waku.waku_store.QueryOptions.html#timeFilter">timeFilter</a><span class="tsd-signature-symbol">?: </span><a href="../modules/_waku_sdk.waku.html" class="tsd-signature-type tsd-kind-namespace">waku</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_sdk.waku.w
<a href="_waku_sdk.waku.waku_store.QueryOptions.html#pageDirection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Direction?</span></a>
<a href="_waku_sdk.waku.waku_store.QueryOptions.html#pageSize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Size?</span></a>
<a href="_waku_sdk.waku.waku_store.QueryOptions.html#timeFilter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Filter?</span></a>
</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="cursor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cursor</span><a href="#cursor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">cursor</span><span class="tsd-signature-symbol">?:</span> <a href="_waku_sdk.Cursor.html" class="tsd-signature-type tsd-kind-interface">Cursor</a></div><div class="tsd-comment tsd-typography"><p>Cursor as an index to start a query from.
Updates
2023-06-05 11:41:59 +00:00
The cursor index will be exclusive (i.e. the message at the cursor index will not be included in the result).
If undefined, the query will start from the beginning or end of the history, depending on the page direction.</p>
Updates
2024-04-07 07:56:46 +00:00
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/dist/lib/store/index.d.ts:38</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pageDirection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>page<wbr/>Direction</span><a href="#pageDirection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">page<wbr/>Direction</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/_waku_sdk.waku.html" class="tsd-signature-type tsd-kind-namespace">waku</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_sdk.waku.waku_store.html" class="tsd-signature-type tsd-kind-namespace">waku_store</a><span class="tsd-signature-symbol">.</span><a href="../enums/_waku_sdk.waku.waku_store.PageDirection.html" class="tsd-signature-type tsd-kind-enum">PageDirection</a></div><div class="tsd-comment tsd-typography"><p>The direction in which pages are retrieved:</p>
Updates
2023-06-05 11:41:59 +00:00
<ul>
Updates
2023-09-21 08:59:21 +00:00
<li><a href="../enums/_waku_sdk.waku.waku_store.PageDirection.html#BACKWARD" class="tsd-kind-enum-member">PageDirection.BACKWARD</a>: Most recent page first.</li>
<li><a href="../enums/_waku_sdk.waku.waku_store.PageDirection.html#FORWARD" class="tsd-kind-enum-member">PageDirection.FORWARD</a>: Oldest page first.</li>
Updates
2023-06-05 11:41:59 +00:00
</ul>
<p>Note: This does not affect the ordering of messages with the page
(the oldest message is always first).</p>
Updates
2023-11-28 15:58:49 +00:00
</div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-1">{ @</span><span class="hl-4">link</span><span class="hl-1"> </span><span class="hl-4">PageDirection</span><span class="hl-1">.</span><span class="hl-5">BACKWARD</span><span class="hl-1"> }</span>
Updates
2023-09-21 08:59:21 +00:00
</code><button>Copy</button></pre>
Updates
2024-04-07 07:56:46 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in packages/core/dist/lib/store/index.d.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pageSize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>page<wbr/>Size</span><a href="#pageSize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">page<wbr/>Size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of message per page.</p>
Updates
2023-11-28 15:58:49 +00:00
</div><div class="tsd-comment tsd-typography"><h4>Default</h4><pre><code class="language-ts"><span class="hl-1">{ @</span><span class="hl-4">link</span><span class="hl-1"> </span><span class="hl-4">DefaultPageSize</span><span class="hl-1"> }</span>
Updates
2023-09-21 08:59:21 +00:00
</code><button>Copy</button></pre>
Updates
2024-04-07 07:56:46 +00:00
</div><aside class="tsd-sources"><ul><li>Defined in packages/core/dist/lib/store/index.d.ts:28</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="timeFilter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>time<wbr/>Filter</span><a href="#timeFilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">time<wbr/>Filter</span><span class="tsd-signature-symbol">?:</span> <a href="../modules/_waku_sdk.waku.html" class="tsd-signature-type tsd-kind-namespace">waku</a><span class="tsd-signature-symbol">.</span><a href="../modules/_waku_sdk.waku.waku_store.html" class="tsd-signature-type tsd-kind-namespace">waku_store</a><span class="tsd-signature-symbol">.</span><a href="_waku_sdk.waku.waku_store.TimeFilter.html" class="tsd-signature-type tsd-kind-interface">TimeFilter</a></div><div class="tsd-comment tsd-typography"><p>Retrieve messages with a timestamp within the provided values.</p>
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in packages/core/dist/lib/store/index.d.ts:32</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="../assets/icons.svg#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><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#cursor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cursor</span></a><a href="#pageDirection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Direction</span></a><a href="#pageSize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Size</span></a><a href="#timeFilter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>time<wbr/>Filter</span></a></div></details></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="../assets/icons.svg#icon-1"></use></svg><span>Documentation</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><div class="tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div></body></html>