You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-10 11:43:01 +03:00
15 lines
8.4 KiB
HTML
15 lines
8.4 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>@node-redis/bloom</title><meta name="description" content="Documentation for @node-redis/bloom"/><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/bloom</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/bloom</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-redisbloom" id="node-redisbloom" style="color: inherit; text-decoration: none;">
|
|
<h1>@node-redis/bloom</h1>
|
|
</a>
|
|
<p>This package provides support for the <a href="https://redisbloom.io">RedisBloom</a> module, which adds additional probabilistic data structures to Redis. It extends the <a href="https://github.com/redis/node-redis">Node Redis client</a> to include functions for each of the RediBloom commands.</p>
|
|
<p>To use these extra commands, your Redis server must have the RedisBloom module installed.</p>
|
|
<p>RedisBloom provides the following probabilistic data structures:</p>
|
|
<ul>
|
|
<li>Bloom Filter: for checking set membership with a high degree of certainty.</li>
|
|
<li>Cuckoo Filter: for checking set membership with a high degree of certainty.</li>
|
|
<li>Count-Min Sketch: Determine the frequency of events in a stream.</li>
|
|
<li>Top-K: Maintain a list of k most frequently seen items.</li>
|
|
</ul>
|
|
<p>For complete examples, see <code>bloom-filter.js</code>, <code>cuckoo-filter.js</code>, <code>count-min-sketch.js</code> and <code>topk.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_bloom.html">commands/bloom</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_ADD.html">commands/bloom/ADD</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_EXISTS.html">commands/bloom/EXISTS</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_INFO.html">commands/bloom/INFO</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_INSERT.html">commands/bloom/INSERT</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_LOADCHUNK.html">commands/bloom/LOADCHUNK</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_MADD.html">commands/bloom/MADD</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_MEXISTS.html">commands/bloom/MEXISTS</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_RESERVE.html">commands/bloom/RESERVE</a></li><li class=" tsd-kind-module"><a href="modules/commands_bloom_SCANDUMP.html">commands/bloom/SCANDUMP</a></li><li class=" tsd-kind-module"><a href="modules/commands_count_min_sketch.html">commands/count-<wbr/>min-<wbr/>sketch</a></li><li class=" tsd-kind-module"><a href="modules/commands_count_min_sketch_INCRBY.html">commands/count-<wbr/>min-<wbr/>sketch/INCRBY</a></li><li class=" tsd-kind-module"><a href="modules/commands_count_min_sketch_INFO.html">commands/count-<wbr/>min-<wbr/>sketch/INFO</a></li><li class=" tsd-kind-module"><a href="modules/commands_count_min_sketch_INITBYDIM.html">commands/count-<wbr/>min-<wbr/>sketch/INITBYDIM</a></li><li class=" tsd-kind-module"><a href="modules/commands_count_min_sketch_INITBYPROB.html">commands/count-<wbr/>min-<wbr/>sketch/INITBYPROB</a></li><li class=" tsd-kind-module"><a href="modules/commands_count_min_sketch_MERGE.html">commands/count-<wbr/>min-<wbr/>sketch/MERGE</a></li><li class=" tsd-kind-module"><a href="modules/commands_count_min_sketch_QUERY.html">commands/count-<wbr/>min-<wbr/>sketch/QUERY</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo.html">commands/cuckoo</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_ADD.html">commands/cuckoo/ADD</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_ADDNX.html">commands/cuckoo/ADDNX</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_COUNT.html">commands/cuckoo/COUNT</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_DEL.html">commands/cuckoo/DEL</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_EXISTS.html">commands/cuckoo/EXISTS</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_INFO.html">commands/cuckoo/INFO</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_INSERT.html">commands/cuckoo/INSERT</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_INSERTNX.html">commands/cuckoo/INSERTNX</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_LOADCHUNK.html">commands/cuckoo/LOADCHUNK</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_RESERVE.html">commands/cuckoo/RESERVE</a></li><li class=" tsd-kind-module"><a href="modules/commands_cuckoo_SCANDUMP.html">commands/cuckoo/SCANDUMP</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k.html">commands/top-<wbr/>k</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k_ADD.html">commands/top-<wbr/>k/ADD</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k_COUNT.html">commands/top-<wbr/>k/COUNT</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k_INCRBY.html">commands/top-<wbr/>k/INCRBY</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k_INFO.html">commands/top-<wbr/>k/INFO</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k_LIST.html">commands/top-<wbr/>k/LIST</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k_QUERY.html">commands/top-<wbr/>k/QUERY</a></li><li class=" tsd-kind-module"><a href="modules/commands_top_k_RESERVE.html">commands/top-<wbr/>k/RESERVE</a></li><li class=" tsd-kind-module"><a href="modules/index.html">index</a></li><li class=" tsd-kind-module"><a href="modules/test_utils.html">test-<wbr/>utils</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-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> |