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/index.html
documentation-bot d357eb251a Updates
2022-04-18 16:37:51 +00:00

8 lines
6.1 KiB
HTML

<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@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"><h1> @node-redis/time-series </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><div class="tsd-panel tsd-typography">
<a href="#node-redistime-series" id="node-redistime-series" style="color: inherit; text-decoration: none;">
<h1>@node-redis/time-series</h1>
</a>
<p>This package provides support for the <a href="https://redistimeseries.io">RedisTimeSeries</a> module, which adds a time series data structure to Redis. It extends the <a href="https://github.com/redis/node-redis">Node Redis client</a> to include functions for each of the RedisTimeSeries commands.</p>
<p>To use these extra commands, your Redis server must have the RedisTimeSeries module installed.</p>
<p>For an example of how to add values to a time series, query a time series, and perform aggregated queries against a time series, see <code>time-series.js</code> in the Node Redis examples folder.</p>
</div></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class="current"><a href="modules.html">Modules</a></li><li class=" 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></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-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>