1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-10 11:43:01 +03:00
Files
node-redis/documentation/search/modules/commands_INFO.html
documentation-bot c0c733e606 Updates
2021-12-19 02:43:19 +00:00

1 line
9.5 KiB
HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>commands/INFO | @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_INFO.html">commands/INFO</a></li></ul><h1>Module commands/INFO</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>Functions</h3><ul class="tsd-index-list"><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands_INFO.html#transformArguments" class="tsd-kind-icon">transform<wbr/>Arguments</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands_INFO.html#transformReply" class="tsd-kind-icon">transform<wbr/>Reply</a></li></ul></section></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="transformArguments" class="tsd-anchor"></a><h3>transform<wbr/>Arguments</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/2733e22/packages/search/lib/commands/INFO.ts#L1">search/lib/commands/INFO.ts:1</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>index: <span class="tsd-signature-type">string</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"><a id="transformReply" class="tsd-anchor"></a><h3>transform<wbr/>Reply</h3><ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"><li class="tsd-signature tsd-kind-icon">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-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/2733e22/packages/search/lib/commands/INFO.ts#L128">search/lib/commands/INFO.ts:128</a></li></ul></aside><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>rawReply: <span class="tsd-signature-type">InfoRawReply</span></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">InfoReply</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=" 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="current 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-function tsd-parent-kind-module"><a href="commands_INFO.html#transformArguments" class="tsd-kind-icon">transform<wbr/>Arguments</a></li><li class="tsd-kind-function tsd-parent-kind-module"><a href="commands_INFO.html#transformReply" class="tsd-kind-icon">transform<wbr/>Reply</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>