ioredis 5.0.4 → 5.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/README.md +18 -10
  2. package/built/Pipeline.d.ts +3 -0
  3. package/built/autoPipelining.js +3 -0
  4. package/built/transaction.d.ts +2 -2
  5. package/built/utils/RedisCommander.d.ts +173 -114
  6. package/built/utils/RedisCommander.js +5 -0
  7. package/package.json +2 -2
package/README.md CHANGED
@@ -102,13 +102,13 @@ Medis starts with all the basic features you need:
102
102
  ## Install
103
103
 
104
104
  ```shell
105
- $ npm install ioredis
105
+ npm install ioredis
106
106
  ```
107
107
 
108
108
  In a TypeScript project, you may want to add TypeScript declarations for Node.js:
109
109
 
110
110
  ```shell
111
- $ npm install --save-dev @types/node
111
+ npm install --save-dev @types/node
112
112
  ```
113
113
 
114
114
  ## Basic Usage
@@ -312,19 +312,27 @@ listenForMessage();
312
312
 
313
313
  ## Handle Binary Data
314
314
 
315
- Arguments can be buffers:
315
+ Binary data support is out of the box. Pass buffers to send binary data:
316
316
 
317
317
  ```javascript
318
- redis.set("foo", Buffer.from("bar"));
318
+ redis.set("foo", Buffer.from([0x62, 0x75, 0x66]));
319
319
  ```
320
320
 
321
- And every command has a method that returns a Buffer (by adding a suffix of "Buffer" to the command name).
322
- To get a buffer instead of a utf8 string:
321
+ Every command that returns a [bulk string](https://redis.io/docs/reference/protocol-spec/#resp-bulk-strings)
322
+ has a variant command with a `Buffer` suffix. The variant command returns a buffer instead of a UTF-8 string:
323
323
 
324
324
  ```javascript
325
- redis.getBuffer("foo", (err, result) => {
326
- // result is a buffer.
327
- });
325
+ const result = await redis.getBuffer("foo");
326
+ // result is `<Buffer 62 75 66>`
327
+ ```
328
+
329
+ It's worth noticing that you don't need the `Buffer` suffix variant in order to **send** binary data. That means
330
+ in most case you should just use `redis.set()` instead of `redis.setBuffer()` unless you want to get the old value
331
+ with the `GET` parameter:
332
+
333
+ ```javascript
334
+ const result = await redis.setBuffer("foo", "new value", "GET");
335
+ // result is `<Buffer 62 75 66>` as `GET` indicates returning the old value.
328
336
  ```
329
337
 
330
338
  ## Pipelining
@@ -1388,7 +1396,7 @@ default, this option is disabled and can only be used for debugging purposes. Yo
1388
1396
  Start a Redis server on 127.0.0.1:6379, and then:
1389
1397
 
1390
1398
  ```shell
1391
- $ npm test
1399
+ npm test
1392
1400
  ```
1393
1401
 
1394
1402
  `FLUSH ALL` will be invoked after each test, so make sure there's no valuable data in it before running tests.
package/built/Pipeline.d.ts CHANGED
@@ -26,3 +26,6 @@ declare class Pipeline extends Commander<{
26
26
  addBatch(commands: any): this;
27
27
  }
28
28
  export default Pipeline;
29
+ interface Pipeline {
30
+ length: number;
31
+ }
package/built/autoPipelining.js CHANGED
@@ -148,6 +148,9 @@ function executeWithAutoPipelining(client, functionName, commandName, args, call
148
148
  }
149
149
  resolve(value);
150
150
  });
151
+ if (functionName === "call") {
152
+ args.unshift(commandName);
153
+ }
151
154
  pipeline[functionName](...args);
152
155
  });
153
156
  return (0, standard_as_callback_1.default)(autoPipelinePromise, callback);
package/built/transaction.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { ChainableCommander } from "./utils/RedisCommander";
2
2
  export interface Transaction {
3
- pipeline(commands?: [name: string, ...args: unknown[]][]): ChainableCommander;
3
+ pipeline(commands?: unknown[][]): ChainableCommander;
4
4
  multi(options: {
5
5
  pipeline: false;
6
6
  }): Promise<"OK">;
@@ -8,6 +8,6 @@ export interface Transaction {
8
8
  multi(options: {
9
9
  pipeline: true;
10
10
  }): ChainableCommander;
11
- multi(commands?: [name: string, ...args: unknown[]][]): ChainableCommander;
11
+ multi(commands?: unknown[][]): ChainableCommander;
12
12
  }
13
13
  export declare function addTransactionSupport(redis: any): void;
package/built/utils/RedisCommander.d.ts CHANGED
@@ -1,3 +1,8 @@
1
+ /**
2
+ * This file is generated by @ioredis/interface-generator.
3
+ * Don't edit it manually. Instead, run `npm run generate` to update
4
+ * this file.
5
+ */
1
6
  /// <reference types="node" />
2
7
  import { Callback } from "../types";
3
8
  export declare type RedisKey = string | Buffer;
@@ -9,6 +14,7 @@ export interface ResultTypes<Result, Context> {
9
14
  export interface ChainableCommander extends RedisCommander<{
10
15
  type: "pipeline";
11
16
  }> {
17
+ length: number;
12
18
  }
13
19
  export declare type ClientContext = {
14
20
  type: keyof ResultTypes<unknown, unknown>;
@@ -245,45 +251,32 @@ interface RedisCommander<Context extends ClientContext = {
245
251
  * - _complexity_: O(1) for each subcommand specified
246
252
  * - _since_: 3.2.0
247
253
  */
248
- bitfield(key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
249
- bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
250
- bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
251
- bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
252
- bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
253
- bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
254
- bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
255
- bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
256
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
257
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
258
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
259
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
260
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
261
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
262
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
263
- bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
264
254
  bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
265
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
266
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
267
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
268
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
269
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
270
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
271
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetIncrementToken: "INCRBY", encoding1: string | Buffer, offset1: number | string, increment: number | string, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
272
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
273
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
274
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
275
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
276
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding2: string | Buffer, offset2: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
277
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding2: string | Buffer, offset2: number | string, increment: number | string, overflow: "OVERFLOW", wrap: "WRAP", callback?: Callback<unknown>): Result<unknown, Context>;
278
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding2: string | Buffer, offset2: number | string, increment: number | string, overflow: "OVERFLOW", sat: "SAT", callback?: Callback<unknown>): Result<unknown, Context>;
279
- bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, encodingOffsetValueToken: "SET", encoding1: string | Buffer, offset1: number | string, value: number | string, encodingOffsetIncrementToken: "INCRBY", encoding2: string | Buffer, offset2: number | string, increment: number | string, overflow: "OVERFLOW", fail: "FAIL", callback?: Callback<unknown>): Result<unknown, Context>;
255
+ bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
256
+ bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
257
+ bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
258
+ bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
259
+ bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
260
+ bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
261
+ bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
262
+ bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
280
263
  /**
281
264
  * Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD
282
265
  * - _group_: bitmap
283
266
  * - _complexity_: O(1) for each subcommand specified
284
- * - _since_: 6.2.0
267
+ * - _since_: 6.0.0
285
268
  */
286
- bitfield_ro(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
269
+ bitfield_ro(...args: [
270
+ key: RedisKey,
271
+ encodingOffsetToken: "GET",
272
+ ...encodingOffsets: (string | Buffer | number)[],
273
+ callback: Callback<unknown[]>
274
+ ]): Result<unknown[], Context>;
275
+ bitfield_ro(...args: [
276
+ key: RedisKey,
277
+ encodingOffsetToken: "GET",
278
+ ...encodingOffsets: (string | Buffer | number)[]
279
+ ]): Result<unknown[], Context>;
287
280
  /**
288
281
  * Perform bitwise operations between strings
289
282
  * - _group_: bitmap
@@ -1369,6 +1362,13 @@ interface RedisCommander<Context extends ClientContext = {
1369
1362
  cluster(subcommand: "SETSLOT", slot: number | string, nodeIdToken: "MIGRATING", nodeId: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
1370
1363
  cluster(subcommand: "SETSLOT", slot: number | string, nodeIdToken: "NODE", nodeId: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
1371
1364
  cluster(subcommand: "SETSLOT", slot: number | string, stable: "STABLE", callback?: Callback<"OK">): Result<"OK", Context>;
1365
+ /**
1366
+ * Get array of cluster slots to node mappings
1367
+ * - _group_: cluster
1368
+ * - _complexity_: O(N) where N is the total number of cluster nodes
1369
+ * - _since_: 7.0.0
1370
+ */
1371
+ cluster(subcommand: "SHARDS", callback?: Callback<unknown>): Result<unknown, Context>;
1372
1372
  /**
1373
1373
  * List replica nodes of the specified master node
1374
1374
  * - _group_: cluster
@@ -1424,7 +1424,7 @@ interface RedisCommander<Context extends ClientContext = {
1424
1424
  */
1425
1425
  command(subcommand: "GETKEYS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
1426
1426
  /**
1427
- * Extract keys given a full Redis command
1427
+ * Extract keys and access flags given a full Redis command
1428
1428
  * - _group_: server
1429
1429
  * - _complexity_: O(N) where N is the number of arguments to the command
1430
1430
  * - _since_: 7.0.0
@@ -1892,14 +1892,10 @@ interface RedisCommander<Context extends ClientContext = {
1892
1892
  * - _complexity_: O(1) (considering compilation time is redundant)
1893
1893
  * - _since_: 7.0.0
1894
1894
  */
1895
- function(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
1896
- functionBuffer(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
1897
- function(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, libraryDescriptionToken: "DESCRIPTION", libraryDescription: string | Buffer, functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
1898
- functionBuffer(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, libraryDescriptionToken: "DESCRIPTION", libraryDescription: string | Buffer, functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
1899
- function(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
1900
- functionBuffer(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
1901
- function(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, replace: "REPLACE", libraryDescriptionToken: "DESCRIPTION", libraryDescription: string | Buffer, functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
1902
- functionBuffer(subcommand: "LOAD", engineName: string | Buffer, libraryName: string | Buffer, replace: "REPLACE", libraryDescriptionToken: "DESCRIPTION", libraryDescription: string | Buffer, functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
1895
+ function(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
1896
+ functionBuffer(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
1897
+ function(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
1898
+ functionBuffer(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
1903
1899
  /**
1904
1900
  * Restore all the functions on the given payload
1905
1901
  * - _group_: scripting
@@ -2266,7 +2262,7 @@ interface RedisCommander<Context extends ClientContext = {
2266
2262
  * - _since_: 2.0.0
2267
2263
  */
2268
2264
  hgetall(key: RedisKey, callback?: Callback<Record<string, string>>): Result<Record<string, string>, Context>;
2269
- hgetallBuffer(key: RedisKey, callback?: Callback<[field: Buffer, value: Buffer][]>): Result<[field: Buffer, value: Buffer][], Context>;
2265
+ hgetallBuffer(key: RedisKey, callback?: Callback<Record<string, Buffer>>): Result<Record<string, Buffer>, Context>;
2270
2266
  /**
2271
2267
  * Increment the integer value of a hash field by the given number
2272
2268
  * - _group_: hash
@@ -2888,13 +2884,13 @@ interface RedisCommander<Context extends ClientContext = {
2888
2884
  */
2889
2885
  migrate(...args: [
2890
2886
  host: string | Buffer,
2891
- port: string | Buffer,
2887
+ port: number | string,
2892
2888
  ...args: RedisValue[],
2893
2889
  callback: Callback<"OK">
2894
2890
  ]): Result<"OK", Context>;
2895
2891
  migrate(...args: [
2896
2892
  host: string | Buffer,
2897
- port: string | Buffer,
2893
+ port: number | string,
2898
2894
  ...args: RedisValue[]
2899
2895
  ]): Result<"OK", Context>;
2900
2896
  /**
@@ -2929,6 +2925,52 @@ interface RedisCommander<Context extends ClientContext = {
2929
2925
  path: string | Buffer,
2930
2926
  ...args: (string | Buffer | number)[]
2931
2927
  ]): Result<unknown, Context>;
2928
+ /**
2929
+ * Load a module with extended parameters
2930
+ * - _group_: server
2931
+ * - _complexity_: O(1)
2932
+ * - _since_: 7.0.0
2933
+ */
2934
+ module(subcommand: "LOADEX", path: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
2935
+ module(...args: [
2936
+ subcommand: "LOADEX",
2937
+ path: string | Buffer,
2938
+ argsToken: "ARGS",
2939
+ ...args: (string | Buffer | number)[],
2940
+ callback: Callback<unknown>
2941
+ ]): Result<unknown, Context>;
2942
+ module(...args: [
2943
+ subcommand: "LOADEX",
2944
+ path: string | Buffer,
2945
+ argsToken: "ARGS",
2946
+ ...args: (string | Buffer | number)[]
2947
+ ]): Result<unknown, Context>;
2948
+ module(...args: [
2949
+ subcommand: "LOADEX",
2950
+ path: string | Buffer,
2951
+ configsToken: "CONFIG",
2952
+ ...configs: (string | Buffer | number)[],
2953
+ callback: Callback<unknown>
2954
+ ]): Result<unknown, Context>;
2955
+ module(...args: [
2956
+ subcommand: "LOADEX",
2957
+ path: string | Buffer,
2958
+ configsToken: "CONFIG",
2959
+ ...configs: (string | Buffer | number)[]
2960
+ ]): Result<unknown, Context>;
2961
+ module(...args: [
2962
+ subcommand: "LOADEX",
2963
+ path: string | Buffer,
2964
+ configsToken: "CONFIG",
2965
+ ...args: RedisValue[],
2966
+ callback: Callback<unknown>
2967
+ ]): Result<unknown, Context>;
2968
+ module(...args: [
2969
+ subcommand: "LOADEX",
2970
+ path: string | Buffer,
2971
+ configsToken: "CONFIG",
2972
+ ...args: RedisValue[]
2973
+ ]): Result<unknown, Context>;
2932
2974
  /**
2933
2975
  * Unload a module
2934
2976
  * - _group_: server
@@ -3069,7 +3111,7 @@ interface RedisCommander<Context extends ClientContext = {
3069
3111
  * - _complexity_: N/A
3070
3112
  * - _since_: 2.8.9
3071
3113
  */
3072
- pfdebug(callback?: Callback<unknown>): Result<unknown, Context>;
3114
+ pfdebug(subcommand: string | Buffer, key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
3073
3115
  /**
3074
3116
  * Merge N different HyperLogLogs into a single one.
3075
3117
  * - _group_: hyperloglog
@@ -3125,7 +3167,7 @@ interface RedisCommander<Context extends ClientContext = {
3125
3167
  * - _complexity_: undefined
3126
3168
  * - _since_: 2.8.0
3127
3169
  */
3128
- psync(replicationid: number | string, offset: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3170
+ psync(replicationid: string | Buffer | number, offset: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3129
3171
  /**
3130
3172
  * Get the time to live for a key in milliseconds
3131
3173
  * - _group_: generic
@@ -3147,7 +3189,7 @@ interface RedisCommander<Context extends ClientContext = {
3147
3189
  * - _since_: 2.8.0
3148
3190
  */
3149
3191
  pubsub(subcommand: "CHANNELS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
3150
- pubsub(subcommand: "CHANNELS", pattern: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
3192
+ pubsub(subcommand: "CHANNELS", pattern: string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
3151
3193
  /**
3152
3194
  * Show helpful text about the different subcommands
3153
3195
  * - _group_: pubsub
@@ -3178,24 +3220,24 @@ interface RedisCommander<Context extends ClientContext = {
3178
3220
  /**
3179
3221
  * List active shard channels
3180
3222
  * - _group_: pubsub
3181
- * - _complexity_: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short channels).
3223
+ * - _complexity_: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short shard channels).
3182
3224
  * - _since_: 7.0.0
3183
3225
  */
3184
3226
  pubsub(subcommand: "SHARDCHANNELS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
3185
- pubsub(subcommand: "SHARDCHANNELS", pattern: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
3227
+ pubsub(subcommand: "SHARDCHANNELS", pattern: string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
3186
3228
  /**
3187
3229
  * Get the count of subscribers for shard channels
3188
3230
  * - _group_: pubsub
3189
- * - _complexity_: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested channels
3231
+ * - _complexity_: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested shard channels
3190
3232
  * - _since_: 7.0.0
3191
3233
  */
3192
3234
  pubsub(subcommand: "SHARDNUMSUB", callback?: Callback<unknown[]>): Result<unknown[], Context>;
3193
3235
  pubsub(...args: [
3194
3236
  subcommand: "SHARDNUMSUB",
3195
- ...channels: (string | Buffer)[],
3237
+ ...shardchannels: (string | Buffer)[],
3196
3238
  callback: Callback<unknown[]>
3197
3239
  ]): Result<unknown[], Context>;
3198
- pubsub(...args: [subcommand: "SHARDNUMSUB", ...channels: (string | Buffer)[]]): Result<unknown[], Context>;
3240
+ pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]): Result<unknown[], Context>;
3199
3241
  /**
3200
3242
  * Stop listening for messages posted to channels matching the given patterns
3201
3243
  * - _group_: pubsub
@@ -3261,7 +3303,7 @@ interface RedisCommander<Context extends ClientContext = {
3261
3303
  * - _complexity_: O(1)
3262
3304
  * - _since_: 5.0.0
3263
3305
  */
3264
- replicaof(host: string | Buffer, port: string | Buffer, callback?: Callback<"OK">): Result<"OK", Context>;
3306
+ replicaof(host: string | Buffer, port: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
3265
3307
  /**
3266
3308
  * Reset the connection
3267
3309
  * - _group_: connection
@@ -3297,7 +3339,22 @@ interface RedisCommander<Context extends ClientContext = {
3297
3339
  * - _complexity_: O(1) to create the new key and additional O(N*M) to reconstruct the serialized value, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1*M) where M is small, so simply O(1). However for sorted set values the complexity is O(N*M*log(N)) because inserting values into sorted sets is O(log(N)).
3298
3340
  * - _since_: 3.0.0
3299
3341
  */
3300
- ["restore-asking"](callback?: Callback<unknown>): Result<unknown, Context>;
3342
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
3343
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3344
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3345
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, secondsToken: "IDLETIME", seconds: number | string, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3346
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", callback?: Callback<unknown>): Result<unknown, Context>;
3347
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3348
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3349
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3350
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", callback?: Callback<unknown>): Result<unknown, Context>;
3351
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3352
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3353
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", secondsToken: "IDLETIME", seconds: number | string, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3354
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<unknown>): Result<unknown, Context>;
3355
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3356
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3357
+ ["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
3301
3358
  /**
3302
3359
  * Return the role of the instance in the context of replication
3303
3360
  * - _group_: server
@@ -3698,7 +3755,7 @@ interface RedisCommander<Context extends ClientContext = {
3698
3755
  * - _complexity_: O(1)
3699
3756
  * - _since_: 1.0.0
3700
3757
  */
3701
- slaveof(host: string | Buffer, port: string | Buffer, callback?: Callback<"OK">): Result<"OK", Context>;
3758
+ slaveof(host: string | Buffer, port: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
3702
3759
  /**
3703
3760
  * Get the slow log's entries
3704
3761
  * - _group_: server
@@ -3784,44 +3841,40 @@ interface RedisCommander<Context extends ClientContext = {
3784
3841
  sort_ro(...args: [
3785
3842
  key: RedisKey,
3786
3843
  patternToken: "GET",
3787
- ...patterns: (string | Buffer)[],
3844
+ ...patterns: string[],
3788
3845
  callback: Callback<unknown>
3789
3846
  ]): Result<unknown, Context>;
3847
+ sort_ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]): Result<unknown, Context>;
3790
3848
  sort_ro(...args: [
3791
3849
  key: RedisKey,
3792
3850
  patternToken: "GET",
3793
- ...patterns: (string | Buffer)[]
3794
- ]): Result<unknown, Context>;
3795
- sort_ro(...args: [
3796
- key: RedisKey,
3797
- patternToken: "GET",
3798
- ...patterns: (string | Buffer)[],
3851
+ ...patterns: string[],
3799
3852
  alpha: "ALPHA",
3800
3853
  callback: Callback<unknown>
3801
3854
  ]): Result<unknown, Context>;
3802
3855
  sort_ro(...args: [
3803
3856
  key: RedisKey,
3804
3857
  patternToken: "GET",
3805
- ...patterns: (string | Buffer)[],
3858
+ ...patterns: string[],
3806
3859
  alpha: "ALPHA"
3807
3860
  ]): Result<unknown, Context>;
3808
3861
  sort_ro(...args: [
3809
3862
  key: RedisKey,
3810
3863
  patternToken: "GET",
3811
- ...patterns: (string | Buffer)[],
3864
+ ...patterns: string[],
3812
3865
  asc: "ASC",
3813
3866
  callback: Callback<unknown>
3814
3867
  ]): Result<unknown, Context>;
3815
3868
  sort_ro(...args: [
3816
3869
  key: RedisKey,
3817
3870
  patternToken: "GET",
3818
- ...patterns: (string | Buffer)[],
3871
+ ...patterns: string[],
3819
3872
  asc: "ASC"
3820
3873
  ]): Result<unknown, Context>;
3821
3874
  sort_ro(...args: [
3822
3875
  key: RedisKey,
3823
3876
  patternToken: "GET",
3824
- ...patterns: (string | Buffer)[],
3877
+ ...patterns: string[],
3825
3878
  asc: "ASC",
3826
3879
  alpha: "ALPHA",
3827
3880
  callback: Callback<unknown>
@@ -3829,27 +3882,27 @@ interface RedisCommander<Context extends ClientContext = {
3829
3882
  sort_ro(...args: [
3830
3883
  key: RedisKey,
3831
3884
  patternToken: "GET",
3832
- ...patterns: (string | Buffer)[],
3885
+ ...patterns: string[],
3833
3886
  asc: "ASC",
3834
3887
  alpha: "ALPHA"
3835
3888
  ]): Result<unknown, Context>;
3836
3889
  sort_ro(...args: [
3837
3890
  key: RedisKey,
3838
3891
  patternToken: "GET",
3839
- ...patterns: (string | Buffer)[],
3892
+ ...patterns: string[],
3840
3893
  desc: "DESC",
3841
3894
  callback: Callback<unknown>
3842
3895
  ]): Result<unknown, Context>;
3843
3896
  sort_ro(...args: [
3844
3897
  key: RedisKey,
3845
3898
  patternToken: "GET",
3846
- ...patterns: (string | Buffer)[],
3899
+ ...patterns: string[],
3847
3900
  desc: "DESC"
3848
3901
  ]): Result<unknown, Context>;
3849
3902
  sort_ro(...args: [
3850
3903
  key: RedisKey,
3851
3904
  patternToken: "GET",
3852
- ...patterns: (string | Buffer)[],
3905
+ ...patterns: string[],
3853
3906
  desc: "DESC",
3854
3907
  alpha: "ALPHA",
3855
3908
  callback: Callback<unknown>
@@ -3857,7 +3910,7 @@ interface RedisCommander<Context extends ClientContext = {
3857
3910
  sort_ro(...args: [
3858
3911
  key: RedisKey,
3859
3912
  patternToken: "GET",
3860
- ...patterns: (string | Buffer)[],
3913
+ ...patterns: string[],
3861
3914
  desc: "DESC",
3862
3915
  alpha: "ALPHA"
3863
3916
  ]): Result<unknown, Context>;
@@ -3873,7 +3926,7 @@ interface RedisCommander<Context extends ClientContext = {
3873
3926
  offset: number | string,
3874
3927
  count: number | string,
3875
3928
  patternToken: "GET",
3876
- ...patterns: (string | Buffer)[],
3929
+ ...patterns: string[],
3877
3930
  callback: Callback<unknown>
3878
3931
  ]): Result<unknown, Context>;
3879
3932
  sort_ro(...args: [
@@ -3882,7 +3935,7 @@ interface RedisCommander<Context extends ClientContext = {
3882
3935
  offset: number | string,
3883
3936
  count: number | string,
3884
3937
  patternToken: "GET",
3885
- ...patterns: (string | Buffer)[]
3938
+ ...patterns: string[]
3886
3939
  ]): Result<unknown, Context>;
3887
3940
  sort_ro(...args: [
3888
3941
  key: RedisKey,
@@ -3890,7 +3943,7 @@ interface RedisCommander<Context extends ClientContext = {
3890
3943
  offset: number | string,
3891
3944
  count: number | string,
3892
3945
  patternToken: "GET",
3893
- ...patterns: (string | Buffer)[],
3946
+ ...patterns: string[],
3894
3947
  alpha: "ALPHA",
3895
3948
  callback: Callback<unknown>
3896
3949
  ]): Result<unknown, Context>;
@@ -3900,7 +3953,7 @@ interface RedisCommander<Context extends ClientContext = {
3900
3953
  offset: number | string,
3901
3954
  count: number | string,
3902
3955
  patternToken: "GET",
3903
- ...patterns: (string | Buffer)[],
3956
+ ...patterns: string[],
3904
3957
  alpha: "ALPHA"
3905
3958
  ]): Result<unknown, Context>;
3906
3959
  sort_ro(...args: [
@@ -3909,7 +3962,7 @@ interface RedisCommander<Context extends ClientContext = {
3909
3962
  offset: number | string,
3910
3963
  count: number | string,
3911
3964
  patternToken: "GET",
3912
- ...patterns: (string | Buffer)[],
3965
+ ...patterns: string[],
3913
3966
  asc: "ASC",
3914
3967
  callback: Callback<unknown>
3915
3968
  ]): Result<unknown, Context>;
@@ -3919,7 +3972,7 @@ interface RedisCommander<Context extends ClientContext = {
3919
3972
  offset: number | string,
3920
3973
  count: number | string,
3921
3974
  patternToken: "GET",
3922
- ...patterns: (string | Buffer)[],
3975
+ ...patterns: string[],
3923
3976
  asc: "ASC"
3924
3977
  ]): Result<unknown, Context>;
3925
3978
  sort_ro(...args: [
@@ -3928,7 +3981,7 @@ interface RedisCommander<Context extends ClientContext = {
3928
3981
  offset: number | string,
3929
3982
  count: number | string,
3930
3983
  patternToken: "GET",
3931
- ...patterns: (string | Buffer)[],
3984
+ ...patterns: string[],
3932
3985
  asc: "ASC",
3933
3986
  alpha: "ALPHA",
3934
3987
  callback: Callback<unknown>
@@ -3939,7 +3992,7 @@ interface RedisCommander<Context extends ClientContext = {
3939
3992
  offset: number | string,
3940
3993
  count: number | string,
3941
3994
  patternToken: "GET",
3942
- ...patterns: (string | Buffer)[],
3995
+ ...patterns: string[],
3943
3996
  asc: "ASC",
3944
3997
  alpha: "ALPHA"
3945
3998
  ]): Result<unknown, Context>;
@@ -3949,7 +4002,7 @@ interface RedisCommander<Context extends ClientContext = {
3949
4002
  offset: number | string,
3950
4003
  count: number | string,
3951
4004
  patternToken: "GET",
3952
- ...patterns: (string | Buffer)[],
4005
+ ...patterns: string[],
3953
4006
  desc: "DESC",
3954
4007
  callback: Callback<unknown>
3955
4008
  ]): Result<unknown, Context>;
@@ -3959,7 +4012,7 @@ interface RedisCommander<Context extends ClientContext = {
3959
4012
  offset: number | string,
3960
4013
  count: number | string,
3961
4014
  patternToken: "GET",
3962
- ...patterns: (string | Buffer)[],
4015
+ ...patterns: string[],
3963
4016
  desc: "DESC"
3964
4017
  ]): Result<unknown, Context>;
3965
4018
  sort_ro(...args: [
@@ -3968,7 +4021,7 @@ interface RedisCommander<Context extends ClientContext = {
3968
4021
  offset: number | string,
3969
4022
  count: number | string,
3970
4023
  patternToken: "GET",
3971
- ...patterns: (string | Buffer)[],
4024
+ ...patterns: string[],
3972
4025
  desc: "DESC",
3973
4026
  alpha: "ALPHA",
3974
4027
  callback: Callback<unknown>
@@ -3979,7 +4032,7 @@ interface RedisCommander<Context extends ClientContext = {
3979
4032
  offset: number | string,
3980
4033
  count: number | string,
3981
4034
  patternToken: "GET",
3982
- ...patterns: (string | Buffer)[],
4035
+ ...patterns: string[],
3983
4036
  desc: "DESC",
3984
4037
  alpha: "ALPHA"
3985
4038
  ]): Result<unknown, Context>;
@@ -3994,7 +4047,7 @@ interface RedisCommander<Context extends ClientContext = {
3994
4047
  patternToken: "BY",
3995
4048
  pattern: string,
3996
4049
  patternToken1: "GET",
3997
- ...pattern1s: (string | Buffer)[],
4050
+ ...pattern1s: string[],
3998
4051
  callback: Callback<unknown>
3999
4052
  ]): Result<unknown, Context>;
4000
4053
  sort_ro(...args: [
@@ -4002,14 +4055,14 @@ interface RedisCommander<Context extends ClientContext = {
4002
4055
  patternToken: "BY",
4003
4056
  pattern: string,
4004
4057
  patternToken1: "GET",
4005
- ...pattern1s: (string | Buffer)[]
4058
+ ...pattern1s: string[]
4006
4059
  ]): Result<unknown, Context>;
4007
4060
  sort_ro(...args: [
4008
4061
  key: RedisKey,
4009
4062
  patternToken: "BY",
4010
4063
  pattern: string,
4011
4064
  patternToken1: "GET",
4012
- ...pattern1s: (string | Buffer)[],
4065
+ ...pattern1s: string[],
4013
4066
  alpha: "ALPHA",
4014
4067
  callback: Callback<unknown>
4015
4068
  ]): Result<unknown, Context>;
@@ -4018,7 +4071,7 @@ interface RedisCommander<Context extends ClientContext = {
4018
4071
  patternToken: "BY",
4019
4072
  pattern: string,
4020
4073
  patternToken1: "GET",
4021
- ...pattern1s: (string | Buffer)[],
4074
+ ...pattern1s: string[],
4022
4075
  alpha: "ALPHA"
4023
4076
  ]): Result<unknown, Context>;
4024
4077
  sort_ro(...args: [
@@ -4026,7 +4079,7 @@ interface RedisCommander<Context extends ClientContext = {
4026
4079
  patternToken: "BY",
4027
4080
  pattern: string,
4028
4081
  patternToken1: "GET",
4029
- ...pattern1s: (string | Buffer)[],
4082
+ ...pattern1s: string[],
4030
4083
  asc: "ASC",
4031
4084
  callback: Callback<unknown>
4032
4085
  ]): Result<unknown, Context>;
@@ -4035,7 +4088,7 @@ interface RedisCommander<Context extends ClientContext = {
4035
4088
  patternToken: "BY",
4036
4089
  pattern: string,
4037
4090
  patternToken1: "GET",
4038
- ...pattern1s: (string | Buffer)[],
4091
+ ...pattern1s: string[],
4039
4092
  asc: "ASC"
4040
4093
  ]): Result<unknown, Context>;
4041
4094
  sort_ro(...args: [
@@ -4043,7 +4096,7 @@ interface RedisCommander<Context extends ClientContext = {
4043
4096
  patternToken: "BY",
4044
4097
  pattern: string,
4045
4098
  patternToken1: "GET",
4046
- ...pattern1s: (string | Buffer)[],
4099
+ ...pattern1s: string[],
4047
4100
  asc: "ASC",
4048
4101
  alpha: "ALPHA",
4049
4102
  callback: Callback<unknown>
@@ -4053,7 +4106,7 @@ interface RedisCommander<Context extends ClientContext = {
4053
4106
  patternToken: "BY",
4054
4107
  pattern: string,
4055
4108
  patternToken1: "GET",
4056
- ...pattern1s: (string | Buffer)[],
4109
+ ...pattern1s: string[],
4057
4110
  asc: "ASC",
4058
4111
  alpha: "ALPHA"
4059
4112
  ]): Result<unknown, Context>;
@@ -4062,7 +4115,7 @@ interface RedisCommander<Context extends ClientContext = {
4062
4115
  patternToken: "BY",
4063
4116
  pattern: string,
4064
4117
  patternToken1: "GET",
4065
- ...pattern1s: (string | Buffer)[],
4118
+ ...pattern1s: string[],
4066
4119
  desc: "DESC",
4067
4120
  callback: Callback<unknown>
4068
4121
  ]): Result<unknown, Context>;
@@ -4071,7 +4124,7 @@ interface RedisCommander<Context extends ClientContext = {
4071
4124
  patternToken: "BY",
4072
4125
  pattern: string,
4073
4126
  patternToken1: "GET",
4074
- ...pattern1s: (string | Buffer)[],
4127
+ ...pattern1s: string[],
4075
4128
  desc: "DESC"
4076
4129
  ]): Result<unknown, Context>;
4077
4130
  sort_ro(...args: [
@@ -4079,7 +4132,7 @@ interface RedisCommander<Context extends ClientContext = {
4079
4132
  patternToken: "BY",
4080
4133
  pattern: string,
4081
4134
  patternToken1: "GET",
4082
- ...pattern1s: (string | Buffer)[],
4135
+ ...pattern1s: string[],
4083
4136
  desc: "DESC",
4084
4137
  alpha: "ALPHA",
4085
4138
  callback: Callback<unknown>
@@ -4089,7 +4142,7 @@ interface RedisCommander<Context extends ClientContext = {
4089
4142
  patternToken: "BY",
4090
4143
  pattern: string,
4091
4144
  patternToken1: "GET",
4092
- ...pattern1s: (string | Buffer)[],
4145
+ ...pattern1s: string[],
4093
4146
  desc: "DESC",
4094
4147
  alpha: "ALPHA"
4095
4148
  ]): Result<unknown, Context>;
@@ -4107,7 +4160,7 @@ interface RedisCommander<Context extends ClientContext = {
4107
4160
  offset: number | string,
4108
4161
  count: number | string,
4109
4162
  patternToken1: "GET",
4110
- ...pattern1s: (string | Buffer)[],
4163
+ ...pattern1s: string[],
4111
4164
  callback: Callback<unknown>
4112
4165
  ]): Result<unknown, Context>;
4113
4166
  sort_ro(...args: [
@@ -4118,7 +4171,7 @@ interface RedisCommander<Context extends ClientContext = {
4118
4171
  offset: number | string,
4119
4172
  count: number | string,
4120
4173
  patternToken1: "GET",
4121
- ...pattern1s: (string | Buffer)[]
4174
+ ...pattern1s: string[]
4122
4175
  ]): Result<unknown, Context>;
4123
4176
  sort_ro(...args: [
4124
4177
  key: RedisKey,
@@ -4128,7 +4181,7 @@ interface RedisCommander<Context extends ClientContext = {
4128
4181
  offset: number | string,
4129
4182
  count: number | string,
4130
4183
  patternToken1: "GET",
4131
- ...pattern1s: (string | Buffer)[],
4184
+ ...pattern1s: string[],
4132
4185
  alpha: "ALPHA",
4133
4186
  callback: Callback<unknown>
4134
4187
  ]): Result<unknown, Context>;
@@ -4140,7 +4193,7 @@ interface RedisCommander<Context extends ClientContext = {
4140
4193
  offset: number | string,
4141
4194
  count: number | string,
4142
4195
  patternToken1: "GET",
4143
- ...pattern1s: (string | Buffer)[],
4196
+ ...pattern1s: string[],
4144
4197
  alpha: "ALPHA"
4145
4198
  ]): Result<unknown, Context>;
4146
4199
  sort_ro(...args: [
@@ -4151,7 +4204,7 @@ interface RedisCommander<Context extends ClientContext = {
4151
4204
  offset: number | string,
4152
4205
  count: number | string,
4153
4206
  patternToken1: "GET",
4154
- ...pattern1s: (string | Buffer)[],
4207
+ ...pattern1s: string[],
4155
4208
  asc: "ASC",
4156
4209
  callback: Callback<unknown>
4157
4210
  ]): Result<unknown, Context>;
@@ -4163,7 +4216,7 @@ interface RedisCommander<Context extends ClientContext = {
4163
4216
  offset: number | string,
4164
4217
  count: number | string,
4165
4218
  patternToken1: "GET",
4166
- ...pattern1s: (string | Buffer)[],
4219
+ ...pattern1s: string[],
4167
4220
  asc: "ASC"
4168
4221
  ]): Result<unknown, Context>;
4169
4222
  sort_ro(...args: [
@@ -4174,7 +4227,7 @@ interface RedisCommander<Context extends ClientContext = {
4174
4227
  offset: number | string,
4175
4228
  count: number | string,
4176
4229
  patternToken1: "GET",
4177
- ...pattern1s: (string | Buffer)[],
4230
+ ...pattern1s: string[],
4178
4231
  asc: "ASC",
4179
4232
  alpha: "ALPHA",
4180
4233
  callback: Callback<unknown>
@@ -4187,7 +4240,7 @@ interface RedisCommander<Context extends ClientContext = {
4187
4240
  offset: number | string,
4188
4241
  count: number | string,
4189
4242
  patternToken1: "GET",
4190
- ...pattern1s: (string | Buffer)[],
4243
+ ...pattern1s: string[],
4191
4244
  asc: "ASC",
4192
4245
  alpha: "ALPHA"
4193
4246
  ]): Result<unknown, Context>;
@@ -4199,7 +4252,7 @@ interface RedisCommander<Context extends ClientContext = {
4199
4252
  offset: number | string,
4200
4253
  count: number | string,
4201
4254
  patternToken1: "GET",
4202
- ...pattern1s: (string | Buffer)[],
4255
+ ...pattern1s: string[],
4203
4256
  desc: "DESC",
4204
4257
  callback: Callback<unknown>
4205
4258
  ]): Result<unknown, Context>;
@@ -4211,7 +4264,7 @@ interface RedisCommander<Context extends ClientContext = {
4211
4264
  offset: number | string,
4212
4265
  count: number | string,
4213
4266
  patternToken1: "GET",
4214
- ...pattern1s: (string | Buffer)[],
4267
+ ...pattern1s: string[],
4215
4268
  desc: "DESC"
4216
4269
  ]): Result<unknown, Context>;
4217
4270
  sort_ro(...args: [
@@ -4222,7 +4275,7 @@ interface RedisCommander<Context extends ClientContext = {
4222
4275
  offset: number | string,
4223
4276
  count: number | string,
4224
4277
  patternToken1: "GET",
4225
- ...pattern1s: (string | Buffer)[],
4278
+ ...pattern1s: string[],
4226
4279
  desc: "DESC",
4227
4280
  alpha: "ALPHA",
4228
4281
  callback: Callback<unknown>
@@ -4235,7 +4288,7 @@ interface RedisCommander<Context extends ClientContext = {
4235
4288
  offset: number | string,
4236
4289
  count: number | string,
4237
4290
  patternToken1: "GET",
4238
- ...pattern1s: (string | Buffer)[],
4291
+ ...pattern1s: string[],
4239
4292
  desc: "DESC",
4240
4293
  alpha: "ALPHA"
4241
4294
  ]): Result<unknown, Context>;
@@ -4255,7 +4308,7 @@ interface RedisCommander<Context extends ClientContext = {
4255
4308
  * - _complexity_: O(N) where N is the number of clients subscribed to the receiving shard channel.
4256
4309
  * - _since_: 7.0.0
4257
4310
  */
4258
- spublish(channel: string | Buffer, message: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
4311
+ spublish(shardchannel: string | Buffer, message: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
4259
4312
  /**
4260
4313
  * Get one or multiple random members from a set
4261
4314
  * - _group_: set
@@ -4304,8 +4357,11 @@ interface RedisCommander<Context extends ClientContext = {
4304
4357
  * - _complexity_: O(N) where N is the number of shard channels to subscribe to.
4305
4358
  * - _since_: 7.0.0
4306
4359
  */
4307
- ssubscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Result<unknown, Context>;
4308
- ssubscribe(...args: [...channels: (string | Buffer)[]]): Result<unknown, Context>;
4360
+ ssubscribe(...args: [
4361
+ ...shardchannels: (string | Buffer)[],
4362
+ callback: Callback<unknown>
4363
+ ]): Result<unknown, Context>;
4364
+ ssubscribe(...args: [...shardchannels: (string | Buffer)[]]): Result<unknown, Context>;
4309
4365
  /**
4310
4366
  * Get the length of the value stored in a key
4311
4367
  * - _group_: string
@@ -4363,12 +4419,15 @@ interface RedisCommander<Context extends ClientContext = {
4363
4419
  /**
4364
4420
  * Stop listening for messages posted to the given shard channels
4365
4421
  * - _group_: pubsub
4366
- * - _complexity_: O(N) where N is the number of clients already subscribed to a channel.
4422
+ * - _complexity_: O(N) where N is the number of clients already subscribed to a shard channel.
4367
4423
  * - _since_: 7.0.0
4368
4424
  */
4369
4425
  sunsubscribe(callback?: Callback<unknown>): Result<unknown, Context>;
4370
- sunsubscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Result<unknown, Context>;
4371
- sunsubscribe(...args: [...channels: (string | Buffer)[]]): Result<unknown, Context>;
4426
+ sunsubscribe(...args: [
4427
+ ...shardchannels: (string | Buffer)[],
4428
+ callback: Callback<unknown>
4429
+ ]): Result<unknown, Context>;
4430
+ sunsubscribe(...args: [...shardchannels: (string | Buffer)[]]): Result<unknown, Context>;
4372
4431
  /**
4373
4432
  * Swaps two Redis databases
4374
4433
  * - _group_: server
package/built/utils/RedisCommander.js CHANGED
@@ -1,2 +1,7 @@
1
1
  "use strict";
2
+ /**
3
+ * This file is generated by @ioredis/interface-generator.
4
+ * Don't edit it manually. Instead, run `npm run generate` to update
5
+ * this file.
6
+ */
2
7
  Object.defineProperty(exports, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ioredis",
3
- "version": "5.0.4",
3
+ "version": "5.1.0",
4
4
  "description": "A robust, performance-focused and full-featured Redis client for Node.js.",
5
5
  "main": "./built/index.js",
6
6
  "types": "./built/index.d.ts",
@@ -52,7 +52,7 @@
52
52
  "standard-as-callback": "^2.1.0"
53
53
  },
54
54
  "devDependencies": {
55
- "@ioredis/interface-generator": "^1.2.1",
55
+ "@ioredis/interface-generator": "^1.3.0",
56
56
  "@semantic-release/changelog": "^6.0.1",
57
57
  "@semantic-release/commit-analyzer": "^9.0.2",
58
58
  "@semantic-release/git": "^10.0.1",