1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-10 11:43:01 +03:00
Files
node-redis/documentation/time-series/interfaces/commands.MRangeWithLabelsOptions.html
documentation-bot c78d813784 Updates
2022-01-15 16:54:17 +00:00

1 line
16 KiB
HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MRangeWithLabelsOptions | @node-redis/time-series</title><meta name="description" content="Documentation for @node-redis/time-series"/><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/time-series</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/time-series</a></li><li><a href="../modules/commands.html">commands</a></li><li><a href="commands.MRangeWithLabelsOptions.html">MRangeWithLabelsOptions</a></li></ul><h1>Interface MRangeWithLabelsOptions</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="commands.MRangeOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MRangeOptions</a><ul class="tsd-hierarchy"><li><span class="target">MRangeWithLabelsOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#AGGREGATION" class="tsd-kind-icon">AGGREGATION</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#ALIGN" class="tsd-kind-icon">ALIGN</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#COUNT" class="tsd-kind-icon">COUNT</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#FILTER_BY_TS" class="tsd-kind-icon">FILTER_<wbr/>BY_<wbr/>TS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#FILTER_BY_VALUE" class="tsd-kind-icon">FILTER_<wbr/>BY_<wbr/>VALUE</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#GROUPBY" class="tsd-kind-icon">GROUPBY</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands.MRangeWithLabelsOptions.html#SELECTED_LABELS" class="tsd-kind-icon">SELECTED_<wbr/>LABELS</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="AGGREGATION" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> AGGREGATION</h3><div class="tsd-signature tsd-kind-icon">AGGREGATION<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>timeBucket<span class="tsd-signature-symbol">: </span><a href="../modules/commands.html#Timestamp" class="tsd-signature-type" data-tsd-kind="Type alias">Timestamp</a><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><a href="../enums/commands.TimeSeriesAggregationType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TimeSeriesAggregationType</a><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><p>Inherited from <a href="commands.MRangeOptions.html">MRangeOptions</a>.<a href="commands.MRangeOptions.html#AGGREGATION">AGGREGATION</a></p><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/06cb637/packages/time-series/lib/commands/index.ts#L237">commands/index.ts:237</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>time<wbr/>Bucket<span class="tsd-signature-symbol">: </span><a href="../modules/commands.html#Timestamp" class="tsd-signature-type" data-tsd-kind="Type alias">Timestamp</a></h5></li><li class="tsd-parameter"><h5>type<span class="tsd-signature-symbol">: </span><a href="../enums/commands.TimeSeriesAggregationType.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TimeSeriesAggregationType</a></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="ALIGN" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> ALIGN</h3><div class="tsd-signature tsd-kind-icon">ALIGN<span class="tsd-signature-symbol">?:</span> <a href="../modules/commands.html#Timestamp" class="tsd-signature-type" data-tsd-kind="Type alias">Timestamp</a></div><aside class="tsd-sources"><p>Inherited from <a href="commands.MRangeOptions.html">MRangeOptions</a>.<a href="commands.MRangeOptions.html#ALIGN">ALIGN</a></p><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/06cb637/packages/time-series/lib/commands/index.ts#L236">commands/index.ts:236</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="COUNT" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> COUNT</h3><div class="tsd-signature tsd-kind-icon">COUNT<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><p>Inherited from <a href="commands.MRangeOptions.html">MRangeOptions</a>.<a href="commands.MRangeOptions.html#COUNT">COUNT</a></p><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/06cb637/packages/time-series/lib/commands/index.ts#L235">commands/index.ts:235</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="FILTER_BY_TS" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> FILTER_<wbr/>BY_<wbr/>TS</h3><div class="tsd-signature tsd-kind-icon">FILTER_<wbr/>BY_<wbr/>TS<span class="tsd-signature-symbol">?:</span> <a href="../modules/commands.html#Timestamp" class="tsd-signature-type" data-tsd-kind="Type alias">Timestamp</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><p>Inherited from <a href="commands.MRangeOptions.html">MRangeOptions</a>.<a href="commands.MRangeOptions.html#FILTER_BY_TS">FILTER_BY_TS</a></p><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/06cb637/packages/time-series/lib/commands/index.ts#L230">commands/index.ts:230</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="FILTER_BY_VALUE" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> FILTER_<wbr/>BY_<wbr/>VALUE</h3><div class="tsd-signature tsd-kind-icon">FILTER_<wbr/>BY_<wbr/>VALUE<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{ </span>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> }</span></div><aside class="tsd-sources"><p>Inherited from <a href="commands.MRangeOptions.html">MRangeOptions</a>.<a href="commands.MRangeOptions.html#FILTER_BY_VALUE">FILTER_BY_VALUE</a></p><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/06cb637/packages/time-series/lib/commands/index.ts#L231">commands/index.ts:231</a></li></ul></aside><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5>max<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li><li class="tsd-parameter"><h5>min<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5></li></ul></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="GROUPBY" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> GROUPBY</h3><div class="tsd-signature tsd-kind-icon">GROUPBY<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">MRangeGroupBy</span></div><aside class="tsd-sources"><p>Inherited from <a href="commands.MRangeOptions.html">MRangeOptions</a>.<a href="commands.MRangeOptions.html#GROUPBY">GROUPBY</a></p><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/06cb637/packages/time-series/lib/commands/index.ts#L321">commands/index.ts:321</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="SELECTED_LABELS" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> SELECTED_<wbr/>LABELS</h3><div class="tsd-signature tsd-kind-icon">SELECTED_<wbr/>LABELS<span class="tsd-signature-symbol">?:</span> <a href="../modules/commands.html#SelectedLabels" class="tsd-signature-type" data-tsd-kind="Type alias">SelectedLabels</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/redis/node-redis/blob/06cb637/packages/time-series/lib/commands/index.ts#L351">commands/index.ts:351</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Modules</a></li><li class="current tsd-kind-module"><a href="../modules/commands.html">commands</a></li><li class=" tsd-kind-module"><a href="../modules/commands_ADD.html">commands/ADD</a></li><li class=" tsd-kind-module"><a href="../modules/commands_ALTER.html">commands/ALTER</a></li><li class=" tsd-kind-module"><a href="../modules/commands_CREATE.html">commands/CREATE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_CREATERULE.html">commands/CREATERULE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_DECRBY.html">commands/DECRBY</a></li><li class=" tsd-kind-module"><a href="../modules/commands_DEL.html">commands/DEL</a></li><li class=" tsd-kind-module"><a href="../modules/commands_DELETERULE.html">commands/DELETERULE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_GET.html">commands/GET</a></li><li class=" tsd-kind-module"><a href="../modules/commands_INCRBY.html">commands/INCRBY</a></li><li class=" tsd-kind-module"><a href="../modules/commands_INFO.html">commands/INFO</a></li><li class=" tsd-kind-module"><a href="../modules/commands_INFO_DEBUG.html">commands/INFO_<wbr/>DEBUG</a></li><li class=" tsd-kind-module"><a href="../modules/commands_MADD.html">commands/MADD</a></li><li class=" tsd-kind-module"><a href="../modules/commands_MGET.html">commands/MGET</a></li><li class=" tsd-kind-module"><a href="../modules/commands_MGET_WITHLABELS.html">commands/MGET_<wbr/>WITHLABELS</a></li><li class=" tsd-kind-module"><a href="../modules/commands_MRANGE.html">commands/MRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_MRANGE_WITHLABELS.html">commands/MRANGE_<wbr/>WITHLABELS</a></li><li class=" tsd-kind-module"><a href="../modules/commands_MREVRANGE.html">commands/MREVRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_MREVRANGE_WITHLABELS.html">commands/MREVRANGE_<wbr/>WITHLABELS</a></li><li class=" tsd-kind-module"><a href="../modules/commands_QUERYINDEX.html">commands/QUERYINDEX</a></li><li class=" tsd-kind-module"><a href="../modules/commands_RANGE.html">commands/RANGE</a></li><li class=" tsd-kind-module"><a href="../modules/commands_REVRANGE.html">commands/REVRANGE</a></li><li class=" tsd-kind-module"><a href="../modules/index.html">index</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-module"><a href="commands.MRangeWithLabelsOptions.html" class="tsd-kind-icon">MRange<wbr/>With<wbr/>Labels<wbr/>Options</a><ul><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#AGGREGATION" class="tsd-kind-icon">AGGREGATION</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#ALIGN" class="tsd-kind-icon">ALIGN</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#COUNT" class="tsd-kind-icon">COUNT</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#FILTER_BY_TS" class="tsd-kind-icon">FILTER_<wbr/>BY_<wbr/>TS</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#FILTER_BY_VALUE" class="tsd-kind-icon">FILTER_<wbr/>BY_<wbr/>VALUE</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="commands.MRangeWithLabelsOptions.html#GROUPBY" class="tsd-kind-icon">GROUPBY</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="commands.MRangeWithLabelsOptions.html#SELECTED_LABELS" class="tsd-kind-icon">SELECTED_<wbr/>LABELS</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li><li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li><li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>