redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-12-17 11:52:32 +03:00
Code Activity

Updates

Browse Source
This commit is contained in:
documentation-bot
2023-01-28 23:46:58 +00:00
parent b2a75a9b35
commit 657dcd20b9
2062 changed files with 2860 additions and 2860 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
documentation/search/interfaces/commands.ProfileOptions.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">ProfileOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/index.ts#L524">search/lib/commands/index.ts:524</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L524">search/lib/commands/index.ts:524</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -37,7 +37,7 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>LIMITED</span><a href="#LIMITED" 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></h3>
<div class="tsd-signature">LIMITED<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/f1e951d/packages/search/lib/commands/index.ts#L525">search/lib/commands/index.ts:525</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L525">search/lib/commands/index.ts:525</a></li></ul></aside></section></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">

6
documentation/search/interfaces/commands.ProfileReply.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">ProfileReply</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/index.ts#L542">search/lib/commands/index.ts:542</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L542">search/lib/commands/index.ts:542</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@
<h3 class="tsd-anchor-link"><span>profile</span><a href="#profile" 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></h3>
<div class="tsd-signature">profile<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ProfileData</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/index.ts#L544">search/lib/commands/index.ts:544</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L544">search/lib/commands/index.ts:544</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="results" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>results</span><a href="#results" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">results<span class="tsd-signature-symbol">:</span> <a href="commands_AGGREGATE.AggregateReply.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateReply</a><span class="tsd-signature-symbol"> | </span><a href="commands.SearchReply.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchReply</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/index.ts#L543">search/lib/commands/index.ts:543</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L543">search/lib/commands/index.ts:543</a></li></ul></aside></section></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">

2
documentation/search/interfaces/commands.RediSearchSchema.html
View File

@@ -24,7 +24,7 @@
<h4 class="tsd-before-signature">Indexable</h4>
<div class="tsd-signature"><span class="tsd-signature-symbol">[</span>field: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">CreateSchemaTextField</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CreateSchemaNumericField</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CreateSchemaGeoField</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CreateSchemaTagField</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CreateSchemaFlatVectorField</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CreateSchemaHNSWVectorField</span></div></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/index.ts#L257">search/lib/commands/index.ts:257</a></li></ul></aside></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L257">search/lib/commands/index.ts:257</a></li></ul></aside></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">

6
documentation/search/interfaces/commands.SearchReply.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">SearchReply</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/index.ts#L516">search/lib/commands/index.ts:516</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L516">search/lib/commands/index.ts:516</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@
<h3 class="tsd-anchor-link"><span>documents</span><a href="#documents" 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></h3>
<div class="tsd-signature">documents<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SearchDocumentValue</span><span class="tsd-signature-symbol">; </span><br/><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/f1e951d/packages/search/lib/commands/index.ts#L518">search/lib/commands/index.ts:518</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L518">search/lib/commands/index.ts:518</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="total" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>total</span><a href="#total" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">total<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/f1e951d/packages/search/lib/commands/index.ts#L517">search/lib/commands/index.ts:517</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/index.ts#L517">search/lib/commands/index.ts:517</a></li></ul></aside></section></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">

12
documentation/search/interfaces/commands_AGGREGATE.AggregateOptions.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">AggregateOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L121">search/lib/commands/AGGREGATE.ts:121</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L121">search/lib/commands/AGGREGATE.ts:121</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -41,27 +41,27 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>DIALECT</span><a href="#DIALECT" 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></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L126">search/lib/commands/AGGREGATE.ts:126</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L126">search/lib/commands/AGGREGATE.ts:126</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LOAD" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>LOAD</span><a href="#LOAD" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">LOAD<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">LoadField</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">LoadField</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/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L123">search/lib/commands/AGGREGATE.ts:123</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L123">search/lib/commands/AGGREGATE.ts:123</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>PARAMS</span><a href="#PARAMS" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">PARAMS<span class="tsd-signature-symbol">?:</span> <a href="../types/commands.Params.html" 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/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L125">search/lib/commands/AGGREGATE.ts:125</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L125">search/lib/commands/AGGREGATE.ts:125</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="STEPS" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>STEPS</span><a href="#STEPS" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">STEPS<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">GroupByStep</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">SortStep</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ApplyStep</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">LimitStep</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FilterStep</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/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L124">search/lib/commands/AGGREGATE.ts:124</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L124">search/lib/commands/AGGREGATE.ts:124</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>VERBATIM</span><a href="#VERBATIM" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L122">search/lib/commands/AGGREGATE.ts:122</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L122">search/lib/commands/AGGREGATE.ts:122</a></li></ul></aside></section></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">

6
documentation/search/interfaces/commands_AGGREGATE.AggregateReply.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">AggregateReply</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L289">search/lib/commands/AGGREGATE.ts:289</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L289">search/lib/commands/AGGREGATE.ts:289</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@
<h3 class="tsd-anchor-link"><span>results</span><a href="#results" 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></h3>
<div class="tsd-signature">results<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">RedisCommandArgument</span><span class="tsd-signature-symbol">&gt;</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/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L291">search/lib/commands/AGGREGATE.ts:291</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L291">search/lib/commands/AGGREGATE.ts:291</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="total" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>total</span><a href="#total" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">total<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/f1e951d/packages/search/lib/commands/AGGREGATE.ts#L290">search/lib/commands/AGGREGATE.ts:290</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/AGGREGATE.ts#L290">search/lib/commands/AGGREGATE.ts:290</a></li></ul></aside></section></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">

36
documentation/search/interfaces/commands_SEARCH.SearchOptions.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">SearchOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/SEARCH.ts#L8">search/lib/commands/SEARCH.ts:8</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L8">search/lib/commands/SEARCH.ts:8</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -53,37 +53,37 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>DIALECT</span><a href="#DIALECT" 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></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L57">search/lib/commands/SEARCH.ts:57</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="EXPANDER" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>EXPANDER</span><a href="#EXPANDER" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L46">search/lib/commands/SEARCH.ts:46</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="HIGHLIGHT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>HIGHLIGHT</span><a href="#HIGHLIGHT" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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><br/><span>    </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><br/><span>    </span>TAGS<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{ </span><br/><span>        </span>close<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>        </span>open<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/SEARCH.ts#L36">search/lib/commands/SEARCH.ts:36</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L36">search/lib/commands/SEARCH.ts:36</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>INFIELDS</span><a href="#INFIELDS" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L28">search/lib/commands/SEARCH.ts:28</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="INKEYS" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>INKEYS</span><a href="#INKEYS" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L27">search/lib/commands/SEARCH.ts:27</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L27">search/lib/commands/SEARCH.ts:27</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>INORDER</span><a href="#INORDER" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L44">search/lib/commands/SEARCH.ts:44</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="LANGUAGE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>LANGUAGE</span><a href="#LANGUAGE" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L45">search/lib/commands/SEARCH.ts:45</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="LIMIT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>LIMIT</span><a href="#LIMIT" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">LIMIT<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </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><br/><span>    </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><br/><span class="tsd-signature-symbol">}</span></div>
@@ -95,52 +95,52 @@
<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><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/SEARCH.ts#L52">search/lib/commands/SEARCH.ts:52</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L52">search/lib/commands/SEARCH.ts:52</a></li></ul></aside></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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>NOSTOPWORDS</span><a href="#NOSTOPWORDS" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L11">search/lib/commands/SEARCH.ts:11</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="PARAMS" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>PARAMS</span><a href="#PARAMS" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">PARAMS<span class="tsd-signature-symbol">?:</span> <a href="../types/commands.Params.html" 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/f1e951d/packages/search/lib/commands/SEARCH.ts#L56">search/lib/commands/SEARCH.ts:56</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L56">search/lib/commands/SEARCH.ts:56</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>RETURN</span><a href="#RETURN" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L29">search/lib/commands/SEARCH.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="SCORER" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>SCORER</span><a href="#SCORER" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L47">search/lib/commands/SEARCH.ts:47</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="SLOP" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>SLOP</span><a href="#SLOP" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L43">search/lib/commands/SEARCH.ts:43</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L43">search/lib/commands/SEARCH.ts:43</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>SORTBY</span><a href="#SORTBY" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">SORTBY<span class="tsd-signature-symbol">?:</span> <a href="../types/commands.SortByProperty.html" 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/f1e951d/packages/search/lib/commands/SEARCH.ts#L50">search/lib/commands/SEARCH.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L50">search/lib/commands/SEARCH.ts:50</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>SUMMARIZE</span><a href="#SUMMARIZE" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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><br/><span>    </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><br/><span>    </span>FRAGS<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>LEN<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>SEPARATOR<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/SEARCH.ts#L30">search/lib/commands/SEARCH.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/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="VERBATIM" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>VERBATIM</span><a href="#VERBATIM" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L10">search/lib/commands/SEARCH.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L10">search/lib/commands/SEARCH.ts:10</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"><code class="tsd-tag ts-flagOptional">Optional</code> <span>WITHSORTKEYS</span><a href="#WITHSORTKEYS" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/f1e951d/packages/search/lib/commands/SEARCH.ts#L14">search/lib/commands/SEARCH.ts:14</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SEARCH.ts#L14">search/lib/commands/SEARCH.ts:14</a></li></ul></aside></section></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">

6
documentation/search/interfaces/commands_SUGGET.SugGetOptions.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">SugGetOptions</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/SUGGET.ts#L3">search/lib/commands/SUGGET.ts:3</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET.ts#L3">search/lib/commands/SUGGET.ts:3</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>FUZZY</span><a href="#FUZZY" 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></h3>
<div class="tsd-signature">FUZZY<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/f1e951d/packages/search/lib/commands/SUGGET.ts#L4">search/lib/commands/SUGGET.ts:4</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET.ts#L4">search/lib/commands/SUGGET.ts:4</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="MAX" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>MAX</span><a href="#MAX" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">MAX<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/f1e951d/packages/search/lib/commands/SUGGET.ts#L5">search/lib/commands/SUGGET.ts:5</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET.ts#L5">search/lib/commands/SUGGET.ts:5</a></li></ul></aside></section></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">

6
documentation/search/interfaces/commands_SUGGET_WITHPAYLOADS.SuggestionWithPayload.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">SuggestionWithPayload</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L12">search/lib/commands/SUGGET_WITHPAYLOADS.ts:12</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L12">search/lib/commands/SUGGET_WITHPAYLOADS.ts:12</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@
<h3 class="tsd-anchor-link"><span>payload</span><a href="#payload" 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></h3>
<div class="tsd-signature">payload<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><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/f1e951d/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L14">search/lib/commands/SUGGET_WITHPAYLOADS.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L14">search/lib/commands/SUGGET_WITHPAYLOADS.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="suggestion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>suggestion</span><a href="#suggestion" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">suggestion<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/f1e951d/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L13">search/lib/commands/SUGGET_WITHPAYLOADS.ts:13</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L13">search/lib/commands/SUGGET_WITHPAYLOADS.ts:13</a></li></ul></aside></section></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">

6
documentation/search/interfaces/commands_SUGGET_WITHSCORES.SuggestionWithScores.html
View File

@@ -21,7 +21,7 @@
<ul class="tsd-hierarchy">
<li><span class="target">SuggestionWithScores</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/f1e951d/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L12">search/lib/commands/SUGGET_WITHSCORES.ts:12</a></li></ul></aside>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L12">search/lib/commands/SUGGET_WITHSCORES.ts:12</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -38,12 +38,12 @@
<h3 class="tsd-anchor-link"><span>score</span><a href="#score" 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></h3>
<div class="tsd-signature">score<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/f1e951d/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L14">search/lib/commands/SUGGET_WITHSCORES.ts:14</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L14">search/lib/commands/SUGGET_WITHSCORES.ts:14</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="suggestion" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>suggestion</span><a href="#suggestion" 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"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">suggestion<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/f1e951d/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L13">search/lib/commands/SUGGET_WITHSCORES.ts:13</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/7a0334f/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L13">search/lib/commands/SUGGET_WITHSCORES.ts:13</a></li></ul></aside></section></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">