You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-10 11:43:01 +03:00
1 line
51 KiB
HTML
1 line
51 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>commands | @node-redis/search</title><meta name="description" content="Documentation for @node-redis/search"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@node-redis/search</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@node-redis/search</a></li><li><a href="commands.html">commands</a></li></ul><h1>Module commands</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Enumerations</h3><ul class="tsd-index-list"><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/commands.RedisSearchLanguages.html" class="tsd-kind-icon">Redis<wbr/>Search<wbr/>Languages</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/commands.SchemaFieldTypes.html" class="tsd-kind-icon">Schema<wbr/>Field<wbr/>Types</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/commands.SchemaTextFieldPhonetics.html" class="tsd-kind-icon">Schema<wbr/>Text<wbr/>Field<wbr/>Phonetics</a></li></ul></section><section class="tsd-index-section "><h3>Interfaces</h3><ul class="tsd-index-list"><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.CreateSchema.html" class="tsd-kind-icon">Create<wbr/>Schema</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.ProfileOptions.html" class="tsd-kind-icon">Profile<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.ProfileReply.html" class="tsd-kind-icon">Profile<wbr/>Reply</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.SearchReply.html" class="tsd-kind-icon">Search<wbr/>Reply</a></li></ul></section><section class="tsd-index-section "><h3>Type aliases</h3><ul class="tsd-index-list"><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="commands.html#ProfileRawReply" class="tsd-kind-icon">Profile<wbr/>Raw<wbr/>Reply</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="commands.html#PropertyName" class="tsd-kind-icon">Property<wbr/>Name</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="commands.html#SortByProperty" class="tsd-kind-icon">Sort<wbr/>By<wbr/>Property</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-module"><a href="commands.html#default" class="tsd-kind-icon">default</a></li></ul></section><section class="tsd-index-section "><h3>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushArgumentsWithLength" class="tsd-kind-icon">push<wbr/>Arguments<wbr/>With<wbr/>Length</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSchema" class="tsd-kind-icon">push<wbr/>Schema</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSearchOptions" class="tsd-kind-icon">push<wbr/>Search<wbr/>Options</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSortByArguments" class="tsd-kind-icon">push<wbr/>Sort<wbr/>By<wbr/>Arguments</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSortByProperty" class="tsd-kind-icon">push<wbr/>Sort<wbr/>By<wbr/>Property</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#transformProfile" class="tsd-kind-icon">transform<wbr/>Profile</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Type aliases</h2><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a id="ProfileRawReply" class="tsd-anchor"></a><h3>Profile<wbr/>Raw<wbr/>Reply</h3><div class="tsd-signature tsd-kind-icon">Profile<wbr/>Raw<wbr/>Reply<span class="tsd-signature-symbol"><</span><span class="tsd-signature-type" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">></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" data-tsd-kind="Type parameter">T</span><span class="tsd-signature-symbol">, </span>profile<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>TotalProfileTime<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>ParsingTime<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>PipelineCreationTime<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>IteratorsProfile<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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/packages/search/lib/commands/index.ts#L404">search/lib/commands/index.ts:404</a></li></ul></aside><h4 class="tsd-type-parameters-title">Type parameters</h4><ul class="tsd-type-parameters"><li><h4>T</h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"><a id="PropertyName" class="tsd-anchor"></a><h3>Property<wbr/>Name</h3><div class="tsd-signature tsd-kind-icon">Property<wbr/>Name<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">"$."</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><span class="tsd-signature-symbol">`</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/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-type-alias tsd-parent-kind-module"><a id="SortByProperty" class="tsd-anchor"></a><h3>Sort<wbr/>By<wbr/>Property</h3><div class="tsd-signature tsd-kind-icon">Sort<wbr/>By<wbr/>Property<span class="tsd-signature-symbol">:</span> <a href="commands.html#PropertyName" class="tsd-signature-type" data-tsd-kind="Type alias">PropertyName</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>BY<span class="tsd-signature-symbol">: </span><a href="commands.html#PropertyName" class="tsd-signature-type" data-tsd-kind="Type alias">PropertyName</a><span class="tsd-signature-symbol">; </span>DIRECTION<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"ASC"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"DESC"</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/b68836c/packages/search/lib/commands/index.ts#L128">search/lib/commands/index.ts:128</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-module"><a id="default" class="tsd-anchor"></a><h3>default</h3><div class="tsd-signature tsd-kind-icon">default<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>AGGREGATE<span class="tsd-signature-symbol">: </span><a href="commands_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/AGGREGATE</a><span class="tsd-signature-symbol">; </span>ALIASADD<span class="tsd-signature-symbol">: </span><a href="commands_ALIASADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASADD</a><span class="tsd-signature-symbol">; </span>ALIASDEL<span class="tsd-signature-symbol">: </span><a href="commands_ALIASDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASDEL</a><span class="tsd-signature-symbol">; </span>ALIASUPDATE<span class="tsd-signature-symbol">: </span><a href="commands_ALIASUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASUPDATE</a><span class="tsd-signature-symbol">; </span>ALTER<span class="tsd-signature-symbol">: </span><a href="commands_ALTER.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALTER</a><span class="tsd-signature-symbol">; </span>CONFIG_GET<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_GET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_GET</a><span class="tsd-signature-symbol">; </span>CONFIG_SET<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_SET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_SET</a><span class="tsd-signature-symbol">; </span>CREATE<span class="tsd-signature-symbol">: </span><a href="commands_CREATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CREATE</a><span class="tsd-signature-symbol">; </span>DICTADD<span class="tsd-signature-symbol">: </span><a href="commands_DICTADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTADD</a><span class="tsd-signature-symbol">; </span>DICTDEL<span class="tsd-signature-symbol">: </span><a href="commands_DICTDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDEL</a><span class="tsd-signature-symbol">; </span>DICTDUMP<span class="tsd-signature-symbol">: </span><a href="commands_DICTDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDUMP</a><span class="tsd-signature-symbol">; </span>DROPINDEX<span class="tsd-signature-symbol">: </span><a href="commands_DROPINDEX.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DROPINDEX</a><span class="tsd-signature-symbol">; </span>EXPLAIN<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAIN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAIN</a><span class="tsd-signature-symbol">; </span>EXPLAINCLI<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAINCLI.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAINCLI</a><span class="tsd-signature-symbol">; </span>INFO<span class="tsd-signature-symbol">: </span><a href="commands_INFO.html" class="tsd-signature-type" data-tsd-kind="Module">commands/INFO</a><span class="tsd-signature-symbol">; </span>PROFILEAGGREGATE<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_AGGREGATE</a><span class="tsd-signature-symbol">; </span>PROFILESEARCH<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_SEARCH</a><span class="tsd-signature-symbol">; </span>SEARCH<span class="tsd-signature-symbol">: </span><a href="commands_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SEARCH</a><span class="tsd-signature-symbol">; </span>SPELLCHECK<span class="tsd-signature-symbol">: </span><a href="commands_SPELLCHECK.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SPELLCHECK</a><span class="tsd-signature-symbol">; </span>SUGADD<span class="tsd-signature-symbol">: </span><a href="commands_SUGADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGADD</a><span class="tsd-signature-symbol">; </span>SUGDEL<span class="tsd-signature-symbol">: </span><a href="commands_SUGDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGDEL</a><span class="tsd-signature-symbol">; </span>SUGGET<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET</a><span class="tsd-signature-symbol">; </span>SUGGET_WITHPAYLOADS<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHPAYLOADS</a><span class="tsd-signature-symbol">; </span>SUGGET_WITHSCORES<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES</a><span class="tsd-signature-symbol">; </span>SUGGET_WITHSCORES_WITHPAYLOADS<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES_WITHPAYLOADS</a><span class="tsd-signature-symbol">; </span>SUGLEN<span class="tsd-signature-symbol">: </span><a href="commands_SUGLEN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGLEN</a><span class="tsd-signature-symbol">; </span>SYNDUMP<span class="tsd-signature-symbol">: </span><a href="commands_SYNDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNDUMP</a><span class="tsd-signature-symbol">; </span>SYNUPDATE<span class="tsd-signature-symbol">: </span><a href="commands_SYNUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNUPDATE</a><span class="tsd-signature-symbol">; </span>TAGVALS<span class="tsd-signature-symbol">: </span><a href="commands_TAGVALS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/TAGVALS</a><span class="tsd-signature-symbol">; </span>_LIST<span class="tsd-signature-symbol">: </span><a href="commands__LIST.html" class="tsd-signature-type" data-tsd-kind="Module">commands/_LIST</a><span class="tsd-signature-symbol">; </span>_list<span class="tsd-signature-symbol">: </span><a href="commands__LIST.html" class="tsd-signature-type" data-tsd-kind="Module">commands/_LIST</a><span class="tsd-signature-symbol">; </span>aggregate<span class="tsd-signature-symbol">: </span><a href="commands_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/AGGREGATE</a><span class="tsd-signature-symbol">; </span>aliasAdd<span class="tsd-signature-symbol">: </span><a href="commands_ALIASADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASADD</a><span class="tsd-signature-symbol">; </span>aliasDel<span class="tsd-signature-symbol">: </span><a href="commands_ALIASDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASDEL</a><span class="tsd-signature-symbol">; </span>aliasUpdate<span class="tsd-signature-symbol">: </span><a href="commands_ALIASUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASUPDATE</a><span class="tsd-signature-symbol">; </span>alter<span class="tsd-signature-symbol">: </span><a href="commands_ALTER.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALTER</a><span class="tsd-signature-symbol">; </span>configGet<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_GET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_GET</a><span class="tsd-signature-symbol">; </span>configSet<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_SET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_SET</a><span class="tsd-signature-symbol">; </span>create<span class="tsd-signature-symbol">: </span><a href="commands_CREATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CREATE</a><span class="tsd-signature-symbol">; </span>dictAdd<span class="tsd-signature-symbol">: </span><a href="commands_DICTADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTADD</a><span class="tsd-signature-symbol">; </span>dictDel<span class="tsd-signature-symbol">: </span><a href="commands_DICTDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDEL</a><span class="tsd-signature-symbol">; </span>dictDump<span class="tsd-signature-symbol">: </span><a href="commands_DICTDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDUMP</a><span class="tsd-signature-symbol">; </span>dropIndex<span class="tsd-signature-symbol">: </span><a href="commands_DROPINDEX.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DROPINDEX</a><span class="tsd-signature-symbol">; </span>explain<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAIN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAIN</a><span class="tsd-signature-symbol">; </span>explainCli<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAINCLI.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAINCLI</a><span class="tsd-signature-symbol">; </span>info<span class="tsd-signature-symbol">: </span><a href="commands_INFO.html" class="tsd-signature-type" data-tsd-kind="Module">commands/INFO</a><span class="tsd-signature-symbol">; </span>profileAggregate<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_AGGREGATE</a><span class="tsd-signature-symbol">; </span>profileSearch<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_SEARCH</a><span class="tsd-signature-symbol">; </span>search<span class="tsd-signature-symbol">: </span><a href="commands_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SEARCH</a><span class="tsd-signature-symbol">; </span>spellCheck<span class="tsd-signature-symbol">: </span><a href="commands_SPELLCHECK.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SPELLCHECK</a><span class="tsd-signature-symbol">; </span>sugAdd<span class="tsd-signature-symbol">: </span><a href="commands_SUGADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGADD</a><span class="tsd-signature-symbol">; </span>sugDel<span class="tsd-signature-symbol">: </span><a href="commands_SUGDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGDEL</a><span class="tsd-signature-symbol">; </span>sugGet<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET</a><span class="tsd-signature-symbol">; </span>sugGetWithPayloads<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHPAYLOADS</a><span class="tsd-signature-symbol">; </span>sugGetWithScores<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES</a><span class="tsd-signature-symbol">; </span>sugGetWithScoresWithPayloads<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES_WITHPAYLOADS</a><span class="tsd-signature-symbol">; </span>sugLen<span class="tsd-signature-symbol">: </span><a href="commands_SUGLEN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGLEN</a><span class="tsd-signature-symbol">; </span>synDump<span class="tsd-signature-symbol">: </span><a href="commands_SYNDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNDUMP</a><span class="tsd-signature-symbol">; </span>synUpdate<span class="tsd-signature-symbol">: </span><a href="commands_SYNUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNUPDATE</a><span class="tsd-signature-symbol">; </span>tagVals<span class="tsd-signature-symbol">: </span><a href="commands_TAGVALS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/TAGVALS</a><span class="tsd-signature-symbol"> }</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>AGGREGATE<span class="tsd-signature-symbol">: </span><a href="commands_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/AGGREGATE</a></h5></li><li class="tsd-parameter"><h5>ALIASADD<span class="tsd-signature-symbol">: </span><a href="commands_ALIASADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASADD</a></h5></li><li class="tsd-parameter"><h5>ALIASDEL<span class="tsd-signature-symbol">: </span><a href="commands_ALIASDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASDEL</a></h5></li><li class="tsd-parameter"><h5>ALIASUPDATE<span class="tsd-signature-symbol">: </span><a href="commands_ALIASUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASUPDATE</a></h5></li><li class="tsd-parameter"><h5>ALTER<span class="tsd-signature-symbol">: </span><a href="commands_ALTER.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALTER</a></h5></li><li class="tsd-parameter"><h5>CONFIG_<wbr/>GET<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_GET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_GET</a></h5></li><li class="tsd-parameter"><h5>CONFIG_<wbr/>SET<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_SET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_SET</a></h5></li><li class="tsd-parameter"><h5>CREATE<span class="tsd-signature-symbol">: </span><a href="commands_CREATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CREATE</a></h5></li><li class="tsd-parameter"><h5>DICTADD<span class="tsd-signature-symbol">: </span><a href="commands_DICTADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTADD</a></h5></li><li class="tsd-parameter"><h5>DICTDEL<span class="tsd-signature-symbol">: </span><a href="commands_DICTDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDEL</a></h5></li><li class="tsd-parameter"><h5>DICTDUMP<span class="tsd-signature-symbol">: </span><a href="commands_DICTDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDUMP</a></h5></li><li class="tsd-parameter"><h5>DROPINDEX<span class="tsd-signature-symbol">: </span><a href="commands_DROPINDEX.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DROPINDEX</a></h5></li><li class="tsd-parameter"><h5>EXPLAIN<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAIN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAIN</a></h5></li><li class="tsd-parameter"><h5>EXPLAINCLI<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAINCLI.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAINCLI</a></h5></li><li class="tsd-parameter"><h5>INFO<span class="tsd-signature-symbol">: </span><a href="commands_INFO.html" class="tsd-signature-type" data-tsd-kind="Module">commands/INFO</a></h5></li><li class="tsd-parameter"><h5>PROFILEAGGREGATE<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_AGGREGATE</a></h5></li><li class="tsd-parameter"><h5>PROFILESEARCH<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_SEARCH</a></h5></li><li class="tsd-parameter"><h5>SEARCH<span class="tsd-signature-symbol">: </span><a href="commands_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SEARCH</a></h5></li><li class="tsd-parameter"><h5>SPELLCHECK<span class="tsd-signature-symbol">: </span><a href="commands_SPELLCHECK.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SPELLCHECK</a></h5></li><li class="tsd-parameter"><h5>SUGADD<span class="tsd-signature-symbol">: </span><a href="commands_SUGADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGADD</a></h5></li><li class="tsd-parameter"><h5>SUGDEL<span class="tsd-signature-symbol">: </span><a href="commands_SUGDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGDEL</a></h5></li><li class="tsd-parameter"><h5>SUGGET<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET</a></h5></li><li class="tsd-parameter"><h5>SUGGET_<wbr/>WITHPAYLOADS<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHPAYLOADS</a></h5></li><li class="tsd-parameter"><h5>SUGGET_<wbr/>WITHSCORES<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES</a></h5></li><li class="tsd-parameter"><h5>SUGGET_<wbr/>WITHSCORES_<wbr/>WITHPAYLOADS<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES_WITHPAYLOADS</a></h5></li><li class="tsd-parameter"><h5>SUGLEN<span class="tsd-signature-symbol">: </span><a href="commands_SUGLEN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGLEN</a></h5></li><li class="tsd-parameter"><h5>SYNDUMP<span class="tsd-signature-symbol">: </span><a href="commands_SYNDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNDUMP</a></h5></li><li class="tsd-parameter"><h5>SYNUPDATE<span class="tsd-signature-symbol">: </span><a href="commands_SYNUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNUPDATE</a></h5></li><li class="tsd-parameter"><h5>TAGVALS<span class="tsd-signature-symbol">: </span><a href="commands_TAGVALS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/TAGVALS</a></h5></li><li class="tsd-parameter"><h5>_LIST<span class="tsd-signature-symbol">: </span><a href="commands__LIST.html" class="tsd-signature-type" data-tsd-kind="Module">commands/_LIST</a></h5></li><li class="tsd-parameter"><h5>_list<span class="tsd-signature-symbol">: </span><a href="commands__LIST.html" class="tsd-signature-type" data-tsd-kind="Module">commands/_LIST</a></h5></li><li class="tsd-parameter"><h5>aggregate<span class="tsd-signature-symbol">: </span><a href="commands_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/AGGREGATE</a></h5></li><li class="tsd-parameter"><h5>alias<wbr/>Add<span class="tsd-signature-symbol">: </span><a href="commands_ALIASADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASADD</a></h5></li><li class="tsd-parameter"><h5>alias<wbr/>Del<span class="tsd-signature-symbol">: </span><a href="commands_ALIASDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASDEL</a></h5></li><li class="tsd-parameter"><h5>alias<wbr/>Update<span class="tsd-signature-symbol">: </span><a href="commands_ALIASUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALIASUPDATE</a></h5></li><li class="tsd-parameter"><h5>alter<span class="tsd-signature-symbol">: </span><a href="commands_ALTER.html" class="tsd-signature-type" data-tsd-kind="Module">commands/ALTER</a></h5></li><li class="tsd-parameter"><h5>config<wbr/>Get<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_GET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_GET</a></h5></li><li class="tsd-parameter"><h5>config<wbr/>Set<span class="tsd-signature-symbol">: </span><a href="commands_CONFIG_SET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CONFIG_SET</a></h5></li><li class="tsd-parameter"><h5>create<span class="tsd-signature-symbol">: </span><a href="commands_CREATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/CREATE</a></h5></li><li class="tsd-parameter"><h5>dict<wbr/>Add<span class="tsd-signature-symbol">: </span><a href="commands_DICTADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTADD</a></h5></li><li class="tsd-parameter"><h5>dict<wbr/>Del<span class="tsd-signature-symbol">: </span><a href="commands_DICTDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDEL</a></h5></li><li class="tsd-parameter"><h5>dict<wbr/>Dump<span class="tsd-signature-symbol">: </span><a href="commands_DICTDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DICTDUMP</a></h5></li><li class="tsd-parameter"><h5>drop<wbr/>Index<span class="tsd-signature-symbol">: </span><a href="commands_DROPINDEX.html" class="tsd-signature-type" data-tsd-kind="Module">commands/DROPINDEX</a></h5></li><li class="tsd-parameter"><h5>explain<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAIN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAIN</a></h5></li><li class="tsd-parameter"><h5>explain<wbr/>Cli<span class="tsd-signature-symbol">: </span><a href="commands_EXPLAINCLI.html" class="tsd-signature-type" data-tsd-kind="Module">commands/EXPLAINCLI</a></h5></li><li class="tsd-parameter"><h5>info<span class="tsd-signature-symbol">: </span><a href="commands_INFO.html" class="tsd-signature-type" data-tsd-kind="Module">commands/INFO</a></h5></li><li class="tsd-parameter"><h5>profile<wbr/>Aggregate<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_AGGREGATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_AGGREGATE</a></h5></li><li class="tsd-parameter"><h5>profile<wbr/>Search<span class="tsd-signature-symbol">: </span><a href="commands_PROFILE_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/PROFILE_SEARCH</a></h5></li><li class="tsd-parameter"><h5>search<span class="tsd-signature-symbol">: </span><a href="commands_SEARCH.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SEARCH</a></h5></li><li class="tsd-parameter"><h5>spell<wbr/>Check<span class="tsd-signature-symbol">: </span><a href="commands_SPELLCHECK.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SPELLCHECK</a></h5></li><li class="tsd-parameter"><h5>sug<wbr/>Add<span class="tsd-signature-symbol">: </span><a href="commands_SUGADD.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGADD</a></h5></li><li class="tsd-parameter"><h5>sug<wbr/>Del<span class="tsd-signature-symbol">: </span><a href="commands_SUGDEL.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGDEL</a></h5></li><li class="tsd-parameter"><h5>sug<wbr/>Get<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET</a></h5></li><li class="tsd-parameter"><h5>sug<wbr/>Get<wbr/>With<wbr/>Payloads<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHPAYLOADS</a></h5></li><li class="tsd-parameter"><h5>sug<wbr/>Get<wbr/>With<wbr/>Scores<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES</a></h5></li><li class="tsd-parameter"><h5>sug<wbr/>Get<wbr/>With<wbr/>Scores<wbr/>With<wbr/>Payloads<span class="tsd-signature-symbol">: </span><a href="commands_SUGGET_WITHSCORES_WITHPAYLOADS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGGET_WITHSCORES_WITHPAYLOADS</a></h5></li><li class="tsd-parameter"><h5>sug<wbr/>Len<span class="tsd-signature-symbol">: </span><a href="commands_SUGLEN.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SUGLEN</a></h5></li><li class="tsd-parameter"><h5>syn<wbr/>Dump<span class="tsd-signature-symbol">: </span><a href="commands_SYNDUMP.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNDUMP</a></h5></li><li class="tsd-parameter"><h5>syn<wbr/>Update<span class="tsd-signature-symbol">: </span><a href="commands_SYNUPDATE.html" class="tsd-signature-type" data-tsd-kind="Module">commands/SYNUPDATE</a></h5></li><li class="tsd-parameter"><h5>tag<wbr/>Vals<span class="tsd-signature-symbol">: </span><a href="commands_TAGVALS.html" class="tsd-signature-type" data-tsd-kind="Module">commands/TAGVALS</a></h5></li></ul></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Functions</h2><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="pushArgumentsWithLength" class="tsd-anchor"></a><h3>push<wbr/>Arguments<wbr/>With<wbr/>Length</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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>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><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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/packages/search/lib/commands/index.ts#L164">search/lib/commands/index.ts:164</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li><li><h5>fn: <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></h5><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures tsd-kind-type-literal"><li class="tsd-signature tsd-kind-icon"><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-description"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="pushSchema" class="tsd-anchor"></a><h3>push<wbr/>Schema</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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.CreateSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateSchema</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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/packages/search/lib/commands/index.ts#L215">search/lib/commands/index.ts:215</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li><li><h5>schema: <a href="../interfaces/commands.CreateSchema.html" class="tsd-signature-type" data-tsd-kind="Interface">CreateSchema</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="pushSearchOptions" class="tsd-anchor"></a><h3>push<wbr/>Search<wbr/>Options</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/packages/search/lib/commands/index.ts#L276">search/lib/commands/index.ts:276</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li><li><h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/commands_SEARCH.SearchOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SearchOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="pushSortByArguments" class="tsd-anchor"></a><h3>push<wbr/>Sort<wbr/>By<wbr/>Arguments</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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="commands.html#SortByProperty" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol"> | </span><a href="commands.html#SortByProperty" 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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/packages/search/lib/commands/index.ts#L145">search/lib/commands/index.ts:145</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li><li><h5>name: <span class="tsd-signature-type">string</span></h5></li><li><h5>sortBy: <a href="commands.html#SortByProperty" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol"> | </span><a href="commands.html#SortByProperty" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RedisCommandArguments</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="pushSortByProperty" class="tsd-anchor"></a><h3>push<wbr/>Sort<wbr/>By<wbr/>Property</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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="commands.html#SortByProperty" 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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/packages/search/lib/commands/index.ts#L133">search/lib/commands/index.ts:133</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>args: <span class="tsd-signature-type">RedisCommandArguments</span></h5></li><li><h5>sortBy: <a href="commands.html#SortByProperty" class="tsd-signature-type" data-tsd-kind="Type alias">SortByProperty</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="transformProfile" class="tsd-anchor"></a><h3>transform<wbr/>Profile</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/b68836c/packages/search/lib/commands/index.ts#L447">search/lib/commands/index.ts:447</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>reply: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ProfileData</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="commands.html">commands</a></li><li class=" tsd-kind-module"><a href="commands_AGGREGATE.html">commands/AGGREGATE</a></li><li class=" tsd-kind-module"><a href="commands_ALIASADD.html">commands/ALIASADD</a></li><li class=" tsd-kind-module"><a href="commands_ALIASDEL.html">commands/ALIASDEL</a></li><li class=" tsd-kind-module"><a href="commands_ALIASUPDATE.html">commands/ALIASUPDATE</a></li><li class=" tsd-kind-module"><a href="commands_ALTER.html">commands/ALTER</a></li><li class=" tsd-kind-module"><a href="commands_CONFIG_GET.html">commands/CONFIG_<wbr/>GET</a></li><li class=" tsd-kind-module"><a href="commands_CONFIG_SET.html">commands/CONFIG_<wbr/>SET</a></li><li class=" tsd-kind-module"><a href="commands_CREATE.html">commands/CREATE</a></li><li class=" tsd-kind-module"><a href="commands_DICTADD.html">commands/DICTADD</a></li><li class=" tsd-kind-module"><a href="commands_DICTDEL.html">commands/DICTDEL</a></li><li class=" tsd-kind-module"><a href="commands_DICTDUMP.html">commands/DICTDUMP</a></li><li class=" tsd-kind-module"><a href="commands_DROPINDEX.html">commands/DROPINDEX</a></li><li class=" tsd-kind-module"><a href="commands_EXPLAIN.html">commands/EXPLAIN</a></li><li class=" tsd-kind-module"><a href="commands_EXPLAINCLI.html">commands/EXPLAINCLI</a></li><li class=" tsd-kind-module"><a href="commands_INFO.html">commands/INFO</a></li><li class=" tsd-kind-module"><a href="commands_PROFILE_AGGREGATE.html">commands/PROFILE_<wbr/>AGGREGATE</a></li><li class=" tsd-kind-module"><a href="commands_PROFILE_SEARCH.html">commands/PROFILE_<wbr/>SEARCH</a></li><li class=" tsd-kind-module"><a href="commands_SEARCH.html">commands/SEARCH</a></li><li class=" tsd-kind-module"><a href="commands_SPELLCHECK.html">commands/SPELLCHECK</a></li><li class=" tsd-kind-module"><a href="commands_SUGADD.html">commands/SUGADD</a></li><li class=" tsd-kind-module"><a href="commands_SUGDEL.html">commands/SUGDEL</a></li><li class=" tsd-kind-module"><a href="commands_SUGGET.html">commands/SUGGET</a></li><li class=" tsd-kind-module"><a href="commands_SUGGET_WITHPAYLOADS.html">commands/SUGGET_<wbr/>WITHPAYLOADS</a></li><li class=" tsd-kind-module"><a href="commands_SUGGET_WITHSCORES.html">commands/SUGGET_<wbr/>WITHSCORES</a></li><li class=" tsd-kind-module"><a href="commands_SUGGET_WITHSCORES_WITHPAYLOADS.html">commands/SUGGET_<wbr/>WITHSCORES_<wbr/>WITHPAYLOADS</a></li><li class=" tsd-kind-module"><a href="commands_SUGLEN.html">commands/SUGLEN</a></li><li class=" tsd-kind-module"><a href="commands_SYNDUMP.html">commands/SYNDUMP</a></li><li class=" tsd-kind-module"><a href="commands_SYNUPDATE.html">commands/SYNUPDATE</a></li><li class=" tsd-kind-module"><a href="commands_TAGVALS.html">commands/TAGVALS</a></li><li class=" tsd-kind-module"><a href="commands__LIST.html">commands/_<wbr/>LIST</a></li><li class=" tsd-kind-module"><a href="index.html">index</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/commands.RedisSearchLanguages.html" class="tsd-kind-icon">Redis<wbr/>Search<wbr/>Languages</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/commands.SchemaFieldTypes.html" class="tsd-kind-icon">Schema<wbr/>Field<wbr/>Types</a></li><li class="tsd-kind-enum tsd-parent-kind-module"><a href="../enums/commands.SchemaTextFieldPhonetics.html" class="tsd-kind-icon">Schema<wbr/>Text<wbr/>Field<wbr/>Phonetics</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.CreateSchema.html" class="tsd-kind-icon">Create<wbr/>Schema</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.ProfileOptions.html" class="tsd-kind-icon">Profile<wbr/>Options</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.ProfileReply.html" class="tsd-kind-icon">Profile<wbr/>Reply</a></li><li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/commands.SearchReply.html" class="tsd-kind-icon">Search<wbr/>Reply</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"><a href="commands.html#ProfileRawReply" class="tsd-kind-icon">Profile<wbr/>Raw<wbr/>Reply</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="commands.html#PropertyName" class="tsd-kind-icon">Property<wbr/>Name</a></li><li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="commands.html#SortByProperty" class="tsd-kind-icon">Sort<wbr/>By<wbr/>Property</a></li><li class="tsd-kind-property tsd-parent-kind-module"><a href="commands.html#default" class="tsd-kind-icon">default</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushArgumentsWithLength" class="tsd-kind-icon">push<wbr/>Arguments<wbr/>With<wbr/>Length</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSchema" class="tsd-kind-icon">push<wbr/>Schema</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSearchOptions" class="tsd-kind-icon">push<wbr/>Search<wbr/>Options</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSortByArguments" class="tsd-kind-icon">push<wbr/>Sort<wbr/>By<wbr/>Arguments</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#pushSortByProperty" class="tsd-kind-icon">push<wbr/>Sort<wbr/>By<wbr/>Property</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands.html#transformProfile" class="tsd-kind-icon">transform<wbr/>Profile</a></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li><li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |