redis 4.0.0-rc.3 → 4.0.2

package/LICENSE

@@ -1,4 +1,4 @@
- MIT License
+MIT License
 
 Copyright (c) 2016-present Node Redis contributors.
 

package/README.md

@@ -1,34 +1,20 @@
-<p align="center">
-    <a href="https://github.com/noderedis/node-redis">
-        <img width="128" src="https://static.invertase.io/assets/node_redis_logo.png" />
-    </a>
-    <h2 align="center">Node Redis</h2>
-</p>
-
-<div align="center">
-    <a href="https://coveralls.io/github/NodeRedis/node-redis">
-        <img src="https://coveralls.io/repos/github/NodeRedis/node-redis/badge.svg" alt="Coverage Status"/>
-    </a>
-    <a href="https://www.npmjs.com/package/redis/v/next">
-        <img src="https://img.shields.io/npm/dm/redis.svg" alt="Downloads"/>
-    </a>
-    <a href="https://www.npmjs.com/package/redis/v/next">
-        <img src="https://img.shields.io/npm/v/redis/next.svg" alt="Version"/>
-    </a>
-    <a href="https://discord.gg/XMMVgxUm">
-        <img src="https://img.shields.io/discord/697882427875393627" alt="Chat"/>
-    </a>
-</div>
-
----
+# Node-Redis
+
+[![Tests](https://img.shields.io/github/workflow/status/redis/node-redis/Tests/master.svg?label=tests)](https://github.com/redis/node-redis/actions/workflows/tests.yml)
+[![Coverage](https://codecov.io/gh/redis/node-redis/branch/master/graph/badge.svg?token=xcfqHhJC37)](https://codecov.io/gh/redis/node-redis)
+[![License](https://img.shields.io/github/license/redis/node-redis.svg)](https://github.com/redis/node-redis/blob/master/LICENSE)
+[![LGTM alerts](https://img.shields.io/lgtm/alerts/g/redis/node-redis.svg?logo=LGTM)](https://lgtm.com/projects/g/redis/node-redis/alerts)
+[![Chat](https://img.shields.io/discord/697882427875393627.svg)](https://discord.gg/redis)
+
+node-redis is a modern, high performance [Redis](https://redis.io) client for Node.js with built-in support for Redis 6.2 commands and modules including [RediSearch](https://redisearch.io) and [RedisJSON](https://redisjson.io).
 
 ## Installation
 
 ```bash
-npm install redis@next
+npm install redis
 ```
 
-> :warning: The new interface is clean and cool, but if you have an existing code base, you'll want to read the [migration guide](./docs/v3-to-v4.md).
+> :warning: The new interface is clean and cool, but if you have an existing codebase, you'll want to read the [migration guide](./docs/v3-to-v4.md).
 
 ## Usage
 
@@ -57,7 +43,7 @@ createClient({
 });
 ```
 
-You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in in the [Wiki](https://github.com/NodeRedis/node-redis/wiki/lib.socket#RedisSocketOptions).
+You can also use discrete parameters, UNIX sockets, and even TLS to connect. Details can be found in the [client configuration guide](./docs/client-configuration.md).
 
 ### Redis Commands
 
@@ -89,6 +75,16 @@ await client.hGetAll('key'); // { field1: 'value1', field2: 'value2' }
 await client.hVals('key'); // ['value1', 'value2']
 ```
 
+`Buffer`s are supported as well:
+
+```typescript
+await client.hSet('key', 'field', Buffer.from('value')); // 'OK'
+await client.hGetAll(
+  commandOptions({ returnBuffers: true }),
+  'key'
+); // { field: <Buffer 76 61 6c 75 65> }
+```
+
 ### Unsupported Redis Commands
 
 If you want to run commands and/or use arguments that Node Redis doesn't know about (yet!) use `.sendCommand()`:
@@ -126,7 +122,11 @@ This pattern works especially well for blocking commands—such as `BLPOP` and `
 ```typescript
 import { commandOptions } from 'redis';
 
-const blPopPromise = client.blPop(commandOptions({ isolated: true }), 'key');
+const blPopPromise = client.blPop(
+  commandOptions({ isolated: true }),
+  'key',
+  0
+);
 
 await client.lPush('key', ['1', '2']);
 
@@ -167,6 +167,18 @@ Publish a message on a channel:
 await publisher.publish('channel', 'message');
 ```
 
+There is support for buffers as well:
+
+```typescript
+await subscriber.subscribe('channel', (message) => {
+  console.log(message); // <Buffer 6d 65 73 73 61 67 65>
+}, true);
+
+await subscriber.pSubscribe('channe*', (message, channel) => {
+  console.log(message, channel); // <Buffer 6d 65 73 73 61 67 65>, <Buffer 63 68 61 6e 6e 65 6c>
+}, true);
+```
+
 ### Scan Iterator
 
 [`SCAN`](https://redis.io/commands/scan) results can be looped over using [async iterators](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator):
@@ -181,9 +193,9 @@ for await (const key of client.scanIterator()) {
 This works with `HSCAN`, `SSCAN`, and `ZSCAN` too:
 
 ```typescript
-for await (const member of client.hScanIterator('hash')) {}
-for await (const { field, value } of client.sScanIterator('set')) {}
-for await (const { member, score } of client.zScanIterator('sorted-set')) {}
+for await (const { field, value } of client.hScanIterator('hash')) {}
+for await (const member of client.sScanIterator('set')) {}
+for await (const { score, value } of client.zScanIterator('sorted-set')) {}
 ```
 
 You can override the default options by providing a configuration object:
@@ -192,7 +204,7 @@ You can override the default options by providing a configuration object:
 client.scanIterator({
   TYPE: 'string', // `SCAN` only
   MATCH: 'patter*',
-  COUNT: 100,
+  COUNT: 100
 });
 ```
 
@@ -201,8 +213,7 @@ client.scanIterator({
 Define new functions using [Lua scripts](https://redis.io/commands/eval) which execute on the Redis server:
 
 ```typescript
-import { createClient } from 'redis';
-import { defineScript } from 'redis/lua-script';
+import { createClient, defineScript } from 'redis';
 
 (async () => {
   const client = createClient({
@@ -210,9 +221,10 @@ import { defineScript } from 'redis/lua-script';
       add: defineScript({
         NUMBER_OF_KEYS: 1,
         SCRIPT:
-          "local val = redis.pcall('GET', KEYS[1]);' + 'return val + ARGV[1];",
+          'local val = redis.pcall("GET", KEYS[1]);' +
+          'return val + ARGV[1];',
         transformArguments(key: string, toAdd: number): Array<string> {
-          return [key, number.toString()];
+          return [key, toAdd.toString()];
         },
         transformReply(reply: number): number {
           return reply;
@@ -228,32 +240,34 @@ import { defineScript } from 'redis/lua-script';
 })();
 ```
 
-### Cluster
+### Disconnecting
 
-Connecting to a cluster is a bit different. Create the client by specifying some (or all) of the nodes in your cluster and then use it like a non-clustered client:
+There are two functions that disconnect a client from the Redis server. In most scenarios you should use `.quit()` to ensure that pending commands are sent to Redis before closing a connection.
 
-```typescript
-import { createCluster } from 'redis';
+#### `.QUIT()`/`.quit()`
 
-(async () => {
-  const cluster = createCluster({
-    rootNodes: [
-      {
-        url: 'redis://10.0.0.1:30001'
-      },
-      {
-        url: 'redis://10.0.0.2:30002'
-      }
-    ]
-  });
+Gracefully close a client's connection to Redis, by sending the [`QUIT`](https://redis.io/commands/quit) command to the server. Before quitting, the client executes any remaining commands in its queue, and will receive replies from Redis for each of them.
 
-  cluster.on('error', (err) => console.log('Redis Cluster Error', err));
+```typescript
+const [ping, get, quit] = await Promise.all([
+  client.ping(),
+  client.get('key'),
+  client.quit()
+]); // ['PONG', null, 'OK']
+
+try {
+  await client.get('key');
+} catch (err) {
+  // ClosedClient Error
+}
+```
 
-  await cluster.connect();
+#### `.disconnect()`
 
-  await cluster.set('key', 'value');
-  const value = await cluster.get('key');
-})();
+Forcibly close a client's connection to Redis immediately. Calling `disconnect` will not send further pending commands to the Redis server, or wait for or parse outstanding responses.
+
+```typescript
+await client.disconnect();
 ```
 
 ### Auto-Pipelining
@@ -274,15 +288,55 @@ await Promise.all([
 ]);
 ```
 
+### Clustering
+
+Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to connect to a Redis Cluster.
+
+### Events
+
+The Node Redis client class is an Nodejs EventEmitter and it emits an event each time the network status changes:
+
+| Event name     | Scenes                                                                                                            | Arguments to be passed to the listener                                                                                                         |
+|----------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
+| `connect`      | The client is initiating a connection to the server.                                                              | _No argument_                                                                                                                                  |
+| `ready`        | The client successfully initiated the connection to the server.                                                   | _No argument_                                                                                                                                  |
+| `end`          | The client disconnected the connection to the server via `.quit()` or `.disconnect()`.                            | _No argument_                                                                                                                                  |
+| `error`        | When a network error has occurred, such as unable to connect to the server or the connection closed unexpectedly. | 1 argument: The error object, such as `SocketClosedUnexpectedlyError: Socket closed unexpectedly` or `Error: connect ECONNREFUSED [IP]:[PORT]` |
+| `reconnecting` | The client is trying to reconnect to the server.                                                                  | _No argument_                                                                                                                                  |
+
+The client will not emit [any other events](./docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
+
+## Supported Redis versions
+
+Node Redis is supported with the following versions of Redis:
+
+| Version | Supported          |
+|---------|--------------------|
+| 6.2.z   | :heavy_check_mark: |
+| 6.0.z   | :heavy_check_mark: |
+| 5.y.z   | :heavy_check_mark: |
+| < 5.0   | :x:                |
+
+> Node Redis should work with older versions of Redis, but it is not fully tested and we cannot offer support.
+
+## Packages
+
+| Name                                              | Description                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+|---------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [redis](./)                                       | [![Downloads](https://img.shields.io/npm/dm/redis.svg)](https://www.npmjs.com/package/redis) [![Version](https://img.shields.io/npm/v/redis.svg)](https://www.npmjs.com/package/redis)                                                                                                                                                                                                                                                             |
+| [@node-redis/client](./packages/client)           | [![Downloads](https://img.shields.io/npm/dm/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) [![Version](https://img.shields.io/npm/v/@node-redis/client.svg)](https://www.npmjs.com/package/@node-redis/client) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/client/)                                                                                               |
+| [@node-redis/bloom](./packages/bloom)             | [![Downloads](https://img.shields.io/npm/dm/@node-redis/bloom.svg)](https://www.npmjs.com/package/@node-redis/bloom) [![Version](https://img.shields.io/npm/v/@node-redis/bloom.svg)](https://www.npmjs.com/package/@node-redis/bloom) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/bloom/) [Redis Bloom](https://oss.redis.com/redisbloom/) commands                                          |
+| [@node-redis/json](./packages/json)               | [![Downloads](https://img.shields.io/npm/dm/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [![Version](https://img.shields.io/npm/v/@node-redis/json.svg)](https://www.npmjs.com/package/@node-redis/json) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/json/) [Redis JSON](https://oss.redis.com/redisjson/) commands                                                 |
+| [@node-redis/search](./packages/search)           | [![Downloads](https://img.shields.io/npm/dm/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search) [![Version](https://img.shields.io/npm/v/@node-redis/search.svg)](https://www.npmjs.com/package/@node-redis/search) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/search/) [Redis Search](https://oss.redis.com/redisearch/) commands                                    |
+| [@node-redis/time-series](./packages/time-series) | [![Downloads](https://img.shields.io/npm/dm/@node-redis/time-series.svg)](https://www.npmjs.com/package/@node-redis/time-series) [![Version](https://img.shields.io/npm/v/@node-redis/time-series.svg)](https://www.npmjs.com/package/@node-redis/time-series) [![Docs](https://img.shields.io/badge/-documentation-dc382c)](https://redis.js.org/documentation/time-series/) [Redis Time-Series](https://oss.redis.com/redistimeseries/) commands |
+
 ## Contributing
 
 If you'd like to contribute, check out the [contributing guide](CONTRIBUTING.md).
 
 Thank you to all the people who already contributed to Node Redis!
 
-<a href="https://github.com/NodeRedis/node-redis/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=NodeRedis/node-redis"/>
-</a>
+[![Contributors](https://contrib.rocks/image?repo=redis/node-redis)](https://github.com/redis/node-redis/graphs/contributors)
 
 ## License
 

package/dist/index.d.ts

@@ -1,5 +1,233 @@
-import RedisClient from './lib/client';
-import RedisCluster from './lib/cluster';
-export declare const createClient: typeof RedisClient.create;
-export declare const commandOptions: typeof RedisClient.commandOptions;
-export declare const createCluster: typeof RedisCluster.create;
+import { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType } from '@node-redis/client';
+import { RedisScripts } from '@node-redis/client/dist/lib/commands';
+export * from '@node-redis/client';
+export * from '@node-redis/bloom';
+export * from '@node-redis/json';
+export * from '@node-redis/search';
+export * from '@node-redis/time-series';
+declare const modules: {
+    json: {
+        ARRAPPEND: typeof import("@node-redis/json/dist/commands/ARRAPPEND");
+        arrAppend: typeof import("@node-redis/json/dist/commands/ARRAPPEND");
+        ARRINDEX: typeof import("@node-redis/json/dist/commands/ARRINDEX");
+        arrIndex: typeof import("@node-redis/json/dist/commands/ARRINDEX");
+        ARRINSERT: typeof import("@node-redis/json/dist/commands/ARRINSERT");
+        arrInsert: typeof import("@node-redis/json/dist/commands/ARRINSERT");
+        ARRLEN: typeof import("@node-redis/json/dist/commands/ARRLEN");
+        arrLen: typeof import("@node-redis/json/dist/commands/ARRLEN");
+        ARRPOP: typeof import("@node-redis/json/dist/commands/ARRPOP");
+        arrPop: typeof import("@node-redis/json/dist/commands/ARRPOP");
+        ARRTRIM: typeof import("@node-redis/json/dist/commands/ARRTRIM");
+        arrTrim: typeof import("@node-redis/json/dist/commands/ARRTRIM");
+        DEBUG_MEMORY: typeof import("@node-redis/json/dist/commands/DEBUG_MEMORY");
+        debugMemory: typeof import("@node-redis/json/dist/commands/DEBUG_MEMORY");
+        DEL: typeof import("@node-redis/json/dist/commands/DEL");
+        del: typeof import("@node-redis/json/dist/commands/DEL");
+        FORGET: typeof import("@node-redis/json/dist/commands/FORGET");
+        forget: typeof import("@node-redis/json/dist/commands/FORGET");
+        GET: typeof import("@node-redis/json/dist/commands/GET");
+        get: typeof import("@node-redis/json/dist/commands/GET");
+        MGET: typeof import("@node-redis/json/dist/commands/MGET");
+        mGet: typeof import("@node-redis/json/dist/commands/MGET");
+        NUMINCRBY: typeof import("@node-redis/json/dist/commands/NUMINCRBY");
+        numIncrBy: typeof import("@node-redis/json/dist/commands/NUMINCRBY");
+        NUMMULTBY: typeof import("@node-redis/json/dist/commands/NUMMULTBY");
+        numMultBy: typeof import("@node-redis/json/dist/commands/NUMMULTBY");
+        OBJKEYS: typeof import("@node-redis/json/dist/commands/OBJKEYS");
+        objKeys: typeof import("@node-redis/json/dist/commands/OBJKEYS");
+        OBJLEN: typeof import("@node-redis/json/dist/commands/OBJLEN");
+        objLen: typeof import("@node-redis/json/dist/commands/OBJLEN");
+        RESP: typeof import("@node-redis/json/dist/commands/RESP");
+        resp: typeof import("@node-redis/json/dist/commands/RESP");
+        SET: typeof import("@node-redis/json/dist/commands/SET");
+        set: typeof import("@node-redis/json/dist/commands/SET");
+        STRAPPEND: typeof import("@node-redis/json/dist/commands/STRAPPEND");
+        strAppend: typeof import("@node-redis/json/dist/commands/STRAPPEND");
+        STRLEN: typeof import("@node-redis/json/dist/commands/STRLEN");
+        strLen: typeof import("@node-redis/json/dist/commands/STRLEN");
+        TYPE: typeof import("@node-redis/json/dist/commands/TYPE");
+        type: typeof import("@node-redis/json/dist/commands/TYPE");
+    };
+    ft: {
+        _LIST: typeof import("@node-redis/search/dist/commands/_LIST");
+        _list: typeof import("@node-redis/search/dist/commands/_LIST");
+        ALTER: typeof import("@node-redis/search/dist/commands/ALTER");
+        alter: typeof import("@node-redis/search/dist/commands/ALTER");
+        AGGREGATE: typeof import("@node-redis/search/dist/commands/AGGREGATE");
+        aggregate: typeof import("@node-redis/search/dist/commands/AGGREGATE");
+        ALIASADD: typeof import("@node-redis/search/dist/commands/ALIASADD");
+        aliasAdd: typeof import("@node-redis/search/dist/commands/ALIASADD");
+        ALIASDEL: typeof import("@node-redis/search/dist/commands/ALIASDEL");
+        aliasDel: typeof import("@node-redis/search/dist/commands/ALIASDEL");
+        ALIASUPDATE: typeof import("@node-redis/search/dist/commands/ALIASUPDATE");
+        aliasUpdate: typeof import("@node-redis/search/dist/commands/ALIASUPDATE");
+        CONFIG_GET: typeof import("@node-redis/search/dist/commands/CONFIG_GET");
+        configGet: typeof import("@node-redis/search/dist/commands/CONFIG_GET");
+        CONFIG_SET: typeof import("@node-redis/search/dist/commands/CONFIG_SET");
+        configSet: typeof import("@node-redis/search/dist/commands/CONFIG_SET");
+        CREATE: typeof import("@node-redis/search/dist/commands/CREATE");
+        create: typeof import("@node-redis/search/dist/commands/CREATE");
+        DICTADD: typeof import("@node-redis/search/dist/commands/DICTADD");
+        dictAdd: typeof import("@node-redis/search/dist/commands/DICTADD");
+        DICTDEL: typeof import("@node-redis/search/dist/commands/DICTDEL");
+        dictDel: typeof import("@node-redis/search/dist/commands/DICTDEL");
+        DICTDUMP: typeof import("@node-redis/search/dist/commands/DICTDUMP");
+        dictDump: typeof import("@node-redis/search/dist/commands/DICTDUMP");
+        DROPINDEX: typeof import("@node-redis/search/dist/commands/DROPINDEX");
+        dropIndex: typeof import("@node-redis/search/dist/commands/DROPINDEX");
+        EXPLAIN: typeof import("@node-redis/search/dist/commands/EXPLAIN");
+        explain: typeof import("@node-redis/search/dist/commands/EXPLAIN");
+        EXPLAINCLI: typeof import("@node-redis/search/dist/commands/EXPLAINCLI");
+        explainCli: typeof import("@node-redis/search/dist/commands/EXPLAINCLI");
+        INFO: typeof import("@node-redis/search/dist/commands/INFO");
+        info: typeof import("@node-redis/search/dist/commands/INFO");
+        PROFILESEARCH: typeof import("@node-redis/search/dist/commands/PROFILE_SEARCH");
+        profileSearch: typeof import("@node-redis/search/dist/commands/PROFILE_SEARCH");
+        PROFILEAGGREGATE: typeof import("@node-redis/search/dist/commands/PROFILE_AGGREGATE");
+        profileAggregate: typeof import("@node-redis/search/dist/commands/PROFILE_AGGREGATE");
+        SEARCH: typeof import("@node-redis/search/dist/commands/SEARCH");
+        search: typeof import("@node-redis/search/dist/commands/SEARCH");
+        SPELLCHECK: typeof import("@node-redis/search/dist/commands/SPELLCHECK");
+        spellCheck: typeof import("@node-redis/search/dist/commands/SPELLCHECK");
+        SUGADD: typeof import("@node-redis/search/dist/commands/SUGADD");
+        sugAdd: typeof import("@node-redis/search/dist/commands/SUGADD");
+        SUGDEL: typeof import("@node-redis/search/dist/commands/SUGDEL");
+        sugDel: typeof import("@node-redis/search/dist/commands/SUGDEL");
+        SUGGET_WITHPAYLOADS: typeof import("@node-redis/search/dist/commands/SUGGET_WITHPAYLOADS");
+        sugGetWithPayloads: typeof import("@node-redis/search/dist/commands/SUGGET_WITHPAYLOADS");
+        SUGGET_WITHSCORES_WITHPAYLOADS: typeof import("@node-redis/search/dist/commands/SUGGET_WITHSCORES_WITHPAYLOADS");
+        sugGetWithScoresWithPayloads: typeof import("@node-redis/search/dist/commands/SUGGET_WITHSCORES_WITHPAYLOADS");
+        SUGGET_WITHSCORES: typeof import("@node-redis/search/dist/commands/SUGGET_WITHSCORES");
+        sugGetWithScores: typeof import("@node-redis/search/dist/commands/SUGGET_WITHSCORES");
+        SUGGET: typeof import("@node-redis/search/dist/commands/SUGGET");
+        sugGet: typeof import("@node-redis/search/dist/commands/SUGGET");
+        SUGLEN: typeof import("@node-redis/search/dist/commands/SUGLEN");
+        sugLen: typeof import("@node-redis/search/dist/commands/SUGLEN");
+        SYNDUMP: typeof import("@node-redis/search/dist/commands/SYNDUMP");
+        synDump: typeof import("@node-redis/search/dist/commands/SYNDUMP");
+        SYNUPDATE: typeof import("@node-redis/search/dist/commands/SYNUPDATE");
+        synUpdate: typeof import("@node-redis/search/dist/commands/SYNUPDATE");
+        TAGVALS: typeof import("@node-redis/search/dist/commands/TAGVALS");
+        tagVals: typeof import("@node-redis/search/dist/commands/TAGVALS");
+    };
+    ts: {
+        ADD: typeof import("@node-redis/time-series/dist/commands/ADD");
+        add: typeof import("@node-redis/time-series/dist/commands/ADD");
+        ALTER: typeof import("@node-redis/time-series/dist/commands/ALTER");
+        alter: typeof import("@node-redis/time-series/dist/commands/ALTER");
+        CREATE: typeof import("@node-redis/time-series/dist/commands/CREATE");
+        create: typeof import("@node-redis/time-series/dist/commands/CREATE");
+        CREATERULE: typeof import("@node-redis/time-series/dist/commands/CREATERULE");
+        createRule: typeof import("@node-redis/time-series/dist/commands/CREATERULE");
+        DECRBY: typeof import("@node-redis/time-series/dist/commands/DECRBY");
+        decrBy: typeof import("@node-redis/time-series/dist/commands/DECRBY");
+        DEL: typeof import("@node-redis/time-series/dist/commands/DEL");
+        del: typeof import("@node-redis/time-series/dist/commands/DEL");
+        DELETERULE: typeof import("@node-redis/time-series/dist/commands/DELETERULE");
+        deleteRule: typeof import("@node-redis/time-series/dist/commands/DELETERULE");
+        GET: typeof import("@node-redis/time-series/dist/commands/GET");
+        get: typeof import("@node-redis/time-series/dist/commands/GET");
+        INCRBY: typeof import("@node-redis/time-series/dist/commands/INCRBY");
+        incrBy: typeof import("@node-redis/time-series/dist/commands/INCRBY");
+        INFO_DEBUG: typeof import("@node-redis/time-series/dist/commands/INFO_DEBUG");
+        infoDebug: typeof import("@node-redis/time-series/dist/commands/INFO_DEBUG");
+        INFO: typeof import("@node-redis/time-series/dist/commands/INFO");
+        info: typeof import("@node-redis/time-series/dist/commands/INFO");
+        MADD: typeof import("@node-redis/time-series/dist/commands/MADD");
+        mAdd: typeof import("@node-redis/time-series/dist/commands/MADD");
+        MGET: typeof import("@node-redis/time-series/dist/commands/MGET");
+        mGet: typeof import("@node-redis/time-series/dist/commands/MGET");
+        MGET_WITHLABELS: typeof import("@node-redis/time-series/dist/commands/MGET_WITHLABELS");
+        mGetWithLabels: typeof import("@node-redis/time-series/dist/commands/MGET_WITHLABELS");
+        QUERYINDEX: typeof import("@node-redis/time-series/dist/commands/QUERYINDEX");
+        queryIndex: typeof import("@node-redis/time-series/dist/commands/QUERYINDEX");
+        RANGE: typeof import("@node-redis/time-series/dist/commands/RANGE");
+        range: typeof import("@node-redis/time-series/dist/commands/RANGE");
+        REVRANGE: typeof import("@node-redis/time-series/dist/commands/REVRANGE");
+        revRange: typeof import("@node-redis/time-series/dist/commands/REVRANGE");
+        MRANGE: typeof import("@node-redis/time-series/dist/commands/MRANGE");
+        mRange: typeof import("@node-redis/time-series/dist/commands/MRANGE");
+        MRANGE_WITHLABELS: typeof import("@node-redis/time-series/dist/commands/MRANGE_WITHLABELS");
+        mRangeWithLabels: typeof import("@node-redis/time-series/dist/commands/MRANGE_WITHLABELS");
+        MREVRANGE: typeof import("@node-redis/time-series/dist/commands/MREVRANGE");
+        mRevRange: typeof import("@node-redis/time-series/dist/commands/MREVRANGE");
+        MREVRANGE_WITHLABELS: typeof import("@node-redis/time-series/dist/commands/MREVRANGE_WITHLABELS");
+        mRevRangeWithLabels: typeof import("@node-redis/time-series/dist/commands/MREVRANGE_WITHLABELS");
+    };
+    bf: {
+        ADD: typeof import("@node-redis/bloom/dist/commands/bloom/ADD");
+        add: typeof import("@node-redis/bloom/dist/commands/bloom/ADD");
+        EXISTS: typeof import("@node-redis/bloom/dist/commands/bloom/EXISTS");
+        exists: typeof import("@node-redis/bloom/dist/commands/bloom/EXISTS");
+        INFO: typeof import("@node-redis/bloom/dist/commands/bloom/INFO");
+        info: typeof import("@node-redis/bloom/dist/commands/bloom/INFO");
+        INSERT: typeof import("@node-redis/bloom/dist/commands/bloom/INSERT");
+        insert: typeof import("@node-redis/bloom/dist/commands/bloom/INSERT");
+        LOADCHUNK: typeof import("@node-redis/bloom/dist/commands/bloom/LOADCHUNK");
+        loadChunk: typeof import("@node-redis/bloom/dist/commands/bloom/LOADCHUNK");
+        MADD: typeof import("@node-redis/bloom/dist/commands/bloom/MADD");
+        mAdd: typeof import("@node-redis/bloom/dist/commands/bloom/MADD");
+        MEXISTS: typeof import("@node-redis/bloom/dist/commands/bloom/MEXISTS");
+        mExists: typeof import("@node-redis/bloom/dist/commands/bloom/MEXISTS");
+        RESERVE: typeof import("@node-redis/bloom/dist/commands/bloom/RESERVE");
+        reserve: typeof import("@node-redis/bloom/dist/commands/bloom/RESERVE");
+        SCANDUMP: typeof import("@node-redis/bloom/dist/commands/bloom/SCANDUMP");
+        scanDump: typeof import("@node-redis/bloom/dist/commands/bloom/SCANDUMP");
+    };
+    cms: {
+        INCRBY: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INCRBY");
+        incrBy: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INCRBY");
+        INFO: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INFO");
+        info: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INFO");
+        INITBYDIM: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INITBYDIM");
+        initByDim: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INITBYDIM");
+        INITBYPROB: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INITBYPROB");
+        initByProb: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/INITBYPROB");
+        MERGE: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/MERGE");
+        merge: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/MERGE");
+        QUERY: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/QUERY");
+        query: typeof import("@node-redis/bloom/dist/commands/count-min-sketch/QUERY");
+    };
+    cf: {
+        ADD: typeof import("@node-redis/bloom/dist/commands/cuckoo/ADD");
+        add: typeof import("@node-redis/bloom/dist/commands/cuckoo/ADD");
+        ADDNX: typeof import("@node-redis/bloom/dist/commands/cuckoo/ADDNX");
+        addNX: typeof import("@node-redis/bloom/dist/commands/cuckoo/ADDNX");
+        COUNT: typeof import("@node-redis/bloom/dist/commands/cuckoo/COUNT");
+        count: typeof import("@node-redis/bloom/dist/commands/cuckoo/COUNT");
+        DEL: typeof import("@node-redis/bloom/dist/commands/cuckoo/DEL");
+        del: typeof import("@node-redis/bloom/dist/commands/cuckoo/DEL");
+        EXISTS: typeof import("@node-redis/bloom/dist/commands/cuckoo/EXISTS");
+        exists: typeof import("@node-redis/bloom/dist/commands/cuckoo/EXISTS");
+        INFO: typeof import("@node-redis/bloom/dist/commands/cuckoo/INFO");
+        info: typeof import("@node-redis/bloom/dist/commands/cuckoo/INFO");
+        INSERT: typeof import("@node-redis/bloom/dist/commands/cuckoo/INSERT");
+        insert: typeof import("@node-redis/bloom/dist/commands/cuckoo/INSERT");
+        INSERTNX: typeof import("@node-redis/bloom/dist/commands/cuckoo/INSERTNX");
+        insertNX: typeof import("@node-redis/bloom/dist/commands/cuckoo/INSERTNX");
+        LOADCHUNK: typeof import("@node-redis/bloom/dist/commands/cuckoo/LOADCHUNK");
+        loadChunk: typeof import("@node-redis/bloom/dist/commands/cuckoo/LOADCHUNK");
+        RESERVE: typeof import("@node-redis/bloom/dist/commands/cuckoo/RESERVE");
+        reserve: typeof import("@node-redis/bloom/dist/commands/cuckoo/RESERVE");
+        SCANDUMP: typeof import("@node-redis/bloom/dist/commands/cuckoo/SCANDUMP");
+        scanDump: typeof import("@node-redis/bloom/dist/commands/cuckoo/SCANDUMP");
+    };
+    topK: {
+        ADD: typeof import("@node-redis/bloom/dist/commands/top-k/ADD");
+        add: typeof import("@node-redis/bloom/dist/commands/top-k/ADD");
+        COUNT: typeof import("@node-redis/bloom/dist/commands/top-k/COUNT");
+        count: typeof import("@node-redis/bloom/dist/commands/top-k/COUNT");
+        INCRBY: typeof import("@node-redis/bloom/dist/commands/top-k/INCRBY");
+        incrBy: typeof import("@node-redis/bloom/dist/commands/top-k/INCRBY");
+        INFO: typeof import("@node-redis/bloom/dist/commands/top-k/INFO");
+        info: typeof import("@node-redis/bloom/dist/commands/top-k/INFO");
+        LIST: typeof import("@node-redis/bloom/dist/commands/top-k/LIST");
+        list: typeof import("@node-redis/bloom/dist/commands/top-k/LIST");
+        QUERY: typeof import("@node-redis/bloom/dist/commands/top-k/QUERY");
+        query: typeof import("@node-redis/bloom/dist/commands/top-k/QUERY");
+        RESERVE: typeof import("@node-redis/bloom/dist/commands/top-k/RESERVE");
+        reserve: typeof import("@node-redis/bloom/dist/commands/top-k/RESERVE");
+    };
+};
+export declare function createClient<S extends RedisScripts>(options?: Omit<RedisClientOptions<never, S>, 'modules'>): RedisClientType<typeof modules, S>;
+export declare function createCluster<S extends RedisScripts>(options: Omit<RedisClusterOptions<never, S>, 'modules'>): RedisClusterType<typeof modules, S>;

package/dist/index.js

@@ -1,11 +1,43 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCluster = exports.commandOptions = exports.createClient = void 0;
-const client_1 = __importDefault(require("./lib/client"));
-const cluster_1 = __importDefault(require("./lib/cluster"));
-exports.createClient = client_1.default.create;
-exports.commandOptions = client_1.default.commandOptions;
-exports.createCluster = cluster_1.default.create;
+exports.createCluster = exports.createClient = void 0;
+const client_1 = require("@node-redis/client");
+const bloom_1 = require("@node-redis/bloom");
+const json_1 = require("@node-redis/json");
+const search_1 = require("@node-redis/search");
+const time_series_1 = require("@node-redis/time-series");
+__exportStar(require("@node-redis/client"), exports);
+__exportStar(require("@node-redis/bloom"), exports);
+__exportStar(require("@node-redis/json"), exports);
+__exportStar(require("@node-redis/search"), exports);
+__exportStar(require("@node-redis/time-series"), exports);
+const modules = {
+    ...bloom_1.default,
+    json: json_1.default,
+    ft: search_1.default,
+    ts: time_series_1.default
+};
+function createClient(options) {
+    return (0, client_1.createClient)({
+        ...options,
+        modules
+    });
+}
+exports.createClient = createClient;
+function createCluster(options) {
+    return (0, client_1.createCluster)({
+        ...options,
+        modules
+    });
+}
+exports.createCluster = createCluster;