redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-14 21:21:31 +03:00
Code Activity

Updates

Browse Source
This commit is contained in:
documentation-bot
2022-08-22 22:25:54 +00:00
parent 561f8dabb6
commit 190804e653
1982 changed files with 9378 additions and 6376 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
documentation/search/assets/highlight.css
View File

@@ -1,22 +1,85 @@
:root {
--light-hl-0: #AF00DB;
--dark-hl-0: #C586C0;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #001080;
--dark-hl-2: #9CDCFE;
--light-hl-3: #795E26;
--dark-hl-3: #DCDCAA;
--light-hl-4: #A31515;
--dark-hl-4: #CE9178;
--light-hl-5: #0070C1;
--dark-hl-5: #4FC1FF;
--light-hl-6: #0000FF;
--dark-hl-6: #569CD6;
--light-hl-7: #000000;
--dark-hl-7: #C8C8C8;
--light-hl-8: #098658;
--dark-hl-8: #B5CEA8;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
@media (prefers-color-scheme: light) { :root {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--code-background: var(--light-code-background);
} }
@media (prefers-color-scheme: dark) { :root {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--code-background: var(--dark-code-background);
} }
:root[data-theme='light'] {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--code-background: var(--light-code-background);
}
:root[data-theme='dark'] {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--code-background: var(--dark-code-background);
}
.hl-0 { color: var(--hl-0); }
.hl-1 { color: var(--hl-1); }
.hl-2 { color: var(--hl-2); }
.hl-3 { color: var(--hl-3); }
.hl-4 { color: var(--hl-4); }
.hl-5 { color: var(--hl-5); }
.hl-6 { color: var(--hl-6); }
.hl-7 { color: var(--hl-7); }
.hl-8 { color: var(--hl-8); }
pre, code { background: var(--code-background); }

6
documentation/search/assets/main.js
View File

File diff suppressed because one or more lines are too long

2
documentation/search/assets/search.js
View File

File diff suppressed because one or more lines are too long

88
documentation/search/assets/style.css
View File

@@ -248,35 +248,6 @@ dd {
padding-left: 0;
}
ul.tsd-descriptions > li > :first-child,
.tsd-panel > :first-child,
.col-8 > :first-child,
.col-4 > :first-child,
ul.tsd-descriptions > li > :first-child > :first-child,
.tsd-panel > :first-child > :first-child,
.col-8 > :first-child > :first-child,
.col-4 > :first-child > :first-child,
ul.tsd-descriptions > li > :first-child > :first-child > :first-child,
.tsd-panel > :first-child > :first-child > :first-child,
.col-8 > :first-child > :first-child > :first-child,
.col-4 > :first-child > :first-child > :first-child {
margin-top: 0;
}
ul.tsd-descriptions > li > :last-child,
.tsd-panel > :last-child,
.col-8 > :last-child,
.col-4 > :last-child,
ul.tsd-descriptions > li > :last-child > :last-child,
.tsd-panel > :last-child > :last-child,
.col-8 > :last-child > :last-child,
.col-4 > :last-child > :last-child,
ul.tsd-descriptions > li > :last-child > :last-child > :last-child,
.tsd-panel > :last-child > :last-child > :last-child,
.col-8 > :last-child > :last-child > :last-child,
.col-4 > :last-child > :last-child > :last-child {
margin-bottom: 0;
}
@keyframes fade-in {
from {
opacity: 0;
@@ -971,7 +942,7 @@ a.tsd-index-link {
margin: 2rem 0;
}
.tsd-panel-group.tsd-index-group details {
margin: 4rem 0;
margin: 2rem 0;
}
#tsd-search {
@@ -1073,9 +1044,6 @@ a.tsd-index-link {
font-size: 14px;
overflow-x: auto;
}
.tsd-panel > .tsd-signature {
border-width: 1px 0;
}
.tsd-signature-symbol {
color: var(--color-text-aside);
@@ -1090,60 +1058,16 @@ a.tsd-index-link {
.tsd-signatures {
padding: 0;
margin: 0 0 1em 0;
border: 1px solid var(--color-accent);
list-style-type: none;
}
.tsd-signatures .tsd-signature {
margin: 0;
border-width: 1px 0 0 0;
border-color: var(--color-accent);
border-width: 1px 0;
transition: background-color 0.1s;
}
.tsd-signatures .tsd-signature:first-child {
border-top-width: 0;
}
.tsd-signatures .tsd-signature.current {
background-color: var(--color-background-secondary);
}
.tsd-signatures.active > .tsd-signature {
cursor: pointer;
}
.tsd-panel > .tsd-signatures {
border-width: 1px 0;
}
.tsd-panel > a.anchor + .tsd-signatures {
border-top-width: 0;
margin-top: -20px;
}
ul.tsd-descriptions {
position: relative;
overflow: hidden;
padding: 0;
list-style: none;
}
ul.tsd-descriptions.active > .tsd-description {
display: none;
}
ul.tsd-descriptions.active > .tsd-description.current {
display: block;
}
ul.tsd-descriptions.active > .tsd-description.fade-in {
animation: fade-in-delayed 0.3s;
}
ul.tsd-descriptions.active > .tsd-description.fade-out {
animation: fade-out-delayed 0.3s;
position: absolute;
display: block;
top: 0;
left: 0;
right: 0;
opacity: 0;
visibility: hidden;
}
ul.tsd-descriptions h4,
ul.tsd-descriptions .tsd-index-panel h3,
.tsd-index-panel ul.tsd-descriptions h3 {
font-size: 16px;
margin: 1em 0 0.5em 0;
.tsd-description .tsd-signatures .tsd-signature {
border-width: 1px;
}
ul.tsd-parameter-list,

54
documentation/search/enums/commands.RedisSearchLanguages.html
View File

@@ -13,7 +13,9 @@
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="../modules/commands.html">commands</a></li>
<li><a href="commands.RedisSearchLanguages.html">RedisSearchLanguages</a></li></ul>
<h1>Enumeration RedisSearchLanguages</h1></div>
<h1>Enumeration RedisSearchLanguages</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L107">search/lib/commands/index.ts:107</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,127 +55,127 @@
<h3 class="tsd-anchor-link"><span>ARABIC</span><a href="#ARABIC" 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">ARABIC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Arabic&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L108">search/lib/commands/index.ts:108</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L108">search/lib/commands/index.ts:108</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="BASQUE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>BASQUE</span><a href="#BASQUE" 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">BASQUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Basque&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L109">search/lib/commands/index.ts:109</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L109">search/lib/commands/index.ts:109</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="CATALANA" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>CATALANA</span><a href="#CATALANA" 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">CATALANA<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Catalan&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L110">search/lib/commands/index.ts:110</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L110">search/lib/commands/index.ts:110</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="CHINESE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>CHINESE</span><a href="#CHINESE" 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">CHINESE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Chinese&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L132">search/lib/commands/index.ts:132</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L132">search/lib/commands/index.ts:132</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="DANISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>DANISH</span><a href="#DANISH" 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">DANISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Danish&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L111">search/lib/commands/index.ts:111</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L111">search/lib/commands/index.ts:111</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="DUTCH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>DUTCH</span><a href="#DUTCH" 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">DUTCH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Dutch&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L112">search/lib/commands/index.ts:112</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L112">search/lib/commands/index.ts:112</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ENGLISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ENGLISH</span><a href="#ENGLISH" 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">ENGLISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;English&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L113">search/lib/commands/index.ts:113</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L113">search/lib/commands/index.ts:113</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FINNISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>FINNISH</span><a href="#FINNISH" 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">FINNISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Finnish&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L114">search/lib/commands/index.ts:114</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L114">search/lib/commands/index.ts:114</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FRENCH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>FRENCH</span><a href="#FRENCH" 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">FRENCH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;French&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L115">search/lib/commands/index.ts:115</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L115">search/lib/commands/index.ts:115</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="GERMAN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>GERMAN</span><a href="#GERMAN" 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">GERMAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;German&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L116">search/lib/commands/index.ts:116</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L116">search/lib/commands/index.ts:116</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="GREEK" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>GREEK</span><a href="#GREEK" 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">GREEK<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Greek&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L117">search/lib/commands/index.ts:117</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L117">search/lib/commands/index.ts:117</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="HUNGARIAN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>HUNGARIAN</span><a href="#HUNGARIAN" 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">HUNGARIAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Hungarian&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L118">search/lib/commands/index.ts:118</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L118">search/lib/commands/index.ts:118</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="INDONESAIN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>INDONESAIN</span><a href="#INDONESAIN" 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">INDONESAIN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Indonesian&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L119">search/lib/commands/index.ts:119</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L119">search/lib/commands/index.ts:119</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="IRISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>IRISH</span><a href="#IRISH" 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">IRISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Irish&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L120">search/lib/commands/index.ts:120</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L120">search/lib/commands/index.ts:120</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ITALIAN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ITALIAN</span><a href="#ITALIAN" 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">ITALIAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Italian&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L121">search/lib/commands/index.ts:121</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L121">search/lib/commands/index.ts:121</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LITHUANIAN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>LITHUANIAN</span><a href="#LITHUANIAN" 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">LITHUANIAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Lithuanian&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L122">search/lib/commands/index.ts:122</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L122">search/lib/commands/index.ts:122</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NEPALI" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>NEPALI</span><a href="#NEPALI" 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">NEPALI<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Nepali&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L123">search/lib/commands/index.ts:123</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L123">search/lib/commands/index.ts:123</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NORWEIGAN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>NORWEIGAN</span><a href="#NORWEIGAN" 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">NORWEIGAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Norwegian&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L124">search/lib/commands/index.ts:124</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L124">search/lib/commands/index.ts:124</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="PORTUGUESE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>PORTUGUESE</span><a href="#PORTUGUESE" 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">PORTUGUESE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Portuguese&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L125">search/lib/commands/index.ts:125</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L125">search/lib/commands/index.ts:125</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="ROMANIAN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>ROMANIAN</span><a href="#ROMANIAN" 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">ROMANIAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Romanian&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L126">search/lib/commands/index.ts:126</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L126">search/lib/commands/index.ts:126</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="RUSSIAN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>RUSSIAN</span><a href="#RUSSIAN" 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">RUSSIAN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Russian&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L127">search/lib/commands/index.ts:127</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L127">search/lib/commands/index.ts:127</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SPANISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>SPANISH</span><a href="#SPANISH" 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">SPANISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Spanish&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L128">search/lib/commands/index.ts:128</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L128">search/lib/commands/index.ts:128</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SWEDISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>SWEDISH</span><a href="#SWEDISH" 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">SWEDISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Swedish&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L129">search/lib/commands/index.ts:129</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L129">search/lib/commands/index.ts:129</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="TAMIL" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>TAMIL</span><a href="#TAMIL" 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">TAMIL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Tamil&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L130">search/lib/commands/index.ts:130</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L130">search/lib/commands/index.ts:130</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="TURKISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>TURKISH</span><a href="#TURKISH" 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">TURKISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Turkish&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L131">search/lib/commands/index.ts:131</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L131">search/lib/commands/index.ts:131</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">

14
documentation/search/enums/commands.SchemaFieldTypes.html
View File

@@ -13,7 +13,9 @@
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="../modules/commands.html">commands</a></li>
<li><a href="commands.SchemaFieldTypes.html">SchemaFieldTypes</a></li></ul>
<h1>Enumeration SchemaFieldTypes</h1></div>
<h1>Enumeration SchemaFieldTypes</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L180">search/lib/commands/index.ts:180</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">
@@ -33,27 +35,27 @@
<h3 class="tsd-anchor-link"><span>GEO</span><a href="#GEO" 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">GEO<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;GEO&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L183">search/lib/commands/index.ts:183</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L183">search/lib/commands/index.ts:183</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="NUMERIC" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>NUMERIC</span><a href="#NUMERIC" 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">NUMERIC<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;NUMERIC&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L182">search/lib/commands/index.ts:182</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L182">search/lib/commands/index.ts:182</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="TAG" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>TAG</span><a href="#TAG" 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">TAG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;TAG&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L184">search/lib/commands/index.ts:184</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L184">search/lib/commands/index.ts:184</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="TEXT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>TEXT</span><a href="#TEXT" 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">TEXT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;TEXT&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L181">search/lib/commands/index.ts:181</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L181">search/lib/commands/index.ts:181</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="VECTOR" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>VECTOR</span><a href="#VECTOR" 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">VECTOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;VECTOR&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L185">search/lib/commands/index.ts:185</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L185">search/lib/commands/index.ts:185</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/enums/commands.SchemaTextFieldPhonetics.html
View File

@@ -13,7 +13,9 @@
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="../modules/commands.html">commands</a></li>
<li><a href="commands.SchemaTextFieldPhonetics.html">SchemaTextFieldPhonetics</a></li></ul>
<h1>Enumeration SchemaTextFieldPhonetics</h1></div>
<h1>Enumeration SchemaTextFieldPhonetics</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L207">search/lib/commands/index.ts:207</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">
@@ -32,22 +34,22 @@
<h3 class="tsd-anchor-link"><span>DM_<wbr/>EN</span><a href="#DM_EN" 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">DM_<wbr/>EN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dm:en&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L208">search/lib/commands/index.ts:208</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L208">search/lib/commands/index.ts:208</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="DM_ES" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>DM_<wbr/>ES</span><a href="#DM_ES" 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">DM_<wbr/>ES<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dm:es&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L211">search/lib/commands/index.ts:211</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L211">search/lib/commands/index.ts:211</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="DM_FR" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>DM_<wbr/>FR</span><a href="#DM_FR" 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">DM_<wbr/>FR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dm:fr&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L209">search/lib/commands/index.ts:209</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L209">search/lib/commands/index.ts:209</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FM_PT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>FM_<wbr/>PT</span><a href="#FM_PT" 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">FM_<wbr/>PT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;dm:pt&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L210">search/lib/commands/index.ts:210</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L210">search/lib/commands/index.ts:210</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">

8
documentation/search/enums/commands.VectorAlgorithms.html
View File

@@ -13,7 +13,9 @@
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="../modules/commands.html">commands</a></li>
<li><a href="commands.VectorAlgorithms.html">VectorAlgorithms</a></li></ul>
<h1>Enumeration VectorAlgorithms</h1></div>
<h1>Enumeration VectorAlgorithms</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L231">search/lib/commands/index.ts:231</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">
@@ -30,12 +32,12 @@
<h3 class="tsd-anchor-link"><span>FLAT</span><a href="#FLAT" 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">FLAT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;FLAT&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L232">search/lib/commands/index.ts:232</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L232">search/lib/commands/index.ts:232</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="HNSW" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>HNSW</span><a href="#HNSW" 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">HNSW<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;HNSW&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/index.ts#L233">search/lib/commands/index.ts:233</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L233">search/lib/commands/index.ts:233</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">

30
documentation/search/enums/commands_AGGREGATE.AggregateGroupByReducers.html
View File

@@ -13,7 +13,9 @@
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="../modules/commands_AGGREGATE.html">commands/AGGREGATE</a></li>
<li><a href="commands_AGGREGATE.AggregateGroupByReducers.html">AggregateGroupByReducers</a></li></ul>
<h1>Enumeration AggregateGroupByReducers</h1></div>
<h1>Enumeration AggregateGroupByReducers</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L17">search/lib/commands/AGGREGATE.ts:17</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,67 +43,67 @@
<h3 class="tsd-anchor-link"><span>AVG</span><a href="#AVG" 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">AVG<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;AVG&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L24">search/lib/commands/AGGREGATE.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L24">search/lib/commands/AGGREGATE.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="COUNT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>COUNT</span><a href="#COUNT" 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">COUNT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;COUNT&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L18">search/lib/commands/AGGREGATE.ts:18</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L18">search/lib/commands/AGGREGATE.ts:18</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="COUNT_DISTINCT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>COUNT_<wbr/>DISTINCT</span><a href="#COUNT_DISTINCT" 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">COUNT_<wbr/>DISTINCT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;COUNT_DISTINCT&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L19">search/lib/commands/AGGREGATE.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L19">search/lib/commands/AGGREGATE.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="COUNT_DISTINCTISH" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>COUNT_<wbr/>DISTINCTISH</span><a href="#COUNT_DISTINCTISH" 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">COUNT_<wbr/>DISTINCTISH<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;COUNT_DISTINCTISH&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L20">search/lib/commands/AGGREGATE.ts:20</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L20">search/lib/commands/AGGREGATE.ts:20</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FIRST_VALUE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>FIRST_<wbr/>VALUE</span><a href="#FIRST_VALUE" 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">FIRST_<wbr/>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;FIRST_VALUE&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L29">search/lib/commands/AGGREGATE.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L29">search/lib/commands/AGGREGATE.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="MAX" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><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">&quot;MAX&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L23">search/lib/commands/AGGREGATE.ts:23</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L23">search/lib/commands/AGGREGATE.ts:23</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="MIN" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>MIN</span><a href="#MIN" 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">MIN<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;MIN&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L22">search/lib/commands/AGGREGATE.ts:22</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L22">search/lib/commands/AGGREGATE.ts:22</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="QUANTILE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>QUANTILE</span><a href="#QUANTILE" 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">QUANTILE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;QUANTILE&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L26">search/lib/commands/AGGREGATE.ts:26</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L26">search/lib/commands/AGGREGATE.ts:26</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="RANDOM_SAMPLE" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>RANDOM_<wbr/>SAMPLE</span><a href="#RANDOM_SAMPLE" 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">RANDOM_<wbr/>SAMPLE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;RANDOM_SAMPLE&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L30">search/lib/commands/AGGREGATE.ts:30</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L30">search/lib/commands/AGGREGATE.ts:30</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="STDDEV" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>STDDEV</span><a href="#STDDEV" 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">STDDEV<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;STDDEV&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L25">search/lib/commands/AGGREGATE.ts:25</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L25">search/lib/commands/AGGREGATE.ts:25</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SUM" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>SUM</span><a href="#SUM" 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">SUM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;SUM&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L21">search/lib/commands/AGGREGATE.ts:21</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L21">search/lib/commands/AGGREGATE.ts:21</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="TOLIST" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>TOLIST</span><a href="#TOLIST" 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">TOLIST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;TOLIST&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L27">search/lib/commands/AGGREGATE.ts:27</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L27">search/lib/commands/AGGREGATE.ts:27</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="TO_LIST" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>TO_<wbr/>LIST</span><a href="#TO_LIST" 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">TO_<wbr/>LIST<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;TOLIST&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L28">search/lib/commands/AGGREGATE.ts:28</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L28">search/lib/commands/AGGREGATE.ts:28</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">

14
documentation/search/enums/commands_AGGREGATE.AggregateSteps.html
View File

@@ -13,7 +13,9 @@
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="../modules/commands_AGGREGATE.html">commands/AGGREGATE</a></li>
<li><a href="commands_AGGREGATE.AggregateSteps.html">AggregateSteps</a></li></ul>
<h1>Enumeration AggregateSteps</h1></div>
<h1>Enumeration AggregateSteps</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L5">search/lib/commands/AGGREGATE.ts:5</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">
@@ -33,27 +35,27 @@
<h3 class="tsd-anchor-link"><span>APPLY</span><a href="#APPLY" 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">APPLY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;APPLY&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L8">search/lib/commands/AGGREGATE.ts:8</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L8">search/lib/commands/AGGREGATE.ts:8</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="FILTER" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>FILTER</span><a href="#FILTER" 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">FILTER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;FILTER&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L10">search/lib/commands/AGGREGATE.ts:10</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L10">search/lib/commands/AGGREGATE.ts:10</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="GROUPBY" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>GROUPBY</span><a href="#GROUPBY" 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">GROUPBY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;GROUPBY&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L6">search/lib/commands/AGGREGATE.ts:6</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L6">search/lib/commands/AGGREGATE.ts:6</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="LIMIT" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><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-type">&quot;LIMIT&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L9">search/lib/commands/AGGREGATE.ts:9</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L9">search/lib/commands/AGGREGATE.ts:9</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum"><a id="SORTBY" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><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> <span class="tsd-signature-type">&quot;SORTBY&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/942de1f/packages/search/lib/commands/AGGREGATE.ts#L7">search/lib/commands/AGGREGATE.ts:7</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L7">search/lib/commands/AGGREGATE.ts:7</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">

10
documentation/search/functions/commands.pushArgumentsWithLength.html
View File

@@ -16,8 +16,7 @@
<h1>Function pushArgumentsWithLength</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="pushArgumentsWithLength">push<wbr/>Arguments<wbr/>With<wbr/>Length<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="pushArgumentsWithLength">push<wbr/>Arguments<wbr/>With<wbr/>Length<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, fn<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#pushArgumentsWithLength" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -29,8 +28,7 @@
<ul class="tsd-parameters">
<li class="tsd-parameter-signature">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature"><span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -38,7 +36,9 @@
<li>
<h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L173">search/lib/commands/index.ts:173</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands.pushParamsArgs.html
View File

@@ -16,8 +16,7 @@
<h1>Function pushParamsArgs</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="pushParamsArgs">push<wbr/>Params<wbr/>Args<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, params<span class="tsd-signature-symbol">?: </span><a href="../types/commands.Params.html" class="tsd-signature-type" data-tsd-kind="Type alias">Params</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="pushParamsArgs">push<wbr/>Params<wbr/>Args<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, params<span class="tsd-signature-symbol">?: </span><a href="../types/commands.Params.html" class="tsd-signature-type" data-tsd-kind="Type alias">Params</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#pushParamsArgs" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> params: <a href="../types/commands.Params.html" class="tsd-signature-type" data-tsd-kind="Type alias">Params</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L379">search/lib/commands/index.ts:379</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands.pushSchema.html
View File

@@ -16,8 +16,7 @@
<h1>Function pushSchema</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="pushSchema">push<wbr/>Schema<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="pushSchema">push<wbr/>Schema<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#pushSchema" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li>
<li>
<h5>schema: <a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L267">search/lib/commands/index.ts:267</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands.pushSearchOptions.html
View File

@@ -16,8 +16,7 @@
<h1>Function pushSearchOptions</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="pushSearchOptions">push<wbr/>Search<wbr/>Options<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="pushSearchOptions">push<wbr/>Search<wbr/>Options<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#pushSearchOptions" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L394">search/lib/commands/index.ts:394</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands.pushSortByArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function pushSortByArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="pushSortByArguments">push<wbr/>Sort<wbr/>By<wbr/>Arguments<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sortBy<span class="tsd-signature-symbol">: </span><a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol"> | </span><a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="pushSortByArguments">push<wbr/>Sort<wbr/>By<wbr/>Arguments<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, sortBy<span class="tsd-signature-symbol">: </span><a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol"> | </span><a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#pushSortByArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>name: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>sortBy: <a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol"> | </span><a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L154">search/lib/commands/index.ts:154</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands.pushSortByProperty.html
View File

@@ -16,8 +16,7 @@
<h1>Function pushSortByProperty</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="pushSortByProperty">push<wbr/>Sort<wbr/>By<wbr/>Property<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, sortBy<span class="tsd-signature-symbol">: </span><a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="pushSortByProperty">push<wbr/>Sort<wbr/>By<wbr/>Property<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, sortBy<span class="tsd-signature-symbol">: </span><a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#pushSortByProperty" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li>
<li>
<h5>sortBy: <a href="../types/commands.SortByProperty.html" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L142">search/lib/commands/index.ts:142</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands.transformProfile.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformProfile</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformProfile">transform<wbr/>Profile<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileData</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformProfile">transform<wbr/>Profile<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileData</span><a href="#transformProfile" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>reply: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ProfileData</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ProfileData</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L571">search/lib/commands/index.ts:571</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_AGGREGATE.pushAggregatehOptions.html
View File

@@ -16,8 +16,7 @@
<h1>Function pushAggregatehOptions</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="pushAggregatehOptions">push<wbr/>Aggregateh<wbr/>Options<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="pushAggregatehOptions">push<wbr/>Aggregateh<wbr/>Options<span class="tsd-signature-symbol">(</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#pushAggregatehOptions" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L144">search/lib/commands/AGGREGATE.ts:144</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_AGGREGATE.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L133">search/lib/commands/AGGREGATE.ts:133</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_AGGREGATE.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>total<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">...</span>results<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</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><a href="../interfaces/commands_AGGREGATE.AggregateReply.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateReply</a></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span>total<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">...</span>results<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</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><a href="../interfaces/commands_AGGREGATE.AggregateReply.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateReply</a><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rawReply: <span class="tsd-signature-symbol">[</span>total<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">...</span>results<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands_AGGREGATE.AggregateReply.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateReply</a></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands_AGGREGATE.AggregateReply.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateReply</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L294">search/lib/commands/AGGREGATE.ts:294</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_AGGREGATE_WITHCURSOR.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AggregateWithCursorOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AggregateWithCursorOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">AggregateWithCursorOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE_WITHCURSOR.ts#L15">search/lib/commands/AGGREGATE_WITHCURSOR.ts:15</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_AGGREGATE_WITHCURSOR.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AggregateWithCursorRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AggregateWithCursorReply</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AggregateWithCursorRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">AggregateWithCursorReply</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>reply: <span class="tsd-signature-type">AggregateWithCursorRawReply</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AggregateWithCursorReply</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">AggregateWithCursorReply</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE_WITHCURSOR.ts#L39">search/lib/commands/AGGREGATE_WITHCURSOR.ts:39</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALIASADD.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>name: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>index: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASADD.ts#L1">search/lib/commands/ALIASADD.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALIASADD.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASADD.ts#L5">search/lib/commands/ALIASADD.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALIASDEL.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>name: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>index: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASDEL.ts#L1">search/lib/commands/ALIASDEL.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALIASDEL.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASDEL.ts#L5">search/lib/commands/ALIASDEL.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALIASUPDATE.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, index<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>name: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>index: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASUPDATE.ts#L1">search/lib/commands/ALIASUPDATE.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALIASUPDATE.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASUPDATE.ts#L5">search/lib/commands/ALIASUPDATE.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALTER.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>index: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>schema: <a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALTER.ts#L3">search/lib/commands/ALTER.ts:3</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_ALTER.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALTER.ts#L10">search/lib/commands/ALTER.ts:10</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CONFIG_GET.transformArguments.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>option<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>option<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>option: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CONFIG_GET.ts#L1">search/lib/commands/CONFIG_GET.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CONFIG_GET.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</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">ConfigGetReply</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">null</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">ConfigGetReply</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rawReply: <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><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><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ConfigGetReply</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ConfigGetReply</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CONFIG_GET.ts#L9">search/lib/commands/CONFIG_GET.ts:9</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CONFIG_SET.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>option<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>option<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, value<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>option: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CONFIG_SET.ts#L1">search/lib/commands/CONFIG_SET.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CONFIG_SET.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CONFIG_SET.ts#L5">search/lib/commands/CONFIG_SET.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CREATE.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CreateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, schema<span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">CreateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>schema: <a href="../interfaces/commands.RediSearchSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">RediSearchSchema</a></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">CreateOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CREATE.ts#L23">search/lib/commands/CREATE.ts:23</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CREATE.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CREATE.ts#L91">search/lib/commands/CREATE.ts:91</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CURSOR_DEL.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</span>, cursorId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</span>, cursorId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>index: <span class="tsd-signature-type">RedisCommandArgument</span></h5></li>
<li>
<h5>cursorId: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArgument</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArgument</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CURSOR_DEL.ts#L5">search/lib/commands/CURSOR_DEL.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CURSOR_DEL.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CURSOR_DEL.ts#L14">search/lib/commands/CURSOR_DEL.ts:14</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_CURSOR_READ.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</span>, cursor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArgument</span>, cursor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>index: <span class="tsd-signature-type">RedisCommandArgument</span></h5></li>
<li>
<h5>cursor: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/CURSOR_READ.ts#L7">search/lib/commands/CURSOR_READ.ts:7</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DICTADD.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>dictionary<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, term<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>dictionary<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, term<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>dictionary: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>term: <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></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DICTADD.ts#L4">search/lib/commands/DICTADD.ts:4</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DICTADD.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DICTADD.ts#L8">search/lib/commands/DICTADD.ts:8</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DICTDEL.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>dictionary<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, term<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>dictionary<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, term<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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>dictionary: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>term: <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></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DICTDEL.ts#L4">search/lib/commands/DICTDEL.ts:4</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DICTDEL.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DICTDEL.ts#L8">search/lib/commands/DICTDEL.ts:8</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DICTDUMP.transformArguments.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>dictionary<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>dictionary<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>dictionary: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DICTDUMP.ts#L1">search/lib/commands/DICTDUMP.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DICTDUMP.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DICTDUMP.ts#L5">search/lib/commands/DICTDUMP.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DROPINDEX.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DropIndexOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">DropIndexOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>index: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">DropIndexOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DROPINDEX.ts#L5">search/lib/commands/DROPINDEX.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_DROPINDEX.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/DROPINDEX.ts#L15">search/lib/commands/DROPINDEX.ts:15</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_EXPLAIN.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ExplainOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ExplainOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">ExplainOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/EXPLAIN.ts#L10">search/lib/commands/EXPLAIN.ts:10</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_EXPLAIN.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/EXPLAIN.ts#L26">search/lib/commands/EXPLAIN.ts:26</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_EXPLAINCLI.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>index: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>query: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/EXPLAINCLI.ts#L3">search/lib/commands/EXPLAINCLI.ts:3</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_EXPLAINCLI.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/EXPLAINCLI.ts#L7">search/lib/commands/EXPLAINCLI.ts:7</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_INFO.transformArguments.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>index: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/INFO.ts#L4">search/lib/commands/INFO.ts:4</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_INFO.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InfoRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InfoReply</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InfoRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InfoReply</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rawReply: <span class="tsd-signature-type">InfoRawReply</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InfoReply</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InfoReply</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/INFO.ts#L126">search/lib/commands/INFO.ts:126</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_PROFILE_AGGREGATE.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands.ProfileOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands.ProfileOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands.ProfileOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/commands_AGGREGATE.AggregateOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AggregateOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/PROFILE_AGGREGATE.ts#L6">search/lib/commands/PROFILE_AGGREGATE.ts:6</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_PROFILE_AGGREGATE.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileAggeregateRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileAggeregateRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>reply: <span class="tsd-signature-type">ProfileAggeregateRawReply</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/PROFILE_AGGREGATE.ts#L24">search/lib/commands/PROFILE_AGGREGATE.ts:24</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_PROFILE_SEARCH.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands.ProfileOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands.ProfileOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands.ProfileOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileOptions</a><span class="tsd-signature-symbol"> &amp; </span><a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/PROFILE_SEARCH.ts#L7">search/lib/commands/PROFILE_SEARCH.ts:7</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_PROFILE_SEARCH.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileSearchRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">ProfileSearchRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>reply: <span class="tsd-signature-type">ProfileSearchRawReply</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands.ProfileReply.html" class="tsd-signature-type" data-tsd-kind="Interface">ProfileReply</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/PROFILE_SEARCH.ts#L24">search/lib/commands/PROFILE_SEARCH.ts:24</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SEARCH.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SEARCH.ts#L61">search/lib/commands/SEARCH.ts:61</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SEARCH.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><a href="../types/commands_SEARCH.SearchRawReply.html" class="tsd-signature-type" data-tsd-kind="Type alias">SearchRawReply</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.SearchReply.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchReply</a></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><a href="../types/commands_SEARCH.SearchRawReply.html" class="tsd-signature-type" data-tsd-kind="Type alias">SearchRawReply</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands.SearchReply.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchReply</a><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>reply: <a href="../types/commands_SEARCH.SearchRawReply.html" class="tsd-signature-type" data-tsd-kind="Type alias">SearchRawReply</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands.SearchReply.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchReply</a></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands.SearchReply.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchReply</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SEARCH.ts#L74">search/lib/commands/SEARCH.ts:74</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SPELLCHECK.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SpellCheckOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, query<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SpellCheckOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>query: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">SpellCheckOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SPELLCHECK.ts#L12">search/lib/commands/SPELLCHECK.ts:12</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SPELLCHECK.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SpellCheckRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SpellCheckReply</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SpellCheckRawReply</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SpellCheckReply</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rawReply: <span class="tsd-signature-type">SpellCheckRawReply</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SpellCheckReply</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SpellCheckReply</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SPELLCHECK.ts#L54">search/lib/commands/SPELLCHECK.ts:54</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGADD.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, string<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SugAddOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, string<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, score<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SugAddOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -30,7 +29,9 @@
<h5>score: <span class="tsd-signature-type">number</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">SugAddOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGADD.ts#L6">search/lib/commands/SUGADD.ts:6</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGADD.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGADD.ts#L20">search/lib/commands/SUGADD.ts:20</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGDEL.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, string<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, string<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>key: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>string: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGDEL.ts#L1">search/lib/commands/SUGDEL.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGDEL.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>reply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>reply: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in client/dist/lib/commands/generic-transformers.d.ts:2</li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>prefix: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET.ts#L8">search/lib/commands/SUGGET.ts:8</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><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><span class="tsd-signature-symbol">[]</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET.ts#L22">search/lib/commands/SUGGET.ts:22</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET_WITHPAYLOADS.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>prefix: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L5">search/lib/commands/SUGGET_WITHPAYLOADS.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET_WITHPAYLOADS.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands_SUGGET_WITHPAYLOADS.SuggestionWithPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithPayload</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands_SUGGET_WITHPAYLOADS.SuggestionWithPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithPayload</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rawReply: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands_SUGGET_WITHPAYLOADS.SuggestionWithPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithPayload</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands_SUGGET_WITHPAYLOADS.SuggestionWithPayload.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithPayload</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET_WITHPAYLOADS.ts#L17">search/lib/commands/SUGGET_WITHPAYLOADS.ts:17</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET_WITHSCORES.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>prefix: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L5">search/lib/commands/SUGGET_WITHSCORES.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET_WITHSCORES.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<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><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands_SUGGET_WITHSCORES.SuggestionWithScores.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithScores</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<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><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/commands_SUGGET_WITHSCORES.SuggestionWithScores.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithScores</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rawReply: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands_SUGGET_WITHSCORES.SuggestionWithScores.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithScores</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/commands_SUGGET_WITHSCORES.SuggestionWithScores.html" class="tsd-signature-type" data-tsd-kind="Interface">SuggestionWithScores</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET_WITHSCORES.ts#L17">search/lib/commands/SUGGET_WITHSCORES.ts:17</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET_WITHSCORES_WITHPAYLOADS.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, prefix<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -28,7 +27,9 @@
<h5>prefix: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <a href="../interfaces/commands_SUGGET.SugGetOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SugGetOptions</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET_WITHSCORES_WITHPAYLOADS.ts#L7">search/lib/commands/SUGGET_WITHSCORES_WITHPAYLOADS.ts:7</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGGET_WITHSCORES_WITHPAYLOADS.transformReply.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><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><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">SuggestionWithScoresAndPayloads</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span>rawReply<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><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><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">SuggestionWithScoresAndPayloads</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>rawReply: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><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><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SuggestionWithScoresAndPayloads</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">SuggestionWithScoresAndPayloads</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGGET_WITHSCORES_WITHPAYLOADS.ts#L17">search/lib/commands/SUGGET_WITHSCORES_WITHPAYLOADS.ts:17</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGLEN.transformArguments.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>key<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>key: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGLEN.ts#L3">search/lib/commands/SUGLEN.ts:3</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SUGLEN.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SUGLEN.ts#L7">search/lib/commands/SUGLEN.ts:7</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SYNDUMP.transformArguments.html
View File

@@ -16,15 +16,16 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>index: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SYNDUMP.ts#L1">search/lib/commands/SYNDUMP.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SYNDUMP.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SYNDUMP.ts#L5">search/lib/commands/SYNDUMP.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SYNUPDATE.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, terms<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>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SynUpdateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, groupId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, terms<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>, options<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SynUpdateOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">RedisCommandArguments</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -30,7 +29,9 @@
<h5>terms: <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></h5></li>
<li>
<h5><code class="tsd-tag ts-flagOptional">Optional</code> options: <span class="tsd-signature-type">SynUpdateOptions</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SYNUPDATE.ts#L8">search/lib/commands/SYNUPDATE.ts:8</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_SYNUPDATE.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;OK&quot;</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">&quot;OK&quot;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SYNUPDATE.ts#L23">search/lib/commands/SYNUPDATE.ts:23</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_TAGVALS.transformArguments.html
View File

@@ -16,8 +16,7 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<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-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, fieldName<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-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -26,7 +25,9 @@
<h5>index: <span class="tsd-signature-type">string</span></h5></li>
<li>
<h5>fieldName: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/TAGVALS.ts#L1">search/lib/commands/TAGVALS.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands_TAGVALS.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/TAGVALS.ts#L5">search/lib/commands/TAGVALS.ts:5</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands__LIST.transformArguments.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformArguments</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformArguments">transform<wbr/>Arguments<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformArguments" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/_LIST.ts#L1">search/lib/commands/_LIST.ts:1</a></li></ul></aside></li></ul></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">

7
documentation/search/functions/commands__LIST.transformReply.html
View File

@@ -16,10 +16,11 @@
<h1>Function transformReply</h1></div>
<section class="tsd-panel">
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></li></ul>
<ul class="tsd-descriptions">
<li class="tsd-signature tsd-anchor-link" id="transformReply">transform<wbr/>Reply<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><a href="#transformReply" 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></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/_LIST.ts#L5">search/lib/commands/_LIST.ts:5</a></li></ul></aside></li></ul></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">

61
documentation/search/index.html
View File

@@ -9,11 +9,66 @@
<div class="container container-main">
<div class="col-8 col-content">
<div class="tsd-page-title">
<h2> @redis/search</h2></div>
<h2>@redis/search</h2></div>
<div class="tsd-panel tsd-typography">
<a href="#" id="" style="color: inherit; text-decoration: none;">
<h1></h1>
<a href="#redissearch" id="redissearch" style="color: inherit; text-decoration: none;">
<h1>@redis/search</h1>
</a>
<p>This package provides support for the <a href="https://redisearch.io">RediSearch</a> module, which adds indexing and querying support for data stored in Redis Hashes or as JSON documents with the RedisJSON module. It extends the <a href="https://github.com/redis/node-redis">Node Redis client</a> to include functions for each of the RediSearch commands.</p>
<p>To use these extra commands, your Redis server must have the RediSearch module installed. To index and query JSON documents, you&#39;ll also need to add the RedisJSON module.</p>
<a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
<h2>Usage</h2>
</a>
<p>For complete examples, see <a href="https://github.com/redis/node-redis/blob/master/examples/search-hashes.js"><code>search-hashes.js</code></a> and <a href="https://github.com/redis/node-redis/blob/master/examples/search-json.js"><code>search-json.js</code></a> in the Node Redis examples folder.</p>
<a href="#indexing-and-querying-data-in-redis-hashes" id="indexing-and-querying-data-in-redis-hashes" style="color: inherit; text-decoration: none;">
<h3>Indexing and Querying Data in Redis Hashes</h3>
</a>
<a href="#creating-an-index" id="creating-an-index" style="color: inherit; text-decoration: none;">
<h4>Creating an Index</h4>
</a>
<p>Before we can perform any searches, we need to tell RediSearch how to index our data, and which Redis keys to find that data in. The <a href="https://oss.redis.com/redisearch/Commands/#ftcreate">FT.CREATE</a> command creates a RediSearch index. Here&#39;s how to use it to create an index we&#39;ll call <code>idx:animals</code> where we want to index hashes containing <code>name</code>, <code>species</code> and <code>age</code> fields, and whose key names in Redis begin with the prefix <code>noderedis:animals</code>:</p>
<pre><code class="language-javascript"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1">.</span><span class="hl-2">ft</span><span class="hl-1">.</span><span class="hl-3">create</span><span class="hl-1">(</span><span class="hl-4">&#39;idx:animals&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">SchemaFieldTypes</span><span class="hl-1">.</span><span class="hl-5">TEXT</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">sortable:</span><span class="hl-1"> </span><span class="hl-6">true</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-2">species:</span><span class="hl-1"> </span><span class="hl-2">SchemaFieldTypes</span><span class="hl-1">.</span><span class="hl-5">TAG</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">age:</span><span class="hl-1"> </span><span class="hl-2">SchemaFieldTypes</span><span class="hl-1">.</span><span class="hl-5">NUMERIC</span><br/><span class="hl-1"> }, {</span><br/><span class="hl-1"> </span><span class="hl-2">ON:</span><span class="hl-1"> </span><span class="hl-4">&#39;HASH&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">PREFIX:</span><span class="hl-1"> </span><span class="hl-4">&#39;noderedis:animals&#39;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">);</span>
</code></pre>
<p>See the <a href="https://oss.redis.com/redisearch/Commands/#ftcreate"><code>FT.CREATE</code> documentation</a> for information about the different field types and additional options.</p>
<a href="#querying-the-index" id="querying-the-index" style="color: inherit; text-decoration: none;">
<h4>Querying the Index</h4>
</a>
<p>Once we&#39;ve created an index, and added some data to Redis hashes whose keys begin with the prefix <code>noderedis:animals</code>, we can start writing some search queries. RediSearch supports a rich query syntax for full-text search, faceted search, aggregation and more. Check out the <a href="https://oss.redis.com/redisearch/Commands/#ftsearch"><code>FT.SEARCH</code> documentation</a> and the <a href="https://oss.redis.com/redisearch/Query_Syntax/">query syntax reference</a> for more information.</p>
<p>Let&#39;s write a query to find all the animals where the <code>species</code> field has the value <code>dog</code>:</p>
<pre><code class="language-javascript"><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-5">results</span><span class="hl-1"> = </span><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1">.</span><span class="hl-2">ft</span><span class="hl-1">.</span><span class="hl-3">search</span><span class="hl-1">(</span><span class="hl-4">&#39;idx:animals&#39;</span><span class="hl-1">, </span><span class="hl-4">&#39;@species:{dog}&#39;</span><span class="hl-1">);</span>
</code></pre>
<p><code>results</code> looks like this:</p>
<pre><code class="language-javascript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-7">total</span><span class="hl-1">: </span><span class="hl-8">2</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">documents</span><span class="hl-1">: [</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">id:</span><span class="hl-1"> </span><span class="hl-4">&#39;noderedis:animals:4&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">value:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-4">&#39;Fido&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">species:</span><span class="hl-1"> </span><span class="hl-4">&#39;dog&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">age:</span><span class="hl-1"> </span><span class="hl-4">&#39;7&#39;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">id:</span><span class="hl-1"> </span><span class="hl-4">&#39;noderedis:animals:3&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">value:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">name:</span><span class="hl-1"> </span><span class="hl-4">&#39;Rover&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">species:</span><span class="hl-1"> </span><span class="hl-4">&#39;dog&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">age:</span><span class="hl-1"> </span><span class="hl-4">&#39;9&#39;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> ]</span><br/><span class="hl-1">}</span>
</code></pre>
<a href="#indexing-and-querying-data-with-redisjson" id="indexing-and-querying-data-with-redisjson" style="color: inherit; text-decoration: none;">
<h3>Indexing and Querying Data with RedisJSON</h3>
</a>
<p>RediSearch can also index and query JSON documents stored in Redis using the RedisJSON module. The approach is similar to that for indexing and searching data in hashes, but we can now use JSON Path like syntax and the data no longer has to be flat name/value pairs - it can contain nested objects and arrays.</p>
<a href="#creating-an-index-1" id="creating-an-index-1" style="color: inherit; text-decoration: none;">
<h4>Creating an Index</h4>
</a>
<p>As before, we create an index with the <code>FT.CREATE</code> command, this time specifying we want to index JSON documents that look like this:</p>
<pre><code class="language-javascript"><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-7">name</span><span class="hl-1">: </span><span class="hl-4">&#39;Alice&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">age</span><span class="hl-1">: </span><span class="hl-8">32</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-7">coins</span><span class="hl-1">: </span><span class="hl-8">100</span><br/><span class="hl-1">}</span>
</code></pre>
<p>Each document represents a user in some system, and users have name, age and coins properties.</p>
<p>One way we might choose to index these documents is as follows:</p>
<pre><code class="language-javascript"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1">.</span><span class="hl-2">ft</span><span class="hl-1">.</span><span class="hl-3">create</span><span class="hl-1">(</span><span class="hl-4">&#39;idx:users&#39;</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-4">&#39;$.name&#39;</span><span class="hl-2">:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">SchemaFieldTypes</span><span class="hl-1">.</span><span class="hl-5">TEXT</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">SORTABLE:</span><span class="hl-1"> </span><span class="hl-4">&#39;UNF&#39;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-4">&#39;$.age&#39;</span><span class="hl-2">:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">SchemaFieldTypes</span><span class="hl-1">.</span><span class="hl-5">NUMERIC</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">AS:</span><span class="hl-1"> </span><span class="hl-4">&#39;age&#39;</span><br/><span class="hl-1"> },</span><br/><span class="hl-1"> </span><span class="hl-4">&#39;$.coins&#39;</span><span class="hl-2">:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-2">SchemaFieldTypes</span><span class="hl-1">.</span><span class="hl-5">NUMERIC</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">AS:</span><span class="hl-1"> </span><span class="hl-4">&#39;coins&#39;</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}, {</span><br/><span class="hl-1"> </span><span class="hl-2">ON:</span><span class="hl-1"> </span><span class="hl-4">&#39;JSON&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">PREFIX:</span><span class="hl-1"> </span><span class="hl-4">&#39;noderedis:users&#39;</span><br/><span class="hl-1">});</span>
</code></pre>
<p>Note that we&#39;re using JSON Path to specify where the fields to index are in our JSON documents, and the <code>AS</code> clause to define a name/alias for each field. We&#39;ll use these when writing queries.</p>
<a href="#querying-the-index-1" id="querying-the-index-1" style="color: inherit; text-decoration: none;">
<h4>Querying the Index</h4>
</a>
<p>Now we have an index and some data stored as JSON documents in Redis (see the <a href="https://github.com/redis/node-redis/tree/master/packages/json">JSON package documentation</a> for examples of how to store JSON), we can write some queries...</p>
<p>We&#39;ll use the <a href="https://oss.redis.com/redisearch/Query_Syntax/">RediSearch query language</a> and <a href="https://oss.redis.com/redisearch/Commands/#ftsearch"><code>FT.SEARCH</code></a> command. Here&#39;s a query to find users under the age of 30:</p>
<pre><code class="language-javascript"><span class="hl-0">await</span><span class="hl-1"> </span><span class="hl-2">client</span><span class="hl-1">.</span><span class="hl-2">ft</span><span class="hl-1">.</span><span class="hl-3">search</span><span class="hl-1">(</span><span class="hl-4">&#39;idx:users&#39;</span><span class="hl-1">, </span><span class="hl-4">&#39;@age:[0 30]&#39;</span><span class="hl-1">);</span>
</code></pre>
</div></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ProfileOptions</span></li></ul></section>
<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/35be671/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">
@@ -25,7 +27,7 @@
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="commands.ProfileOptions.html#LIMITED" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>LIMITED</span></a>
<div class="tsd-index-list"><a href="commands.ProfileOptions.html#LIMITED" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>LIMITED?</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
@@ -33,7 +35,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/942de1f/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/35be671/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">
@@ -94,7 +96,7 @@
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module"><a href="commands.ProfileOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Profile<wbr/>Options</span></a>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands.ProfileOptions.html#LIMITED" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LIMITED</a></li></ul></li></ul></nav></div></div>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands.ProfileOptions.html#LIMITED" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LIMITED?</a></li></ul></li></ul></nav></div></div>
<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>

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ProfileReply</span></li></ul></section>
<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/35be671/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">
@@ -34,12 +36,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/942de1f/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/35be671/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/942de1f/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/35be671/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">

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

@@ -20,7 +20,9 @@
<li><span class="target">RediSearchSchema</span></li></ul></section>
<section class="tsd-panel tsd-kind-interface tsd-parent-kind-module">
<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></div>
<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/35be671/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">

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">SearchReply</span></li></ul></section>
<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/35be671/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">
@@ -34,12 +36,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>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">SearchDocumentValue</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/942de1f/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/35be671/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/942de1f/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/35be671/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">

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AggregateOptions</span></li></ul></section>
<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/35be671/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">
@@ -25,11 +27,11 @@
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="commands_AGGREGATE.AggregateOptions.html#DIALECT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>DIALECT</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#LOAD" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>LOAD</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#PARAMS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>PARAMS</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#STEPS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>STEPS</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#VERBATIM" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>VERBATIM</span></a>
<div class="tsd-index-list"><a href="commands_AGGREGATE.AggregateOptions.html#DIALECT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>DIALECT?</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#LOAD" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>LOAD?</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#PARAMS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>PARAMS?</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#STEPS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>STEPS?</span></a>
<a href="commands_AGGREGATE.AggregateOptions.html#VERBATIM" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>VERBATIM?</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
@@ -37,27 +39,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/942de1f/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/35be671/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/942de1f/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/35be671/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/942de1f/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/35be671/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/942de1f/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/35be671/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/942de1f/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/35be671/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">
@@ -118,11 +120,11 @@
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module"><a href="commands_AGGREGATE.AggregateOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Aggregate<wbr/>Options</span></a>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#DIALECT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>DIALECT</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#LOAD" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LOAD</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#PARAMS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>PARAMS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#STEPS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>STEPS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#VERBATIM" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>VERBATIM</a></li></ul></li></ul></nav></div></div>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#DIALECT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>DIALECT?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#LOAD" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LOAD?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#PARAMS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>PARAMS?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#STEPS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>STEPS?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_AGGREGATE.AggregateOptions.html#VERBATIM" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>VERBATIM?</a></li></ul></li></ul></nav></div></div>
<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>

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AggregateReply</span></li></ul></section>
<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/35be671/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">
@@ -34,12 +36,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/942de1f/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/35be671/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/942de1f/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/35be671/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">

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">SearchOptions</span></li></ul></section>
<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/35be671/packages/search/lib/commands/SEARCH.ts#L9">search/lib/commands/SEARCH.ts:9</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">
@@ -25,23 +27,23 @@
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="commands_SEARCH.SearchOptions.html#DIALECT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>DIALECT</span></a>
<a href="commands_SEARCH.SearchOptions.html#EXPANDER" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>EXPANDER</span></a>
<a href="commands_SEARCH.SearchOptions.html#HIGHLIGHT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>HIGHLIGHT</span></a>
<a href="commands_SEARCH.SearchOptions.html#INFIELDS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>INFIELDS</span></a>
<a href="commands_SEARCH.SearchOptions.html#INKEYS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>INKEYS</span></a>
<a href="commands_SEARCH.SearchOptions.html#INORDER" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>INORDER</span></a>
<a href="commands_SEARCH.SearchOptions.html#LANGUAGE" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>LANGUAGE</span></a>
<a href="commands_SEARCH.SearchOptions.html#LIMIT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>LIMIT</span></a>
<a href="commands_SEARCH.SearchOptions.html#NOSTOPWORDS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>NOSTOPWORDS</span></a>
<a href="commands_SEARCH.SearchOptions.html#PARAMS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>PARAMS</span></a>
<a href="commands_SEARCH.SearchOptions.html#RETURN" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>RETURN</span></a>
<a href="commands_SEARCH.SearchOptions.html#SCORER" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SCORER</span></a>
<a href="commands_SEARCH.SearchOptions.html#SLOP" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SLOP</span></a>
<a href="commands_SEARCH.SearchOptions.html#SORTBY" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SORTBY</span></a>
<a href="commands_SEARCH.SearchOptions.html#SUMMARIZE" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SUMMARIZE</span></a>
<a href="commands_SEARCH.SearchOptions.html#VERBATIM" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>VERBATIM</span></a>
<a href="commands_SEARCH.SearchOptions.html#WITHSORTKEYS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>WITHSORTKEYS</span></a>
<div class="tsd-index-list"><a href="commands_SEARCH.SearchOptions.html#DIALECT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>DIALECT?</span></a>
<a href="commands_SEARCH.SearchOptions.html#EXPANDER" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>EXPANDER?</span></a>
<a href="commands_SEARCH.SearchOptions.html#HIGHLIGHT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>HIGHLIGHT?</span></a>
<a href="commands_SEARCH.SearchOptions.html#INFIELDS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>INFIELDS?</span></a>
<a href="commands_SEARCH.SearchOptions.html#INKEYS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>INKEYS?</span></a>
<a href="commands_SEARCH.SearchOptions.html#INORDER" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>INORDER?</span></a>
<a href="commands_SEARCH.SearchOptions.html#LANGUAGE" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>LANGUAGE?</span></a>
<a href="commands_SEARCH.SearchOptions.html#LIMIT" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>LIMIT?</span></a>
<a href="commands_SEARCH.SearchOptions.html#NOSTOPWORDS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>NOSTOPWORDS?</span></a>
<a href="commands_SEARCH.SearchOptions.html#PARAMS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>PARAMS?</span></a>
<a href="commands_SEARCH.SearchOptions.html#RETURN" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>RETURN?</span></a>
<a href="commands_SEARCH.SearchOptions.html#SCORER" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SCORER?</span></a>
<a href="commands_SEARCH.SearchOptions.html#SLOP" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SLOP?</span></a>
<a href="commands_SEARCH.SearchOptions.html#SORTBY" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SORTBY?</span></a>
<a href="commands_SEARCH.SearchOptions.html#SUMMARIZE" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>SUMMARIZE?</span></a>
<a href="commands_SEARCH.SearchOptions.html#VERBATIM" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>VERBATIM?</span></a>
<a href="commands_SEARCH.SearchOptions.html#WITHSORTKEYS" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>WITHSORTKEYS?</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
@@ -49,37 +51,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/942de1f/packages/search/lib/commands/SEARCH.ts#L58">search/lib/commands/SEARCH.ts:58</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/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"><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/942de1f/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/35be671/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"><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>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/942de1f/packages/search/lib/commands/SEARCH.ts#L37">search/lib/commands/SEARCH.ts:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/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"><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/942de1f/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/35be671/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"><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/942de1f/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/35be671/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"><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/942de1f/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/35be671/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"><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/942de1f/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/35be671/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"><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>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>
@@ -91,52 +93,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/942de1f/packages/search/lib/commands/SEARCH.ts#L53">search/lib/commands/SEARCH.ts:53</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/SEARCH.ts#L53">search/lib/commands/SEARCH.ts:53</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/942de1f/packages/search/lib/commands/SEARCH.ts#L12">search/lib/commands/SEARCH.ts:12</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/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"><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/942de1f/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/35be671/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"><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/942de1f/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/35be671/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"><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/942de1f/packages/search/lib/commands/SEARCH.ts#L48">search/lib/commands/SEARCH.ts:48</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/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"><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/942de1f/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/35be671/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"><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/942de1f/packages/search/lib/commands/SEARCH.ts#L51">search/lib/commands/SEARCH.ts:51</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/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"><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>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/942de1f/packages/search/lib/commands/SEARCH.ts#L31">search/lib/commands/SEARCH.ts:31</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/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"><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/942de1f/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/35be671/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"><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/942de1f/packages/search/lib/commands/SEARCH.ts#L15">search/lib/commands/SEARCH.ts:15</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/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">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -197,23 +199,23 @@
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module"><a href="commands_SEARCH.SearchOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Search<wbr/>Options</span></a>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#DIALECT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>DIALECT</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#EXPANDER" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>EXPANDER</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#HIGHLIGHT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>HIGHLIGHT</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INFIELDS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>INFIELDS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INKEYS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>INKEYS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INORDER" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>INORDER</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LANGUAGE" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LANGUAGE</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LIMIT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LIMIT</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#NOSTOPWORDS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>NOSTOPWORDS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#PARAMS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>PARAMS</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#RETURN" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>RETURN</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SCORER" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SCORER</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SLOP" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SLOP</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SORTBY" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SORTBY</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SUMMARIZE" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SUMMARIZE</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#VERBATIM" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>VERBATIM</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#WITHSORTKEYS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>WITHSORTKEYS</a></li></ul></li></ul></nav></div></div>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#DIALECT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>DIALECT?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#EXPANDER" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>EXPANDER?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#HIGHLIGHT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>HIGHLIGHT?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INFIELDS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>INFIELDS?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INKEYS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>INKEYS?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#INORDER" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>INORDER?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LANGUAGE" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LANGUAGE?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#LIMIT" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>LIMIT?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#NOSTOPWORDS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>NOSTOPWORDS?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#PARAMS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>PARAMS?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#RETURN" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>RETURN?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SCORER" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SCORER?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SLOP" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SLOP?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SORTBY" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SORTBY?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#SUMMARIZE" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>SUMMARIZE?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#VERBATIM" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>VERBATIM?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SEARCH.SearchOptions.html#WITHSORTKEYS" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>WITHSORTKEYS?</a></li></ul></li></ul></nav></div></div>
<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>

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">SugGetOptions</span></li></ul></section>
<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/35be671/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">
@@ -25,8 +27,8 @@
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="commands_SUGGET.SugGetOptions.html#FUZZY" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>FUZZY</span></a>
<a href="commands_SUGGET.SugGetOptions.html#MAX" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>MAX</span></a>
<div class="tsd-index-list"><a href="commands_SUGGET.SugGetOptions.html#FUZZY" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>FUZZY?</span></a>
<a href="commands_SUGGET.SugGetOptions.html#MAX" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>MAX?</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
@@ -34,12 +36,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/942de1f/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/35be671/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/942de1f/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/35be671/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">
@@ -100,8 +102,8 @@
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-module"><a href="commands_SUGGET.SugGetOptions.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>Sug<wbr/>Get<wbr/>Options</span></a>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SUGGET.SugGetOptions.html#FUZZY" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>FUZZY</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SUGGET.SugGetOptions.html#MAX" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>MAX</a></li></ul></li></ul></nav></div></div>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SUGGET.SugGetOptions.html#FUZZY" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>FUZZY?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands_SUGGET.SugGetOptions.html#MAX" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>MAX?</a></li></ul></li></ul></nav></div></div>
<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>

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">SuggestionWithPayload</span></li></ul></section>
<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/35be671/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">
@@ -34,12 +36,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/942de1f/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/35be671/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/942de1f/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/35be671/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">

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

@@ -17,7 +17,9 @@
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">SuggestionWithScores</span></li></ul></section>
<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/35be671/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">
@@ -34,12 +36,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/942de1f/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/35be671/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/942de1f/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/35be671/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">

2
documentation/search/modules.html
View File

@@ -9,7 +9,7 @@
<div class="container container-main">
<div class="col-8 col-content">
<div class="tsd-page-title">
<h2> @redis/search</h2></div>
<h2>@redis/search</h2></div>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<h3 class="tsd-index-heading uppercase">Index</h3>

6
documentation/search/modules/commands.html
View File

@@ -12,7 +12,11 @@
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="commands.html">commands</a></li></ul>
<h1>Module commands</h1></div>
<h1>Module commands</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/index.ts#L1">search/lib/commands/index.ts:1</a></li></ul></aside>
<section class="tsd-panel-group">
<section class="tsd-panel tsd-typography"></section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<h3 class="tsd-index-heading uppercase">Index</h3>

6
documentation/search/modules/commands_AGGREGATE.html
View File

@@ -12,7 +12,11 @@
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="commands_AGGREGATE.html">commands/AGGREGATE</a></li></ul>
<h1>Module commands/AGGREGATE</h1></div>
<h1>Module commands/AGGREGATE</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE.ts#L1">search/lib/commands/AGGREGATE.ts:1</a></li></ul></aside>
<section class="tsd-panel-group">
<section class="tsd-panel tsd-typography"></section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<h3 class="tsd-index-heading uppercase">Index</h3>

6
documentation/search/modules/commands_AGGREGATE_WITHCURSOR.html
View File

@@ -12,7 +12,11 @@
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="commands_AGGREGATE_WITHCURSOR.html">commands/AGGREGATE_WITHCURSOR</a></li></ul>
<h1>Module commands/AGGREGATE_WITHCURSOR</h1></div>
<h1>Module commands/AGGREGATE_WITHCURSOR</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/AGGREGATE_WITHCURSOR.ts#L1">search/lib/commands/AGGREGATE_WITHCURSOR.ts:1</a></li></ul></aside>
<section class="tsd-panel-group">
<section class="tsd-panel tsd-typography"></section></section>
<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">

6
documentation/search/modules/commands_ALIASADD.html
View File

@@ -12,7 +12,11 @@
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="commands_ALIASADD.html">commands/ALIASADD</a></li></ul>
<h1>Module commands/ALIASADD</h1></div>
<h1>Module commands/ALIASADD</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASADD.ts#L1">search/lib/commands/ALIASADD.ts:1</a></li></ul></aside>
<section class="tsd-panel-group">
<section class="tsd-panel tsd-typography"></section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<h3 class="tsd-index-heading uppercase">Index</h3>

6
documentation/search/modules/commands_ALIASDEL.html
View File

@@ -12,7 +12,11 @@
<ul class="tsd-breadcrumb">
<li><a href="../modules.html">@redis/search</a></li>
<li><a href="commands_ALIASDEL.html">commands/ALIASDEL</a></li></ul>
<h1>Module commands/ALIASDEL</h1></div>
<h1>Module commands/ALIASDEL</h1></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/redis/node-redis/blob/35be671/packages/search/lib/commands/ALIASDEL.ts#L1">search/lib/commands/ALIASDEL.ts:1</a></li></ul></aside>
<section class="tsd-panel-group">
<section class="tsd-panel tsd-typography"></section></section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<h3 class="tsd-index-heading uppercase">Index</h3>

Some files were not shown because too many files have changed in this diff Show More