redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-09-01 11:41:56 +03:00
Code Activity
Files
cfa682ab09b4b7d05f4c6776a6a9eceb5ff0dcdf
node-redis/documentation/search/interfaces/commands_SEARCH.SearchOptions.html
documentation-bot cfa682ab09 Updates
2022-05-26 14:03:51 +00:00

1 line
35 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SearchOptions | @redis/search</title><meta name="description" content="Documentation for @redis/search"/><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">@redis/search</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">@redis/search</a></li><li><a href="../modules/commands_SEARCH.html">commands/SEARCH</a></li><li><a href="commands_SEARCH.SearchOptions.html">SearchOptions</a></li></ul><h1>Interface SearchOptions </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">SearchOptions</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="commands_SEARCH.SearchOptions.html#DIALECT" class="tsd-kind-icon">DIALECT</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#EXPANDER" class="tsd-kind-icon">EXPANDER</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#HIGHLIGHT" class="tsd-kind-icon">HIGHLIGHT</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INFIELDS" class="tsd-kind-icon">INFIELDS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INKEYS" class="tsd-kind-icon">INKEYS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INORDER" class="tsd-kind-icon">INORDER</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LANGUAGE" class="tsd-kind-icon">LANGUAGE</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LIMIT" class="tsd-kind-icon">LIMIT</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#NOSTOPWORDS" class="tsd-kind-icon">NOSTOPWORDS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#PARAMS" class="tsd-kind-icon">PARAMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#RETURN" class="tsd-kind-icon">RETURN</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SCORER" class="tsd-kind-icon">SCORER</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SLOP" class="tsd-kind-icon">SLOP</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SORTBY" class="tsd-kind-icon">SORTBY</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SUMMARIZE" class="tsd-kind-icon">SUMMARIZE</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#VERBATIM" class="tsd-kind-icon">VERBATIM</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#WITHSORTKEYS" class="tsd-kind-icon">WITHSORTKEYS</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="DIALECT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> DIALECT<a href="#DIALECT" 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">DIALECT<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/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L58">search/lib/commands/SEARCH.ts:58</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="EXPANDER" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> EXPANDER<a href="#EXPANDER" 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">EXPANDER<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/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L47">search/lib/commands/SEARCH.ts:47</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="HIGHLIGHT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> HIGHLIGHT<a href="#HIGHLIGHT" 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">HIGHLIGHT<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>FIELDS<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">@</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">$.</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">@</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">$.</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>TAGS<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L37">search/lib/commands/SEARCH.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="INFIELDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> INFIELDS<a href="#INFIELDS" 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">INFIELDS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L29">search/lib/commands/SEARCH.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="INKEYS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> INKEYS<a href="#INKEYS" 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">INKEYS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L28">search/lib/commands/SEARCH.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="INORDER" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> INORDER<a href="#INORDER" 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">INORDER<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L45">search/lib/commands/SEARCH.ts:45</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LANGUAGE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> LANGUAGE<a href="#LANGUAGE" 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">LANGUAGE<span class="tsd-signature-symbol">?:</span> <a href="../enums/commands.RedisSearchLanguages.html" class="tsd-signature-type" data-tsd-kind="Enumeration">RedisSearchLanguages</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L46">search/lib/commands/SEARCH.ts:46</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LIMIT" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> LIMIT<a href="#LIMIT" 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">LIMIT<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L53">search/lib/commands/SEARCH.ts:53</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>size<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="NOSTOPWORDS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> NOSTOPWORDS<a href="#NOSTOPWORDS" 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">NOSTOPWORDS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L12">search/lib/commands/SEARCH.ts:12</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="PARAMS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> PARAMS<a href="#PARAMS" 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">PARAMS<span class="tsd-signature-symbol">?:</span> <a href="../modules/commands.html#Params" class="tsd-signature-type" data-tsd-kind="Type alias">Params</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L57">search/lib/commands/SEARCH.ts:57</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="RETURN" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> RETURN<a href="#RETURN" 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">RETURN<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L30">search/lib/commands/SEARCH.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SCORER" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> SCORER<a href="#SCORER" 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">SCORER<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/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L48">search/lib/commands/SEARCH.ts:48</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SLOP" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> SLOP<a href="#SLOP" 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">SLOP<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/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L44">search/lib/commands/SEARCH.ts:44</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SORTBY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> SORTBY<a href="#SORTBY" 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">SORTBY<span class="tsd-signature-symbol">?:</span> <a href="../modules/commands.html#SortByProperty" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L51">search/lib/commands/SEARCH.ts:51</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SUMMARIZE" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> SUMMARIZE<a href="#SUMMARIZE" 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">SUMMARIZE<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>FIELDS<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">@</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">$.</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">@</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-type">$.</span><span class="tsd-signature-symbol">${</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">`</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>FRAGS<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>LEN<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>SEPARATOR<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L31">search/lib/commands/SEARCH.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="VERBATIM" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> VERBATIM<a href="#VERBATIM" 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">VERBATIM<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L11">search/lib/commands/SEARCH.ts:11</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="WITHSORTKEYS" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagOptional">Optional</span> WITHSORTKEYS<a href="#WITHSORTKEYS" 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">WITHSORTKEYS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">true</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/82f43d9/packages/search/lib/commands/SEARCH.ts#L15">search/lib/commands/SEARCH.ts:15</a></li></ul></aside></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">Modules</a></li><li class=" tsd-kind-module"><a href="../modules/commands.html">commands</a></li><li class=" tsd-kind-module"><a href="../modules/commands_AGGREGATE.html">commands/AGGREGATE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_ALIASADD.html">commands/ALIASADD</a></li><li class=" tsd-kind-module"><a href="../modules/commands_ALIASDEL.html">commands/ALIASDEL</a></li><li class=" tsd-kind-module"><a href="../modules/commands_ALIASUPDATE.html">commands/ALIASUPDATE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_ALTER.html">commands/ALTER</a></li><li class=" tsd-kind-module"><a href="../modules/commands_CONFIG_GET.html">commands/CONFIG_<wbr/>GET</a></li><li class=" tsd-kind-module"><a href="../modules/commands_CONFIG_SET.html">commands/CONFIG_<wbr/>SET</a></li><li class=" tsd-kind-module"><a href="../modules/commands_CREATE.html">commands/CREATE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_DICTADD.html">commands/DICTADD</a></li><li class=" tsd-kind-module"><a href="../modules/commands_DICTDEL.html">commands/DICTDEL</a></li><li class=" tsd-kind-module"><a href="../modules/commands_DICTDUMP.html">commands/DICTDUMP</a></li><li class=" tsd-kind-module"><a href="../modules/commands_DROPINDEX.html">commands/DROPINDEX</a></li><li class=" tsd-kind-module"><a href="../modules/commands_EXPLAIN.html">commands/EXPLAIN</a></li><li class=" tsd-kind-module"><a href="../modules/commands_EXPLAINCLI.html">commands/EXPLAINCLI</a></li><li class=" tsd-kind-module"><a href="../modules/commands_INFO.html">commands/INFO</a></li><li class=" tsd-kind-module"><a href="../modules/commands_PROFILE_AGGREGATE.html">commands/PROFILE_<wbr/>AGGREGATE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_PROFILE_SEARCH.html">commands/PROFILE_<wbr/>SEARCH</a></li><li class="current tsd-kind-module"><a href="../modules/commands_SEARCH.html">commands/SEARCH</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SPELLCHECK.html">commands/SPELLCHECK</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SUGADD.html">commands/SUGADD</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SUGDEL.html">commands/SUGDEL</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SUGGET.html">commands/SUGGET</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SUGGET_WITHPAYLOADS.html">commands/SUGGET_<wbr/>WITHPAYLOADS</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SUGGET_WITHSCORES.html">commands/SUGGET_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SUGGET_WITHSCORES_WITHPAYLOADS.html">commands/SUGGET_<wbr/>WITHSCORES_<wbr/>WITHPAYLOADS</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SUGLEN.html">commands/SUGLEN</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SYNDUMP.html">commands/SYNDUMP</a></li><li class=" tsd-kind-module"><a href="../modules/commands_SYNUPDATE.html">commands/SYNUPDATE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_TAGVALS.html">commands/TAGVALS</a></li><li class=" tsd-kind-module"><a href="../modules/commands__LIST.html">commands/_<wbr/>LIST</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="commands_SEARCH.SearchOptions.html" class="tsd-kind-icon">Search<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#DIALECT" class="tsd-kind-icon">DIALECT</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#EXPANDER" class="tsd-kind-icon">EXPANDER</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#HIGHLIGHT" class="tsd-kind-icon">HIGHLIGHT</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INFIELDS" class="tsd-kind-icon">INFIELDS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INKEYS" class="tsd-kind-icon">INKEYS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INORDER" class="tsd-kind-icon">INORDER</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LANGUAGE" class="tsd-kind-icon">LANGUAGE</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LIMIT" class="tsd-kind-icon">LIMIT</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#NOSTOPWORDS" class="tsd-kind-icon">NOSTOPWORDS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#PARAMS" class="tsd-kind-icon">PARAMS</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#RETURN" class="tsd-kind-icon">RETURN</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SCORER" class="tsd-kind-icon">SCORER</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SLOP" class="tsd-kind-icon">SLOP</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SORTBY" class="tsd-kind-icon">SORTBY</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SUMMARIZE" class="tsd-kind-icon">SUMMARIZE</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#VERBATIM" class="tsd-kind-icon">VERBATIM</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#WITHSORTKEYS" class="tsd-kind-icon">WITHSORTKEYS</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-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</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>
View Git Blame Copy Permalink