platform-admin/boc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: Passwordless cross-device authentication

Browse Source 
- Arkitektur: docs/auth/passwordless-architecture.md
- Backend: iom/quixzoom-auth-service/ (FastAPI + Redis)
- Webb: quixzoom-market-pages/se/login/ (QR-kod + polling)
- App: iom/quixzoom-app/src/features/auth/ (push + deep links)

Flöde: QR-kod → app-godkännande → webb-inloggad
This commit is contained in:
Bernt
2026-07-07 07:11:50 +00:00
parent 4aa984ad74
commit 6989a98d75
61843 changed files with 5491611 additions and 872231 deletions
Download Patch File Download Diff File Expand all files Collapse all files
landvex/node_modules/ioredis/LICENSE
Generated Vendored
+21
View File
@@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2015-2022 Zihua Li
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
landvex/node_modules/ioredis/README.md
Generated Vendored
+1548
View File
@@ -0,0 +1,1548 @@
[![ioredis](https://cdn.jsdelivr.net/gh/redis/ioredis@b5e8c74/logo.svg)](https://github.com/redis/ioredis)
[![Build Status](https://github.com/redis/ioredis/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/redis/ioredis/actions/workflows/release.yml?query=branch%3Amain)
[![Coverage Status](https://coveralls.io/repos/github/luin/ioredis/badge.svg?branch=main)](https://coveralls.io/github/luin/ioredis?branch=main)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Discord](https://img.shields.io/discord/697882427875393627.svg?style=social&logo=discord)](https://discord.gg/redis)
[![Twitch](https://img.shields.io/twitch/status/redisinc?style=social)](https://www.twitch.tv/redisinc)
[![YouTube](https://img.shields.io/youtube/channel/views/UCD78lHSwYqMlyetR0_P4Vig?style=social)](https://www.youtube.com/redisinc)
[![Twitter](https://img.shields.io/twitter/follow/redisinc?style=social)](https://twitter.com/redisinc)
A robust, performance-focused and full-featured [Redis](http://redis.io) client for [Node.js](https://nodejs.org).
Supports Redis >= 2.6.12. Completely compatible with Redis 7.x.
ioredis is a stable project and maintenance is done on a best-effort basis for relevant issues (contributions to ioredis will still be evaluated, reviewed, and merged when they benefit the project). For new projects, node-redis is the recommended client library. [node-redis](https://github.com/redis/node-redis) is the open-source (MIT license) Redis JavaScript client library redesigned from the ground up and actively maintained. [node-redis](https://github.com/redis/node-redis) supports new (hash-field expiration) and future commands and the capabilities available in Redis Stack and Redis 8 (search, JSON, time-series, probabilistic data structures).
# Features
ioredis is a robust, full-featured Redis client that is
used in the world's biggest online commerce company [Alibaba](http://www.alibaba.com/) and many other awesome companies.
0. Full-featured. It supports [Cluster](http://redis.io/topics/cluster-tutorial), [Sentinel](https://redis.io/docs/latest/operate/oss_and_stack/management/sentinel/), [Streams](https://redis.io/topics/streams-intro), [Pipelining](http://redis.io/topics/pipelining), and of course [Lua scripting](http://redis.io/commands/eval), [Redis Functions](https://redis.io/topics/functions-intro), [Pub/Sub](http://redis.io/topics/pubsub) (with the support of binary messages).
1. High performance 🚀.
2. Delightful API 😄. It works with Node callbacks and Native promises.
3. Transformation of command arguments and replies.
4. Transparent key prefixing.
5. Abstraction for Lua scripting, allowing you to [define custom commands](https://github.com/redis/ioredis#lua-scripting).
6. Supports [binary data](https://github.com/redis/ioredis#handle-binary-data).
7. Supports [TLS](https://github.com/redis/ioredis#tls-options) 🔒.
8. Supports offline queue and ready checking.
9. Supports ES6 types, such as `Map` and `Set`.
10. Supports GEO commands 📍.
11. Supports Redis ACL.
12. Sophisticated error handling strategy.
13. Supports NAT mapping.
14. Supports autopipelining.
**100% written in TypeScript and official declarations are provided:**
<img width="837" src="resources/ts-screenshot.png" alt="TypeScript Screenshot" />
# Versions
| Version | Branch | Node.js Version | Redis Version |
| -------------- | ------ | --------------- | --------------- |
| 5.x.x (latest) | main | >= 12 | 2.6.12 ~ latest |
| 4.x.x | v4 | >= 8 | 2.6.12 ~ 7 |
Refer to [CHANGELOG.md](CHANGELOG.md) for features and bug fixes introduced in v5.
🚀 [Upgrading from v4 to v5](https://github.com/redis/ioredis/wiki/Upgrading-from-v4-to-v5)
# Links
- [API Documentation](https://redis.github.io/ioredis/) ([Redis](https://redis.github.io/ioredis/classes/Redis.html), [Cluster](https://redis.github.io/ioredis/classes/Cluster.html))
- [Changelog](CHANGELOG.md)
<hr>
# Quick Start
## Install
```shell
npm install ioredis
```
In a TypeScript project, you may want to add TypeScript declarations for Node.js:
```shell
npm install --save-dev @types/node
```
## Basic Usage
```javascript
// Import ioredis.
// You can also use `import { Redis } from "ioredis"`
// if your project is a TypeScript project,
// Note that `import Redis from "ioredis"` is still supported,
// but will be deprecated in the next major version.
const Redis = require("ioredis");
// Create a Redis instance.
// By default, it will connect to localhost:6379.
// We are going to cover how to specify connection options soon.
const redis = new Redis();
redis.set("mykey", "value"); // Returns a promise which resolves to "OK" when the command succeeds.
// ioredis supports the node.js callback style
redis.get("mykey", (err, result) => {
if (err) {
console.error(err);
} else {
console.log(result); // Prints "value"
}
});
// Or ioredis returns a promise if the last argument isn't a function
redis.get("mykey").then((result) => {
console.log(result); // Prints "value"
});
redis.zadd("sortedSet", 1, "one", 2, "dos", 4, "quatro", 3, "three");
redis.zrange("sortedSet", 0, 2, "WITHSCORES").then((elements) => {
// ["one", "1", "dos", "2", "three", "3"] as if the command was `redis> ZRANGE sortedSet 0 2 WITHSCORES`
console.log(elements);
});
// All arguments are passed directly to the redis server,
// so technically ioredis supports all Redis commands.
// The format is: redis[SOME_REDIS_COMMAND_IN_LOWERCASE](ARGUMENTS_ARE_JOINED_INTO_COMMAND_STRING)
// so the following statement is equivalent to the CLI: `redis> SET mykey hello EX 10`
redis.set("mykey", "hello", "EX", 10);
```
See the `examples/` folder for more examples. For example:
- [TTL](examples/ttl.js)
- [Strings](examples/string.js)
- [Hashes](examples/hash.js)
- [Lists](examples/list.js)
- [Sets](examples/set.js)
- [Sorted Sets](examples/zset.js)
- [Streams](examples/stream.js)
- [Redis Modules](examples/module.js) e.g. RedisJSON
All Redis commands are supported. See [the documentation](https://redis.github.io/ioredis/classes/Redis.html) for details.
## Connect to Redis
When a new `Redis` instance is created,
a connection to Redis will be created at the same time.
You can specify which Redis to connect to by:
```javascript
new Redis(); // Connect to 127.0.0.1:6379
new Redis(6380); // 127.0.0.1:6380
new Redis(6379, "192.168.1.1"); // 192.168.1.1:6379
new Redis("/tmp/redis.sock");
new Redis({
port: 6379, // Redis port
host: "127.0.0.1", // Redis host
username: "default", // needs Redis >= 6
password: "my-top-secret",
db: 0, // Defaults to 0
});
```
You can also specify connection options as a [`redis://` URL](http://www.iana.org/assignments/uri-schemes/prov/redis) or [`rediss://` URL](https://www.iana.org/assignments/uri-schemes/prov/rediss) when using [TLS encryption](#tls-options):
```javascript
// Connect to 127.0.0.1:6380, db 4, using password "authpassword":
new Redis("redis://:authpassword@127.0.0.1:6380/4");
// Username can also be passed via URI.
new Redis("redis://username:authpassword@127.0.0.1:6380/4");
```
See [API Documentation](https://redis.github.io/ioredis/index.html#RedisOptions) for all available options.
## Pub/Sub
Redis provides several commands for developers to implement the [Publish–subscribe pattern](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern). There are two roles in this pattern: publisher and subscriber. Publishers are not programmed to send their messages to specific subscribers. Rather, published messages are characterized into channels, without knowledge of what (if any) subscribers there may be.
By leveraging Node.js's built-in events module, ioredis makes pub/sub very straightforward to use. Below is a simple example that consists of two files, one is publisher.js that publishes messages to a channel, the other is subscriber.js that listens for messages on specific channels.
```javascript
// publisher.js
const Redis = require("ioredis");
const redis = new Redis();
setInterval(() => {
const message = { foo: Math.random() };
// Publish to my-channel-1 or my-channel-2 randomly.
const channel = `my-channel-${1 + Math.round(Math.random())}`;
// Message can be either a string or a buffer
redis.publish(channel, JSON.stringify(message));
console.log("Published %s to %s", message, channel);
}, 1000);
```
```javascript
// subscriber.js
const Redis = require("ioredis");
const redis = new Redis();
redis.subscribe("my-channel-1", "my-channel-2", (err, count) => {
if (err) {
// Just like other commands, subscribe() can fail for some reasons,
// ex network issues.
console.error("Failed to subscribe: %s", err.message);
} else {
// `count` represents the number of channels this client are currently subscribed to.
console.log(
`Subscribed successfully! This client is currently subscribed to ${count} channels.`
);
}
});
redis.on("message", (channel, message) => {
console.log(`Received ${message} from ${channel}`);
});
// There's also an event called 'messageBuffer', which is the same as 'message' except
// it returns buffers instead of strings.
// It's useful when the messages are binary data.
redis.on("messageBuffer", (channel, message) => {
// Both `channel` and `message` are buffers.
console.log(channel, message);
});
```
It's worth noticing that a connection (aka a `Redis` instance) can't play both roles at the same time. More specifically, when a client issues `subscribe()` or `psubscribe()`, it enters the "subscriber" mode. From that point, only commands that modify the subscription set are valid. Namely, they are: `subscribe`, `psubscribe`, `unsubscribe`, `punsubscribe`, `ping`, and `quit`. When the subscription set is empty (via `unsubscribe`/`punsubscribe`), the connection is put back into the regular mode.
If you want to do pub/sub in the same file/process, you should create a separate connection:
```javascript
const Redis = require("ioredis");
const sub = new Redis();
const pub = new Redis();
sub.subscribe(/* ... */); // From now, `sub` enters the subscriber mode.
sub.on("message" /* ... */);
setInterval(() => {
// `pub` can be used to publish messages, or send other regular commands (e.g. `hgetall`)
// because it's not in the subscriber mode.
pub.publish(/* ... */);
}, 1000);
```
`PSUBSCRIBE` is also supported in a similar way when you want to subscribe all channels whose name matches a pattern:
```javascript
redis.psubscribe("pat?ern", (err, count) => {});
// Event names are "pmessage"/"pmessageBuffer" instead of "message/messageBuffer".
redis.on("pmessage", (pattern, channel, message) => {});
redis.on("pmessageBuffer", (pattern, channel, message) => {});
```
## Streams
Redis v5 introduces a new data type called streams. It doubles as a communication channel for building streaming architectures and as a log-like data structure for persisting data. With ioredis, the usage can be pretty straightforward. Say we have a producer publishes messages to a stream with `redis.xadd("mystream", "*", "randomValue", Math.random())` (You may find the [official documentation of Streams](https://redis.io/topics/streams-intro) as a starter to understand the parameters used), to consume the messages, we'll have a consumer with the following code:
```javascript
const Redis = require("ioredis");
const redis = new Redis();
const processMessage = (message) => {
console.log("Id: %s. Data: %O", message[0], message[1]);
};
async function listenForMessage(lastId = "$") {
// `results` is an array, each element of which corresponds to a key.
// Because we only listen to one key (mystream) here, `results` only contains
// a single element. See more: https://redis.io/commands/xread#return-value
const results = await redis.xread("BLOCK", 0, "STREAMS", "mystream", lastId);
const [key, messages] = results[0]; // `key` equals to "mystream"
messages.forEach(processMessage);
// Pass the last id of the results to the next round.
await listenForMessage(messages[messages.length - 1][0]);
}
listenForMessage();
```
## Expiration
Redis can set a timeout to expire your key, after the timeout has expired the key will be automatically deleted. (You can find the [official Expire documentation](https://redis.io/commands/expire/) to understand better the different parameters you can use), to set your key to expire in 60 seconds, we will have the following code:
```javascript
redis.set("key", "data", "EX", 60);
// Equivalent to redis command "SET key data EX 60", because on ioredis set method,
// all arguments are passed directly to the redis server.
```
## Handle Binary Data
Binary data support is out of the box. Pass buffers to send binary data:
```javascript
redis.set("foo", Buffer.from([0x62, 0x75, 0x66]));
```
Every command that returns a [bulk string](https://redis.io/docs/reference/protocol-spec/#resp-bulk-strings)
has a variant command with a `Buffer` suffix. The variant command returns a buffer instead of a UTF-8 string:
```javascript
const result = await redis.getBuffer("foo");
// result is `<Buffer 62 75 66>`
```
It's worth noticing that you don't need the `Buffer` suffix variant in order to **send** binary data. That means
in most case you should just use `redis.set()` instead of `redis.setBuffer()` unless you want to get the old value
with the `GET` parameter:
```javascript
const result = await redis.setBuffer("foo", "new value", "GET");
// result is `<Buffer 62 75 66>` as `GET` indicates returning the old value.
```
## Pipelining
If you want to send a batch of commands (e.g. > 5), you can use pipelining to queue
the commands in memory and then send them to Redis all at once. This way the performance improves by 50%~300% (See [benchmark section](#benchmarks)).
`redis.pipeline()` creates a `Pipeline` instance. You can call any Redis
commands on it just like the `Redis` instance. The commands are queued in memory
and flushed to Redis by calling the `exec` method:
```javascript
const pipeline = redis.pipeline();
pipeline.set("foo", "bar");
pipeline.del("cc");
pipeline.exec((err, results) => {
// `err` is always null, and `results` is an array of responses
// corresponding to the sequence of queued commands.
// Each response follows the format `[err, result]`.
});
// You can even chain the commands:
redis
.pipeline()
.set("foo", "bar")
.del("cc")
.exec((err, results) => {});
// `exec` also returns a Promise:
const promise = redis.pipeline().set("foo", "bar").get("foo").exec();
promise.then((result) => {
// result === [[null, 'OK'], [null, 'bar']]
});
```
Each chained command can also have a callback, which will be invoked when the command
gets a reply:
```javascript
redis
.pipeline()
.set("foo", "bar")
.get("foo", (err, result) => {
// result === 'bar'
})
.exec((err, result) => {
// result[1][1] === 'bar'
});
```
In addition to adding commands to the `pipeline` queue individually, you can also pass an array of commands and arguments to the constructor:
```javascript
redis
.pipeline([
["set", "foo", "bar"],
["get", "foo"],
])
.exec(() => {
/* ... */
});
```
`#length` property shows how many commands in the pipeline:
```javascript
const length = redis.pipeline().set("foo", "bar").get("foo").length;
// length === 2
```
## Transaction
Most of the time, the transaction commands `multi` & `exec` are used together with pipeline.
Therefore, when `multi` is called, a `Pipeline` instance is created automatically by default,
so you can use `multi` just like `pipeline`:
```javascript
redis
.multi()
.set("foo", "bar")
.get("foo")
.exec((err, results) => {
// results === [[null, 'OK'], [null, 'bar']]
});
```
If there's a syntax error in the transaction's command chain (e.g. wrong number of arguments, wrong command name, etc),
then none of the commands would be executed, and an error is returned:
```javascript
redis
.multi()
.set("foo")
.set("foo", "new value")
.exec((err, results) => {
// err:
// { [ReplyError: EXECABORT Transaction discarded because of previous errors.]
// name: 'ReplyError',
// message: 'EXECABORT Transaction discarded because of previous errors.',
// command: { name: 'exec', args: [] },
// previousErrors:
// [ { [ReplyError: ERR wrong number of arguments for 'set' command]
// name: 'ReplyError',
// message: 'ERR wrong number of arguments for \'set\' command',
// command: [Object] } ] }
});
```
In terms of the interface, `multi` differs from `pipeline` in that when specifying a callback
to each chained command, the queueing state is passed to the callback instead of the result of the command:
```javascript
redis
.multi()
.set("foo", "bar", (err, result) => {
// result === 'QUEUED'
})
.exec(/* ... */);
```
If you want to use transaction without pipeline, pass `{ pipeline: false }` to `multi`,
and every command will be sent to Redis immediately without waiting for an `exec` invocation:
```javascript
redis.multi({ pipeline: false });
redis.set("foo", "bar");
redis.get("foo");
redis.exec((err, result) => {
// result === [[null, 'OK'], [null, 'bar']]
});
```
The constructor of `multi` also accepts a batch of commands:
```javascript
redis
.multi([
["set", "foo", "bar"],
["get", "foo"],
])
.exec(() => {
/* ... */
});
```
Inline transactions are supported by pipeline, which means you can group a subset of commands
in the pipeline into a transaction:
```javascript
redis
.pipeline()
.get("foo")
.multi()
.set("foo", "bar")
.get("foo")
.exec()
.get("foo")
.exec();
```
## Lua Scripting
ioredis supports all of the scripting commands such as `EVAL`, `EVALSHA` and `SCRIPT`.
However, it's tedious to use in real world scenarios since developers have to take
care of script caching and to detect when to use `EVAL` and when to use `EVALSHA`.
ioredis exposes a `defineCommand` method to make scripting much easier to use:
```javascript
const redis = new Redis();
// This will define a command myecho:
redis.defineCommand("myecho", {
numberOfKeys: 2,
lua: "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}",
});
// Now `myecho` can be used just like any other ordinary command,
// and ioredis will try to use `EVALSHA` internally when possible for better performance.
redis.myecho("k1", "k2", "a1", "a2", (err, result) => {
// result === ['k1', 'k2', 'a1', 'a2']
});
// `myechoBuffer` is also defined automatically to return buffers instead of strings:
redis.myechoBuffer("k1", "k2", "a1", "a2", (err, result) => {
// result[0] equals to Buffer.from('k1');
});
// And of course it works with pipeline:
redis.pipeline().set("foo", "bar").myecho("k1", "k2", "a1", "a2").exec();
```
### Dynamic Keys
If the number of keys can't be determined when defining a command, you can
omit the `numberOfKeys` property and pass the number of keys as the first argument
when you call the command:
```javascript
redis.defineCommand("echoDynamicKeyNumber", {
lua: "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}",
});
// Now you have to pass the number of keys as the first argument every time
// you invoke the `echoDynamicKeyNumber` command:
redis.echoDynamicKeyNumber(2, "k1", "k2", "a1", "a2", (err, result) => {
// result === ['k1', 'k2', 'a1', 'a2']
});
```
### As Constructor Options
Besides `defineCommand()`, you can also define custom commands with the `scripts` constructor option:
```javascript
const redis = new Redis({
scripts: {
myecho: {
numberOfKeys: 2,
lua: "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}",
},
},
});
```
### TypeScript Usages
You can refer to [the example](examples/typescript/scripts.ts) for how to declare your custom commands.
## Transparent Key Prefixing
This feature allows you to specify a string that will automatically be prepended
to all the keys in a command, which makes it easier to manage your key
namespaces.
**Warning** This feature won't apply to commands like [KEYS](http://redis.io/commands/KEYS) and [SCAN](http://redis.io/commands/scan) that take patterns rather than actual keys([#239](https://github.com/redis/ioredis/issues/239)),
and this feature also won't apply to the replies of commands even if they are key names ([#325](https://github.com/redis/ioredis/issues/325)).
```javascript
const fooRedis = new Redis({ keyPrefix: "foo:" });
fooRedis.set("bar", "baz"); // Actually sends SET foo:bar baz
fooRedis.defineCommand("myecho", {
numberOfKeys: 2,
lua: "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}",
});
// Works well with pipelining/transaction
fooRedis
.pipeline()
// Sends SORT foo:list BY foo:weight_*->fieldname
.sort("list", "BY", "weight_*->fieldname")
// Supports custom commands
// Sends EVALSHA xxx foo:k1 foo:k2 a1 a2
.myecho("k1", "k2", "a1", "a2")
.exec();
```
## Transforming Arguments & Replies
Most Redis commands take one or more Strings as arguments,
and replies are sent back as a single String or an Array of Strings. However, sometimes
you may want something different. For instance, it would be more convenient if the `HGETALL`
command returns a hash (e.g. `{ key: val1, key2: v2 }`) rather than an array of key values (e.g. `[key1, val1, key2, val2]`).
ioredis has a flexible system for transforming arguments and replies. There are two types
of transformers, argument transformer and reply transformer:
```javascript
const Redis = require("ioredis");
// Here's the built-in argument transformer converting
// hmset('key', { k1: 'v1', k2: 'v2' })
// or
// hmset('key', new Map([['k1', 'v1'], ['k2', 'v2']]))
// into
// hmset('key', 'k1', 'v1', 'k2', 'v2')
Redis.Command.setArgumentTransformer("hmset", (args) => {
if (args.length === 2) {
if (args[1] instanceof Map) {
// utils is a internal module of ioredis
return [args[0], ...utils.convertMapToArray(args[1])];
}
if (typeof args[1] === "object" && args[1] !== null) {
return [args[0], ...utils.convertObjectToArray(args[1])];
}
}
return args;
});
// Here's the built-in reply transformer converting the HGETALL reply
// ['k1', 'v1', 'k2', 'v2']
// into
// { k1: 'v1', 'k2': 'v2' }
Redis.Command.setReplyTransformer("hgetall", (result) => {
if (Array.isArray(result)) {
const obj = {};
for (let i = 0; i < result.length; i += 2) {
obj[result[i]] = result[i + 1];
}
return obj;
}
return result;
});
```
There are three built-in transformers, two argument transformers for `hmset` & `mset` and
a reply transformer for `hgetall`. Transformers for `hmset` and `hgetall` were mentioned
above, and the transformer for `mset` is similar to the one for `hmset`:
```javascript
redis.mset({ k1: "v1", k2: "v2" });
redis.get("k1", (err, result) => {
// result === 'v1';
});
redis.mset(
new Map([
["k3", "v3"],
["k4", "v4"],
])
);
redis.get("k3", (err, result) => {
// result === 'v3';
});
```
Another useful example of a reply transformer is one that changes `hgetall` to return array of arrays instead of objects which avoids an unwanted conversation of hash keys to strings when dealing with binary hash keys:
```javascript
Redis.Command.setReplyTransformer("hgetall", (result) => {
const arr = [];
for (let i = 0; i < result.length; i += 2) {
arr.push([result[i], result[i + 1]]);
}
return arr;
});
redis.hset("h1", Buffer.from([0x01]), Buffer.from([0x02]));
redis.hset("h1", Buffer.from([0x03]), Buffer.from([0x04]));
redis.hgetallBuffer("h1", (err, result) => {
// result === [ [ <Buffer 01>, <Buffer 02> ], [ <Buffer 03>, <Buffer 04> ] ];
});
```
## Monitor
Redis supports the MONITOR command,
which lets you see all commands received by the Redis server across all client connections,
including from other client libraries and other computers.
The `monitor` method returns a monitor instance.
After you send the MONITOR command, no other commands are valid on that connection. ioredis will emit a monitor event for every new monitor message that comes across.
The callback for the monitor event takes a timestamp from the Redis server and an array of command arguments.
Here is a simple example:
```javascript
redis.monitor((err, monitor) => {
monitor.on("monitor", (time, args, source, database) => {});
});
```
Here is another example illustrating an `async` function and `monitor.disconnect()`:
```javascript
async () => {
const monitor = await redis.monitor();
monitor.on("monitor", console.log);
// Any other tasks
monitor.disconnect();
};
```
## Streamify Scanning
Redis 2.8 added the `SCAN` command to incrementally iterate through the keys in the database. It's different from `KEYS` in that
`SCAN` only returns a small number of elements each call, so it can be used in production without the downside
of blocking the server for a long time. However, it requires recording the cursor on the client side each time
the `SCAN` command is called in order to iterate through all the keys correctly. Since it's a relatively common use case, ioredis
provides a streaming interface for the `SCAN` command to make things much easier. A readable stream can be created by calling `scanStream`:
```javascript
const redis = new Redis();
// Create a readable stream (object mode)
const stream = redis.scanStream();
stream.on("data", (resultKeys) => {
// `resultKeys` is an array of strings representing key names.
// Note that resultKeys may contain 0 keys, and that it will sometimes
// contain duplicates due to SCAN's implementation in Redis.
for (let i = 0; i < resultKeys.length; i++) {
console.log(resultKeys[i]);
}
});
stream.on("end", () => {
console.log("all keys have been visited");
});
```
`scanStream` accepts an option, with which you can specify the `MATCH` pattern, the `TYPE` filter, and the `COUNT` argument:
```javascript
const stream = redis.scanStream({
// only returns keys following the pattern of `user:*`
match: "user:*",
// only return objects that match a given type,
// (requires Redis >= 6.0)
type: "zset",
// returns approximately 100 elements per call
count: 100,
});
```
Just like other commands, `scanStream` has a binary version `scanBufferStream`, which returns an array of buffers. It's useful when
the key names are not utf8 strings.
There are also `hscanStream`, `zscanStream` and `sscanStream` to iterate through elements in a hash, zset and set. The interface of each is
similar to `scanStream` except the first argument is the key name:
```javascript
const stream = redis.zscanStream("myhash", {
match: "age:??",
});
```
The `hscanStream` also accepts the `noValues` option to specify whether Redis should return only the keys in the hash table without their corresponding values.
```javascript
const stream = redis.hscanStream("myhash", {
match: "age:??",
noValues: true,
});
```
You can learn more from the [Redis documentation](http://redis.io/commands/scan).
**Useful Tips**
It's pretty common that doing an async task in the `data` handler. We'd like the scanning process to be paused until the async task to be finished. `Stream#pause()` and `Stream#resume()` do the trick. For example if we want to migrate data in Redis to MySQL:
```javascript
const stream = redis.scanStream();
stream.on("data", (resultKeys) => {
// Pause the stream from scanning more keys until we've migrated the current keys.
stream.pause();
Promise.all(resultKeys.map(migrateKeyToMySQL)).then(() => {
// Resume the stream here.
stream.resume();
});
});
stream.on("end", () => {
console.log("done migration");
});
```
## Auto-reconnect
By default, ioredis will try to reconnect when the connection to Redis is lost
except when the connection is closed manually by `redis.disconnect()` or `redis.quit()`.
It's very flexible to control how long to wait to reconnect after disconnection
using the `retryStrategy` option:
```javascript
const redis = new Redis({
// This is the default value of `retryStrategy`
retryStrategy(times) {
const delay = Math.min(times * 50, 2000);
return delay;
},
});
```
`retryStrategy` is a function that will be called when the connection is lost.
The argument `times` means this is the nth reconnection being made and
the return value represents how long (in ms) to wait to reconnect. When the
return value isn't a number, ioredis will stop trying to reconnect, and the connection
will be lost forever if the user doesn't call `redis.connect()` manually.
When reconnected, the client will auto subscribe to channels that the previous connection subscribed to.
This behavior can be disabled by setting the `autoResubscribe` option to `false`.
And if the previous connection has some unfulfilled commands (most likely blocking commands such as `brpop` and `blpop`),
the client will resend them when reconnected. This behavior can be disabled by setting the `autoResendUnfulfilledCommands` option to `false`.
By default, all pending commands will be flushed with an error every 20 retry attempts. That makes sure commands won't wait forever when the connection is down. You can change this behavior by setting `maxRetriesPerRequest`:
```javascript
const redis = new Redis({
maxRetriesPerRequest: 1,
});
```
Set maxRetriesPerRequest to `null` to disable this behavior, and every command will wait forever until the connection is alive again (which is the default behavior before ioredis v4).
### Blocking Command Timeout
ioredis can apply a client-side timeout to blocking commands (such as `blpop`, `brpop`, `bzpopmin`, `bzmpop`, `blmpop`, `xread`, `xreadgroup`, etc.). This protects against scenarios where the TCP connection becomes a zombie (e.g., due to a silent network failure like a Docker network disconnect) and Redis never replies.
This feature is **opt-in**. It is **disabled by default** and is only enabled
when `blockingTimeout` is set to a positive number of milliseconds. If
`blockingTimeout` is omitted, `0`, or negative (for example `-1`), ioredis
does not arm any client-side timeouts for blocking commands and their
behavior matches Redis exactly.
```javascript
const redis = new Redis({
blockingTimeout: 30000, // Enable blocking timeout protection
});
```
When enabled:
- For commands with a finite timeout (e.g., `blpop("key", 5)`), ioredis sets a client-side deadline based on the command's timeout plus a small grace period (`blockingTimeoutGrace`, default 100ms). If no reply arrives before the deadline, the command resolves with `null`—the same value Redis returns when a blocking command times out normally.
- For commands that block forever (e.g., `timeout = 0` or `BLOCK 0`), the `blockingTimeout` value is used as a safety net.
### Reconnect on Error
Besides auto-reconnect when the connection is closed, ioredis supports reconnecting on certain Redis errors using the `reconnectOnError` option. Here's an example that will reconnect when receiving `READONLY` error:
```javascript
const redis = new Redis({
reconnectOnError(err) {
const targetError = "READONLY";
if (err.message.includes(targetError)) {
// Only reconnect when the error contains "READONLY"
return true; // or `return 1;`
}
},
});
```
This feature is useful when using Amazon ElastiCache instances with Auto-failover disabled. On these instances, test your `reconnectOnError` handler by manually promoting the replica node to the primary role using the AWS console. The following writes fail with the error `READONLY`. Using `reconnectOnError`, we can force the connection to reconnect on this error in order to connect to the new master. Furthermore, if the `reconnectOnError` returns `2`, ioredis will resend the failed command after reconnecting.
On ElastiCache instances with Auto-failover enabled, `reconnectOnError` does not execute. Instead of returning a Redis error, AWS closes all connections to the master endpoint until the new primary node is ready. ioredis reconnects via `retryStrategy` instead of `reconnectOnError` after about a minute. On ElastiCache instances with Auto-failover enabled, test failover events with the `Failover primary` option in the AWS console.
## Connection Events
The Redis instance will emit some events about the state of the connection to the Redis server.
| Event | Description |
| :----------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| connect | emits when a connection is established to the Redis server. |
| ready | If `enableReadyCheck` is `true`, client will emit `ready` when the server reports that it is ready to receive commands (e.g. finish loading data from disk).<br>Otherwise, `ready` will be emitted immediately right after the `connect` event. |
| error | emits when an error occurs while connecting.<br>However, ioredis emits all `error` events silently (only emits when there's at least one listener) so that your application won't crash if you're not listening to the `error` event.<br>When `redis.connect()` is explicitly called the error will also be rejected from the returned promise, in addition to emitting it. If `redis.connect()` is not called explicitly and `lazyConnect` is true, ioredis will try to connect automatically on the first command and emit the `error` event silently. |
| close | emits when an established Redis server connection has closed. |
| reconnecting | emits after `close` when a reconnection will be made. The argument of the event is the time (in ms) before reconnecting. |
| end | emits after `close` when no more reconnections will be made, or the connection is failed to establish. |
| wait | emits when `lazyConnect` is set and will wait for the first command to be called before connecting. |
You can also check out the `Redis#status` property to get the current connection status.
Besides the above connection events, there are several other custom events:
| Event | Description |
| :----- | :------------------------------------------------------------------ |
| select | emits when the database changed. The argument is the new db number. |
## Diagnostics Channel
ioredis publishes telemetry through Node.js [`diagnostics_channel`](https://nodejs.org/api/diagnostics_channel.html), allowing APM tools and custom instrumentation to observe commands, connections, and batch operations without modifying application code.
These channels use `TracingChannel#tracePromise()` and emit `start`, `end`, `asyncStart`, `asyncEnd`, and `error` sub-events. Requires Node.js >= 18.19.0; on older versions the channels are silently unavailable (zero overhead). Subscribe via `tracing:<name>:<event>`:
```typescript
import dc from "node:diagnostics_channel";
dc.subscribe("tracing:ioredis:command:start", ({ command, args }) => {
console.log(`> ${command}`, args);
});
dc.subscribe("tracing:ioredis:command:asyncEnd", ({ command }) => {
console.log(`${command} settled`);
});
dc.subscribe("tracing:ioredis:command:error", ({ command, error }) => {
console.error(`${command} failed:`, error);
});
```
| Channel name | Payload | Description |
| :---------------- | :---------------------- | :------------------------------------------------------- |
| `ioredis:command` | `CommandTraceContext` | Individual command (standalone, pipeline, or within MULTI) |
| `ioredis:batch` | `BatchOperationContext` | MULTI transaction as a whole |
| `ioredis:connect` | `ConnectTraceContext` | Socket connection attempt |
Command arguments are sanitized before emission using rules adapted from `@opentelemetry/redis-common`. Sensitive values (e.g. values in `SET`, `AUTH` passwords) are replaced with `?`, while read-only commands like `GET` and `DEL` retain all arguments. This is safe by default: unlisted or custom commands have all arguments redacted.
Context types (`CommandTraceContext`, `BatchOperationContext`, `ConnectTraceContext`) are exported from `ioredis`.
## Offline Queue
When a command can't be processed by Redis (being sent before the `ready` event), by default, it's added to the offline queue and will be
executed when it can be processed. You can disable this feature by setting the `enableOfflineQueue`
option to `false`:
```javascript
const redis = new Redis({ enableOfflineQueue: false });
```
## TLS Options
Redis doesn't support TLS natively, however if the redis server you want to connect to is hosted behind a TLS proxy (e.g. [stunnel](https://www.stunnel.org/)) or is offered by a PaaS service that supports TLS connection (e.g. [Redis.com](https://redis.com/)), you can set the `tls` option:
```javascript
const redis = new Redis({
host: "localhost",
tls: {
// Refer to `tls.connect()` section in
// https://nodejs.org/api/tls.html
// for all supported options
ca: fs.readFileSync("cert.pem"),
},
});
```
Alternatively, specify the connection through a [`rediss://` URL](https://www.iana.org/assignments/uri-schemes/prov/rediss).
```javascript
const redis = new Redis("rediss://redis.my-service.com");
```
If you do not want to use a connection string, you can also specify an empty `tls: {}` object:
```javascript
const redis = new Redis({
host: "redis.my-service.com",
tls: {},
});
```
### TLS Profiles
> **Warning**
> TLS profiles described in this section are going to be deprecated in the next major version. Please provide TLS options explicitly.
To make it easier to configure we provide a few pre-configured TLS profiles that can be specified by setting the `tls` option to the profile's name or specifying a `tls.profile` option in case you need to customize some values of the profile.
Profiles:
- `RedisCloudFixed`: Contains the CA for [Redis.com](https://redis.com/) Cloud fixed subscriptions
- `RedisCloudFlexible`: Contains the CA for [Redis.com](https://redis.com/) Cloud flexible subscriptions
```javascript
const redis = new Redis({
host: "localhost",
tls: "RedisCloudFixed",
});
const redisWithClientCertificate = new Redis({
host: "localhost",
tls: {
profile: "RedisCloudFixed",
key: "123",
},
});
```
<hr>
## Sentinel
ioredis supports Sentinel out of the box. It works transparently as all features that work when
you connect to a single node also work when you connect to a sentinel group. Make sure to run Redis >= 2.8.12 if you want to use this feature. Sentinels have a default port of 26379.
To connect using Sentinel, use:
```javascript
const redis = new Redis({
sentinels: [
{ host: "localhost", port: 26379 },
{ host: "localhost", port: 26380 },
],
name: "mymaster",
});
redis.set("foo", "bar");
```
The arguments passed to the constructor are different from the ones you use to connect to a single node, where:
- `name` identifies a group of Redis instances composed of a master and one or more slaves (`mymaster` in the example);
- `sentinelPassword` (optional) password for Sentinel instances.
- `sentinels` are a list of sentinels to connect to. The list does not need to enumerate all your sentinel instances, but a few so that if one is down the client will try the next one.
- `role` (optional) with a value of `slave` will return a random slave from the Sentinel group.
- `preferredSlaves` (optional) can be used to prefer a particular slave or set of slaves based on priority. It accepts a function or array.
- `enableTLSForSentinelMode` (optional) set to true if connecting to sentinel instances that are encrypted
ioredis **guarantees** that the node you connected to is always a master even after a failover. When a failover happens, instead of trying to reconnect to the failed node (which will be demoted to slave when it's available again), ioredis will ask sentinels for the new master node and connect to it. All commands sent during the failover are queued and will be executed when the new connection is established so that none of the commands will be lost.
It's possible to connect to a slave instead of a master by specifying the option `role` with the value of `slave` and ioredis will try to connect to a random slave of the specified master, with the guarantee that the connected node is always a slave. If the current node is promoted to master due to a failover, ioredis will disconnect from it and ask the sentinels for another slave node to connect to.
If you specify the option `preferredSlaves` along with `role: 'slave'` ioredis will attempt to use this value when selecting the slave from the pool of available slaves. The value of `preferredSlaves` should either be a function that accepts an array of available slaves and returns a single result, or an array of slave values priorities by the lowest `prio` value first with a default value of `1`.
```javascript
// available slaves format
const availableSlaves = [{ ip: "127.0.0.1", port: "31231", flags: "slave" }];
// preferredSlaves array format
let preferredSlaves = [
{ ip: "127.0.0.1", port: "31231", prio: 1 },
{ ip: "127.0.0.1", port: "31232", prio: 2 },
];
// preferredSlaves function format
preferredSlaves = function (availableSlaves) {
for (let i = 0; i < availableSlaves.length; i++) {
const slave = availableSlaves[i];
if (slave.ip === "127.0.0.1") {
if (slave.port === "31234") {
return slave;
}
}
}
// if no preferred slaves are available a random one is used
return false;
};
const redis = new Redis({
sentinels: [
{ host: "127.0.0.1", port: 26379 },
{ host: "127.0.0.1", port: 26380 },
],
name: "mymaster",
role: "slave",
preferredSlaves: preferredSlaves,
});
```
Besides the `retryStrategy` option, there's also a `sentinelRetryStrategy` in Sentinel mode which will be invoked when all the sentinel nodes are unreachable during connecting. If `sentinelRetryStrategy` returns a valid delay time, ioredis will try to reconnect from scratch. The default value of `sentinelRetryStrategy` is:
```javascript
function (times) {
const delay = Math.min(times * 10, 1000);
return delay;
}
```
## Cluster
Redis Cluster provides a way to run a Redis installation where data is automatically sharded across multiple Redis nodes.
You can connect to a Redis Cluster like this:
```javascript
const Redis = require("ioredis");
const cluster = new Redis.Cluster([
{
port: 6380,
host: "127.0.0.1",
},
{
port: 6381,
host: "127.0.0.1",
},
]);
cluster.set("foo", "bar");
cluster.get("foo", (err, res) => {
// res === 'bar'
});
```
`Cluster` constructor accepts two arguments, where:
0. The first argument is a list of nodes of the cluster you want to connect to.
Just like Sentinel, the list does not need to enumerate all your cluster nodes,
but a few so that if one is unreachable the client will try the next one, and the client will discover other nodes automatically when at least one node is connected.
1. The second argument is the options, where:
- `clusterRetryStrategy`: When none of the startup nodes are reachable, `clusterRetryStrategy` will be invoked. When a number is returned,
ioredis will try to reconnect to the startup nodes from scratch after the specified delay (in ms). Otherwise, an error of "None of startup nodes is available" will be returned.
The default value of this option is:
```javascript
function (times) {
const delay = Math.min(100 + times * 2, 2000);
return delay;
}
```
It's possible to modify the `startupNodes` property in order to switch to another set of nodes here:
```javascript
function (times) {
this.startupNodes = [{ port: 6790, host: '127.0.0.1' }];
return Math.min(100 + times * 2, 2000);
}
```
- `clusterNodeRetryStrategy`: Per-node retry strategy. By default, ioredis won't try to reconnect to a lost node and just waits for a `MOVED` error to refresh slots. If you pass a function here, it's used as the `retryStrategy` for each node — return a number to reconnect after that many ms, or anything else to drop the node from the pool. Handy for replica nodes that restart without slot changes (e.g. maintenance). Example:
```javascript
function (times) {
return Math.min(100 * times, 2000);
}
```
- `dnsLookup`: Alternative DNS lookup function (`dns.lookup()` is used by default). It may be useful to override this in special cases, such as when AWS ElastiCache used with TLS enabled.
- `enableOfflineQueue`: Similar to the `enableOfflineQueue` option of `Redis` class.
- `enableReadyCheck`: When enabled, "ready" event will only be emitted when `CLUSTER INFO` command
reporting the cluster is ready for handling commands. Otherwise, it will be emitted immediately after "connect" is emitted.
- `scaleReads`: Config where to send the read queries. See below for more details.
- `maxRedirections`: When a cluster related error (e.g. `MOVED`, `ASK` and `CLUSTERDOWN` etc.) is received, the client will redirect the
command to another node. This option limits the max redirections allowed when sending a command. The default value is `16`.
- `retryDelayOnFailover`: If the target node is disconnected when sending a command,
ioredis will retry after the specified delay. The default value is `100`. You should make sure `retryDelayOnFailover * maxRedirections > cluster-node-timeout`
to insure that no command will fail during a failover.
- `retryDelayOnClusterDown`: When a cluster is down, all commands will be rejected with the error of `CLUSTERDOWN`. If this option is a number (by default, it is `100`), the client
will resend the commands after the specified time (in ms).
- `retryDelayOnTryAgain`: If this option is a number (by default, it is `100`), the client
will resend the commands rejected with `TRYAGAIN` error after the specified time (in ms).
- `retryDelayOnMoved`: By default, this value is `0` (in ms), which means when a `MOVED` error is received, the client will resend
the command instantly to the node returned together with the `MOVED` error. However, sometimes it takes time for a cluster to become
state stabilized after a failover, so adding a delay before resending can prevent a ping pong effect.
- `redisOptions`: Default options passed to the constructor of `Redis` when connecting to a node.
- `slotsRefreshTimeout`: Milliseconds before a timeout occurs while refreshing slots from the cluster (default `1000`).
- `slotsRefreshInterval`: Milliseconds between every automatic slots refresh (by default, it is disabled).
### Read-Write Splitting
A typical redis cluster contains three or more masters and several slaves for each master. It's possible to scale out redis cluster by sending read queries to slaves and write queries to masters by setting the `scaleReads` option.
`scaleReads` is "master" by default, which means ioredis will never send any queries to slaves. There are other three available options:
1. "all": Send write queries to masters and read queries to masters or slaves randomly.
2. "slave": Send write queries to masters and read queries to slaves.
3. a custom `function(nodes, command): node`: Will choose the custom function to select to which node to send read queries (write queries keep being sent to master). The first node in `nodes` is always the master serving the relevant slots. If the function returns an array of nodes, a random node of that list will be selected.
For example:
```javascript
const cluster = new Redis.Cluster(
[
/* nodes */
],
{
scaleReads: "slave",
}
);
cluster.set("foo", "bar"); // This query will be sent to one of the masters.
cluster.get("foo", (err, res) => {
// This query will be sent to one of the slaves.
});
```
**NB** In the code snippet above, the `res` may not be equal to "bar" because of the lag of replication between the master and slaves.
### Running Commands to Multiple Nodes
Every command will be sent to exactly one node. For commands containing keys, (e.g. `GET`, `SET` and `HGETALL`), ioredis sends them to the node that serving the keys, and for other commands not containing keys, (e.g. `INFO`, `KEYS` and `FLUSHDB`), ioredis sends them to a random node.
Sometimes you may want to send a command to multiple nodes (masters or slaves) of the cluster, you can get the nodes via `Cluster#nodes()` method.
`Cluster#nodes()` accepts a parameter role, which can be "master", "slave" and "all" (default), and returns an array of `Redis` instance. For example:
```javascript
// Send `FLUSHDB` command to all slaves:
const slaves = cluster.nodes("slave");
Promise.all(slaves.map((node) => node.flushdb()));
// Get keys of all the masters:
const masters = cluster.nodes("master");
Promise.all(
masters
.map((node) => node.keys())
.then((keys) => {
// keys: [['key1', 'key2'], ['key3', 'key4']]
})
);
```
### NAT Mapping
Sometimes the cluster is hosted within a internal network that can only be accessed via a NAT (Network Address Translation) instance. See [Accessing ElastiCache from outside AWS](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/accessing-elasticache.html) as an example.
You can specify nat mapping rules via `natMap` option:
```javascript
const cluster = new Redis.Cluster(
[
{
host: "203.0.113.73",
port: 30001,
},
],
{
natMap: {
"10.0.1.230:30001": { host: "203.0.113.73", port: 30001 },
"10.0.1.231:30001": { host: "203.0.113.73", port: 30002 },
"10.0.1.232:30001": { host: "203.0.113.73", port: 30003 },
},
}
);
```
Or you can specify this parameter through function:
```javascript
const cluster = new Redis.Cluster(
[
{
host: "203.0.113.73",
port: 30001,
},
],
{
natMap: (key) => {
if (key.includes("30001")) {
return { host: "203.0.113.73", port: 30001 };
}
return null;
},
}
);
```
This option is also useful when the cluster is running inside a Docker container.
Also it works for Clusters in cloud infrastructure where cluster nodes connected through dedicated subnet.
Specifying through may be useful if you don't know concrete internal host and know only node port.
### Transaction and Pipeline in Cluster Mode
Almost all features that are supported by `Redis` are also supported by `Redis.Cluster`, e.g. custom commands, transaction and pipeline.
However there are some differences when using transaction and pipeline in Cluster mode:
0. All keys in a pipeline should belong to slots served by the same node, since ioredis sends all commands in a pipeline to the same node.
1. You can't use `multi` without pipeline (aka `cluster.multi({ pipeline: false })`). This is because when you call `cluster.multi({ pipeline: false })`, ioredis doesn't know which node the `multi` command should be sent to.
When any commands in a pipeline receives a `MOVED` or `ASK` error, ioredis will resend the whole pipeline to the specified node automatically if all of the following conditions are satisfied:
0. All errors received in the pipeline are the same. For example, we won't resend the pipeline if we got two `MOVED` errors pointing to different nodes.
1. All commands executed successfully are readonly commands. This makes sure that resending the pipeline won't have side effects.
### Pub/Sub
Pub/Sub in cluster mode works exactly as the same as in standalone mode. Internally, when a node of the cluster receives a message, it will broadcast the message to the other nodes. ioredis makes sure that each message will only be received once by strictly subscribing one node at the same time.
```javascript
const nodes = [
/* nodes */
];
const pub = new Redis.Cluster(nodes);
const sub = new Redis.Cluster(nodes);
sub.on("message", (channel, message) => {
console.log(channel, message);
});
sub.subscribe("news", () => {
pub.publish("news", "highlights");
});
```
### Sharded Pub/Sub
For sharded Pub/Sub, use the `spublish` and `ssubscribe` commands instead of the traditional `publish` and `subscribe`. With the old commands, the Redis cluster handles message propagation behind the scenes, allowing you to publish or subscribe to any node without considering sharding. However, this approach has scalability limitations that are addressed with sharded Pub/Sub. Here’s what you need to know:
1. Instead of a single subscriber connection, there is now one subscriber connection per shard. Because of the potential overhead, you can enable or disable the use of the cluster subscriber group with the `shardedSubscribers` option. By default, this option is set to `false`, meaning sharded subscriptions are disabled. You should enable this option when establishing your cluster connection before using `ssubscribe`.
2. All channel names that you pass to a single `ssubscribe` need to map to the same hash slot. You can call `ssubscribe` multiple times on the same cluster client instance to subscribe to channels across slots. The cluster's subscriber group takes care of forwarding the `ssubscribe` command to the shard that is responsible for the channels.
The following basic example shows you how to use sharded Pub/Sub:
```javascript
const cluster: Cluster = new Cluster([{ host: host, port: port }], {
shardedSubscribers: true,
});
//Register the callback
cluster.on("smessage", (channel, message) => {
console.log(message);
});
//Subscribe to the channels on the same slot
cluster
.ssubscribe("channel{my}:1", "channel{my}:2")
.then((count: number) => {
console.log(count);
})
.catch((err) => {
console.log(err);
});
//Publish a message
cluster
.spublish("channel{my}:1", "This is a test message to my first channel.")
.then((value: number) => {
console.log("Published a message to channel{my}:1");
});
```
### Events
| Event | Description |
| :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| connect | emits when a connection is established to the Redis server. |
| ready | emits when `CLUSTER INFO` reporting the cluster is able to receive commands (if `enableReadyCheck` is `true`) or immediately after `connect` event (if `enableReadyCheck` is false). |
| error | emits when an error occurs while connecting with a property of `lastNodeError` representing the last node error received. This event is emitted silently (only emitting if there's at least one listener). |
| close | emits when an established Redis server connection has closed. |
| reconnecting | emits after `close` when a reconnection will be made. The argument of the event is the time (in ms) before reconnecting. |
| end | emits after `close` when no more reconnections will be made. |
| +node | emits when a new node is connected. |
| -node | emits when a node is disconnected. |
| node error | emits when an error occurs when connecting to a node. The second argument indicates the address of the node. |
### Password
Setting the `password` option to access password-protected clusters:
```javascript
const Redis = require("ioredis");
const cluster = new Redis.Cluster(nodes, {
redisOptions: {
password: "your-cluster-password",
},
});
```
If some of nodes in the cluster using a different password, you should specify them in the first parameter:
```javascript
const Redis = require("ioredis");
const cluster = new Redis.Cluster(
[
// Use password "password-for-30001" for 30001
{ port: 30001, password: "password-for-30001" },
// Don't use password when accessing 30002
{ port: 30002, password: null },
// Other nodes will use "fallback-password"
],
{
redisOptions: {
password: "fallback-password",
},
}
);
```
### Special Note: Aws Elasticache Clusters with TLS
AWS ElastiCache for Redis (Clustered Mode) supports TLS encryption. If you use
this, you may encounter errors with invalid certificates. To resolve this
issue, construct the `Cluster` with the `dnsLookup` option as follows:
```javascript
const cluster = new Redis.Cluster(
[
{
host: "clustercfg.myCluster.abcdefg.xyz.cache.amazonaws.com",
port: 6379,
},
],
{
dnsLookup: (address, callback) => callback(null, address),
redisOptions: {
tls: {},
},
}
);
```
<hr>
## Autopipelining
In standard mode, when you issue multiple commands, ioredis sends them to the server one by one. As described in Redis pipeline documentation, this is a suboptimal use of the network link, especially when such link is not very performant.
The TCP and network overhead negatively affects performance. Commands are stuck in the send queue until the previous ones are correctly delivered to the server. This is a problem known as Head-Of-Line blocking (HOL).
ioredis supports a feature called “auto pipelining”. It can be enabled by setting the option `enableAutoPipelining` to `true`. No other code change is necessary.
In auto pipelining mode, all commands issued during an event loop are enqueued in a pipeline automatically managed by ioredis. At the end of the iteration, the pipeline is executed and thus all commands are sent to the server at the same time.
This feature can dramatically improve throughput and avoids HOL blocking. In our benchmarks, the improvement was between 35% and 50%.
While an automatic pipeline is executing, all new commands will be enqueued in a new pipeline which will be executed as soon as the previous finishes.
When using Redis Cluster, one pipeline per node is created. Commands are assigned to pipelines according to which node serves the slot.
A pipeline will thus contain commands using different slots but that ultimately are assigned to the same node.
Note that the same slot limitation within a single command still holds, as it is a Redis limitation.
### Example of Automatic Pipeline Enqueuing
This sample code uses ioredis with automatic pipeline enabled.
```javascript
const Redis = require("./built");
const http = require("http");
const db = new Redis({ enableAutoPipelining: true });
const server = http.createServer((request, response) => {
const key = new URL(request.url, "https://localhost:3000/").searchParams.get(
"key"
);
db.get(key, (err, value) => {
response.writeHead(200, { "Content-Type": "text/plain" });
response.end(value);
});
});
server.listen(3000);
```
When Node receives requests, it schedules them to be processed in one or more iterations of the events loop.
All commands issued by requests processing during one iteration of the loop will be wrapped in a pipeline automatically created by ioredis.
In the example above, the pipeline will have the following contents:
```
GET key1
GET key2
GET key3
...
GET keyN
```
When all events in the current loop have been processed, the pipeline is executed and thus all commands are sent to the server at the same time.
While waiting for pipeline response from Redis, Node will still be able to process requests. All commands issued by request handler will be enqueued in a new automatically created pipeline. This pipeline will not be sent to the server yet.
As soon as a previous automatic pipeline has received all responses from the server, the new pipeline is immediately sent without waiting for the events loop iteration to finish.
This approach increases the utilization of the network link, reduces the TCP overhead and idle times and therefore improves throughput.
### Benchmarks
Here's some of the results of our tests for a single node.
Each iteration of the test runs 1000 random commands on the server.
| | Samples | Result | Tolerance |
| ------------------------- | ------- | ------------- | --------- |
| default | 1000 | 174.62 op/sec | ± 0.45 % |
| enableAutoPipelining=true | 1500 | 233.33 op/sec | ± 0.88 % |
And here's the same test for a cluster of 3 masters and 3 replicas:
| | Samples | Result | Tolerance |
| ------------------------- | ------- | ------------- | --------- |
| default | 1000 | 164.05 op/sec | ± 0.42 % |
| enableAutoPipelining=true | 3000 | 235.31 op/sec | ± 0.94 % |
# Error Handling
All the errors returned by the Redis server are instances of `ReplyError`, which can be accessed via `Redis`:
```javascript
const Redis = require("ioredis");
const redis = new Redis();
// This command causes a reply error since the SET command requires two arguments.
redis.set("foo", (err) => {
err instanceof Redis.ReplyError;
});
```
This is the error stack of the `ReplyError`:
```
ReplyError: ERR wrong number of arguments for 'set' command
at ReplyParser._parseResult (/app/node_modules/ioredis/lib/parsers/javascript.js:60:14)
at ReplyParser.execute (/app/node_modules/ioredis/lib/parsers/javascript.js:178:20)
at Socket.<anonymous> (/app/node_modules/ioredis/lib/redis/event_handler.js:99:22)
at Socket.emit (events.js:97:17)
at readableAddChunk (_stream_readable.js:143:16)
at Socket.Readable.push (_stream_readable.js:106:10)
at TCP.onread (net.js:509:20)
```
By default, the error stack doesn't make any sense because the whole stack happens in the ioredis
module itself, not in your code. So it's not easy to find out where the error happens in your code.
ioredis provides an option `showFriendlyErrorStack` to solve the problem. When you enable
`showFriendlyErrorStack`, ioredis will optimize the error stack for you:
```javascript
const Redis = require("ioredis");
const redis = new Redis({ showFriendlyErrorStack: true });
redis.set("foo");
```
And the output will be:
```
ReplyError: ERR wrong number of arguments for 'set' command
at Object.<anonymous> (/app/index.js:3:7)
at Module._compile (module.js:446:26)
at Object.Module._extensions..js (module.js:464:10)
at Module.load (module.js:341:32)
at Function.Module._load (module.js:296:12)
at Function.Module.runMain (module.js:487:10)
at startup (node.js:111:16)
at node.js:799:3
```
This time the stack tells you that the error happens on the third line in your code. Pretty sweet!
However, it would decrease the performance significantly to optimize the error stack. So by
default, this option is disabled and can only be used for debugging purposes. You **shouldn't** use this feature in a production environment.
# Running tests
Start a Redis server on 127.0.0.1:6379, and then:
```shell
npm test
```
`FLUSH ALL` will be invoked after each test, so make sure there's no valuable data in it before running tests.
If your testing environment does not let you spin up a Redis server [ioredis-mock](https://github.com/stipsan/ioredis-mock) is a drop-in replacement you can use in your tests. It aims to behave identically to ioredis connected to a Redis server so that your integration tests is easier to write and of better quality.
# Debug
You can set the `DEBUG` env to `ioredis:*` to print debug info:
```shell
$ DEBUG=ioredis:* node app.js
```
# Join in!
I'm happy to receive bug reports, fixes, documentation enhancements, and any other improvements.
And since I'm not a native English speaker, if you find any grammar mistakes in the documentation, please also let me know. :)
# Contributors
This project exists thanks to all the people who contribute:
<a href="https://github.com/redis/ioredis/graphs/contributors"><img src="https://opencollective.com/ioredis/contributors.svg?width=890&showBtn=false" /></a>
# License
MIT
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fluin%2Fioredis.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fluin%2Fioredis?ref=badge_large)
landvex/node_modules/ioredis/built/Command.d.ts
Generated Vendored
+166
View File
@@ -0,0 +1,166 @@
/// <reference types="node" />
import { Callback, Respondable, CommandParameter } from "./types";
export declare type ArgumentType = string | Buffer | number | (string | Buffer | number | any[])[];
interface CommandOptions {
/**
* Set the encoding of the reply, by default buffer will be returned.
*/
replyEncoding?: BufferEncoding | null;
errorStack?: Error;
keyPrefix?: string;
/**
* Force the command to be readOnly so it will also execute on slaves
*/
readOnly?: boolean;
}
declare type ArgumentTransformer = (args: any[]) => any[];
declare type ReplyTransformer = (reply: any) => any;
export interface CommandNameFlags {
VALID_IN_SUBSCRIBER_MODE: [
"subscribe",
"psubscribe",
"unsubscribe",
"punsubscribe",
"ssubscribe",
"sunsubscribe",
"ping",
"quit"
];
VALID_IN_MONITOR_MODE: ["monitor", "auth"];
ENTER_SUBSCRIBER_MODE: ["subscribe", "psubscribe", "ssubscribe"];
EXIT_SUBSCRIBER_MODE: ["unsubscribe", "punsubscribe", "sunsubscribe"];
WILL_DISCONNECT: ["quit"];
HANDSHAKE_COMMANDS: ["auth", "select", "client", "readonly", "info"];
IGNORE_RECONNECT_ON_ERROR: ["client"];
BLOCKING_COMMANDS: [
"blpop",
"brpop",
"brpoplpush",
"blmove",
"bzpopmin",
"bzpopmax",
"bzmpop",
"blmpop",
"xread",
"xreadgroup"
];
LAST_ARG_TIMEOUT_COMMANDS: [
"blpop",
"brpop",
"brpoplpush",
"blmove",
"bzpopmin",
"bzpopmax"
];
FIRST_ARG_TIMEOUT_COMMANDS: ["bzmpop", "blmpop"];
BLOCK_OPTION_COMMANDS: ["xread", "xreadgroup"];
}
/**
* Command instance
*
* It's rare that you need to create a Command instance yourself.
*
* ```js
* var infoCommand = new Command('info', null, function (err, result) {
* console.log('result', result);
* });
*
* redis.sendCommand(infoCommand);
*
* // When no callback provided, Command instance will have a `promise` property,
* // which will resolve/reject with the result of the command.
* var getCommand = new Command('get', ['foo']);
* getCommand.promise.then(function (result) {
* console.log('result', result);
* });
* ```
*/
export default class Command implements Respondable {
name: string;
static FLAGS: {
[key in keyof CommandNameFlags]: CommandNameFlags[key];
};
private static flagMap?;
private static _transformer;
/**
* Check whether the command has the flag
*/
static checkFlag<T extends keyof CommandNameFlags>(flagName: T, commandName: string): commandName is CommandNameFlags[T][number];
static setArgumentTransformer(name: string, func: ArgumentTransformer): void;
static setReplyTransformer(name: string, func: ReplyTransformer): void;
private static getFlagMap;
ignore?: boolean;
isReadOnly?: boolean;
args: CommandParameter[];
inTransaction: boolean;
pipelineIndex?: number;
isTraced: boolean;
isResolved: boolean;
reject: (err: Error) => void;
resolve: (result: any) => void;
promise: Promise<any>;
private replyEncoding;
private errorStack;
private bufferMode;
private callback;
private transformed;
private _commandTimeoutTimer?;
private _blockingTimeoutTimer?;
private _blockingDeadline?;
private slot?;
private keys?;
/**
* Creates an instance of Command.
* @param name Command name
* @param args An array of command arguments
* @param options
* @param callback The callback that handles the response.
* If omit, the response will be handled via Promise
*/
constructor(name: string, args?: Array<ArgumentType>, options?: CommandOptions, callback?: Callback);
getSlot(): number;
getKeys(): Array<string | Buffer>;
/**
* Convert command to writable buffer or string
*/
toWritable(_socket: object): string | Buffer;
stringifyArguments(): void;
/**
* Convert buffer/buffer[] to string/string[],
* and apply reply transformer.
*/
transformReply(result: Buffer | Buffer[]): string | string[] | Buffer | Buffer[];
/**
* Set the wait time before terminating the attempt to execute a command
* and generating an error.
*/
setTimeout(ms: number): void;
/**
* Set a timeout for blocking commands.
* When the timeout expires, the command resolves with null (matching Redis behavior).
* This handles the case of undetectable network failures (e.g., docker network disconnect)
* where the TCP connection becomes a zombie and no close event fires.
*/
setBlockingTimeout(ms: number): void;
/**
* Extract the blocking timeout from the command arguments.
*
* @returns The timeout in seconds, null for indefinite blocking (timeout of 0),
* or undefined if this is not a blocking command
*/
extractBlockingTimeout(): number | null | undefined;
/**
* Clear the command and blocking timers
*/
private _clearTimers;
private initPromise;
/**
* Iterate through the command arguments that are considered keys.
*/
private _iterateKeys;
/**
* Convert the value from buffer to the target encoding.
*/
private _convertValue;
}
export {};
landvex/node_modules/ioredis/built/Command.js
Generated Vendored
+450
View File
@@ -0,0 +1,450 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const commands_1 = require("@ioredis/commands");
const calculateSlot = require("cluster-key-slot");
const standard_as_callback_1 = require("standard-as-callback");
const utils_1 = require("./utils");
const argumentParsers_1 = require("./utils/argumentParsers");
/**
* Command instance
*
* It's rare that you need to create a Command instance yourself.
*
* ```js
* var infoCommand = new Command('info', null, function (err, result) {
* console.log('result', result);
* });
*
* redis.sendCommand(infoCommand);
*
* // When no callback provided, Command instance will have a `promise` property,
* // which will resolve/reject with the result of the command.
* var getCommand = new Command('get', ['foo']);
* getCommand.promise.then(function (result) {
* console.log('result', result);
* });
* ```
*/
class Command {
/**
* Creates an instance of Command.
* @param name Command name
* @param args An array of command arguments
* @param options
* @param callback The callback that handles the response.
* If omit, the response will be handled via Promise
*/
constructor(name, args = [], options = {}, callback) {
this.name = name;
this.inTransaction = false;
this.isTraced = false;
this.isResolved = false;
this.transformed = false;
this.replyEncoding = options.replyEncoding;
this.errorStack = options.errorStack;
this.args = args.flat();
this.callback = callback;
this.initPromise();
if (options.keyPrefix) {
// @ts-expect-error
const isBufferKeyPrefix = options.keyPrefix instanceof Buffer;
// @ts-expect-error
let keyPrefixBuffer = isBufferKeyPrefix
? options.keyPrefix
: null;
this._iterateKeys((key) => {
if (key instanceof Buffer) {
if (keyPrefixBuffer === null) {
keyPrefixBuffer = Buffer.from(options.keyPrefix);
}
return Buffer.concat([keyPrefixBuffer, key]);
}
else if (isBufferKeyPrefix) {
// @ts-expect-error
return Buffer.concat([options.keyPrefix, Buffer.from(String(key))]);
}
return options.keyPrefix + key;
});
}
if (options.readOnly) {
this.isReadOnly = true;
}
}
/**
* Check whether the command has the flag
*/
static checkFlag(flagName, commandName) {
commandName = commandName.toLowerCase();
return !!this.getFlagMap()[flagName][commandName];
}
static setArgumentTransformer(name, func) {
this._transformer.argument[name] = func;
}
static setReplyTransformer(name, func) {
this._transformer.reply[name] = func;
}
static getFlagMap() {
if (!this.flagMap) {
this.flagMap = Object.keys(Command.FLAGS).reduce((map, flagName) => {
map[flagName] = {};
Command.FLAGS[flagName].forEach((commandName) => {
map[flagName][commandName] = true;
});
return map;
}, {});
}
return this.flagMap;
}
getSlot() {
if (typeof this.slot === "undefined") {
const key = this.getKeys()[0];
this.slot = key == null ? null : calculateSlot(key);
}
return this.slot;
}
getKeys() {
return this._iterateKeys();
}
/**
* Convert command to writable buffer or string
*/
toWritable(_socket) {
let result;
const commandStr = "*" +
(this.args.length + 1) +
"\r\n$" +
Buffer.byteLength(this.name) +
"\r\n" +
this.name +
"\r\n";
if (this.bufferMode) {
const buffers = new MixedBuffers();
buffers.push(commandStr);
for (let i = 0; i < this.args.length; ++i) {
const arg = this.args[i];
if (arg instanceof Buffer) {
if (arg.length === 0) {
buffers.push("$0\r\n\r\n");
}
else {
buffers.push("$" + arg.length + "\r\n");
buffers.push(arg);
buffers.push("\r\n");
}
}
else {
buffers.push("$" +
Buffer.byteLength(arg) +
"\r\n" +
arg +
"\r\n");
}
}
result = buffers.toBuffer();
}
else {
result = commandStr;
for (let i = 0; i < this.args.length; ++i) {
const arg = this.args[i];
result +=
"$" +
Buffer.byteLength(arg) +
"\r\n" +
arg +
"\r\n";
}
}
return result;
}
stringifyArguments() {
for (let i = 0; i < this.args.length; ++i) {
const arg = this.args[i];
if (typeof arg === "string") {
// buffers and strings don't need any transformation
}
else if (arg instanceof Buffer) {
this.bufferMode = true;
}
else {
this.args[i] = (0, utils_1.toArg)(arg);
}
}
}
/**
* Convert buffer/buffer[] to string/string[],
* and apply reply transformer.
*/
transformReply(result) {
if (this.replyEncoding) {
result = (0, utils_1.convertBufferToString)(result, this.replyEncoding);
}
const transformer = Command._transformer.reply[this.name];
if (transformer) {
result = transformer(result);
}
return result;
}
/**
* Set the wait time before terminating the attempt to execute a command
* and generating an error.
*/
setTimeout(ms) {
if (!this._commandTimeoutTimer) {
this._commandTimeoutTimer = setTimeout(() => {
if (!this.isResolved) {
this.reject(new Error("Command timed out"));
}
}, ms);
}
}
/**
* Set a timeout for blocking commands.
* When the timeout expires, the command resolves with null (matching Redis behavior).
* This handles the case of undetectable network failures (e.g., docker network disconnect)
* where the TCP connection becomes a zombie and no close event fires.
*/
setBlockingTimeout(ms) {
if (ms <= 0) {
return;
}
// Clear existing timer if any (can happen when command moves from offline to command queue)
if (this._blockingTimeoutTimer) {
clearTimeout(this._blockingTimeoutTimer);
this._blockingTimeoutTimer = undefined;
}
const now = Date.now();
// First call: establish absolute deadline
if (this._blockingDeadline === undefined) {
this._blockingDeadline = now + ms;
}
// Check if we've already exceeded the deadline
const remaining = this._blockingDeadline - now;
if (remaining <= 0) {
// Resolve with null to indicate timeout (same as Redis behavior)
this.resolve(null);
return;
}
this._blockingTimeoutTimer = setTimeout(() => {
if (this.isResolved) {
this._blockingTimeoutTimer = undefined;
return;
}
this._blockingTimeoutTimer = undefined;
// Timeout expired - resolve with null (same as Redis behavior when blocking command times out)
this.resolve(null);
}, remaining);
}
/**
* Extract the blocking timeout from the command arguments.
*
* @returns The timeout in seconds, null for indefinite blocking (timeout of 0),
* or undefined if this is not a blocking command
*/
extractBlockingTimeout() {
const args = this.args;
if (!args || args.length === 0) {
return undefined;
}
const name = this.name.toLowerCase();
if (Command.checkFlag("LAST_ARG_TIMEOUT_COMMANDS", name)) {
return (0, argumentParsers_1.parseSecondsArgument)(args[args.length - 1]);
}
if (Command.checkFlag("FIRST_ARG_TIMEOUT_COMMANDS", name)) {
return (0, argumentParsers_1.parseSecondsArgument)(args[0]);
}
if (Command.checkFlag("BLOCK_OPTION_COMMANDS", name)) {
return (0, argumentParsers_1.parseBlockOption)(args);
}
return undefined;
}
/**
* Clear the command and blocking timers
*/
_clearTimers() {
const existingTimer = this._commandTimeoutTimer;
if (existingTimer) {
clearTimeout(existingTimer);
delete this._commandTimeoutTimer;
}
const blockingTimer = this._blockingTimeoutTimer;
if (blockingTimer) {
clearTimeout(blockingTimer);
delete this._blockingTimeoutTimer;
}
}
initPromise() {
const promise = new Promise((resolve, reject) => {
if (!this.transformed) {
this.transformed = true;
const transformer = Command._transformer.argument[this.name];
if (transformer) {
this.args = transformer(this.args);
}
this.stringifyArguments();
}
this.resolve = this._convertValue(resolve);
this.reject = (err) => {
this._clearTimers();
if (this.errorStack) {
reject((0, utils_1.optimizeErrorStack)(err, this.errorStack.stack, __dirname));
}
else {
reject(err);
}
};
});
this.promise = (0, standard_as_callback_1.default)(promise, this.callback);
}
/**
* Iterate through the command arguments that are considered keys.
*/
_iterateKeys(transform = (key) => key) {
if (typeof this.keys === "undefined") {
this.keys = [];
if ((0, commands_1.exists)(this.name, { caseInsensitive: true })) {
// @ts-expect-error
const keyIndexes = (0, commands_1.getKeyIndexes)(this.name, this.args, {
nameCaseInsensitive: true,
});
for (const index of keyIndexes) {
this.args[index] = transform(this.args[index]);
this.keys.push(this.args[index]);
}
}
}
return this.keys;
}
/**
* Convert the value from buffer to the target encoding.
*/
_convertValue(resolve) {
return (value) => {
try {
this._clearTimers();
resolve(this.transformReply(value));
this.isResolved = true;
}
catch (err) {
this.reject(err);
}
return this.promise;
};
}
}
exports.default = Command;
Command.FLAGS = {
VALID_IN_SUBSCRIBER_MODE: [
"subscribe",
"psubscribe",
"unsubscribe",
"punsubscribe",
"ssubscribe",
"sunsubscribe",
"ping",
"quit",
],
VALID_IN_MONITOR_MODE: ["monitor", "auth"],
ENTER_SUBSCRIBER_MODE: ["subscribe", "psubscribe", "ssubscribe"],
EXIT_SUBSCRIBER_MODE: ["unsubscribe", "punsubscribe", "sunsubscribe"],
WILL_DISCONNECT: ["quit"],
HANDSHAKE_COMMANDS: ["auth", "select", "client", "readonly", "info"],
IGNORE_RECONNECT_ON_ERROR: ["client"],
BLOCKING_COMMANDS: [
"blpop",
"brpop",
"brpoplpush",
"blmove",
"bzpopmin",
"bzpopmax",
"bzmpop",
"blmpop",
"xread",
"xreadgroup",
],
LAST_ARG_TIMEOUT_COMMANDS: [
"blpop",
"brpop",
"brpoplpush",
"blmove",
"bzpopmin",
"bzpopmax",
],
FIRST_ARG_TIMEOUT_COMMANDS: ["bzmpop", "blmpop"],
BLOCK_OPTION_COMMANDS: ["xread", "xreadgroup"],
};
Command._transformer = {
argument: {},
reply: {},
};
const msetArgumentTransformer = function (args) {
if (args.length === 1) {
if (args[0] instanceof Map) {
return (0, utils_1.convertMapToArray)(args[0]);
}
if (typeof args[0] === "object" && args[0] !== null) {
return (0, utils_1.convertObjectToArray)(args[0]);
}
}
return args;
};
const hsetArgumentTransformer = function (args) {
if (args.length === 2) {
if (args[1] instanceof Map) {
return [args[0]].concat((0, utils_1.convertMapToArray)(args[1]));
}
if (typeof args[1] === "object" && args[1] !== null) {
return [args[0]].concat((0, utils_1.convertObjectToArray)(args[1]));
}
}
return args;
};
Command.setArgumentTransformer("mset", msetArgumentTransformer);
Command.setArgumentTransformer("msetnx", msetArgumentTransformer);
Command.setArgumentTransformer("hset", hsetArgumentTransformer);
Command.setArgumentTransformer("hmset", hsetArgumentTransformer);
Command.setReplyTransformer("hgetall", function (result) {
if (Array.isArray(result)) {
const obj = {};
for (let i = 0; i < result.length; i += 2) {
const key = result[i];
const value = result[i + 1];
if (key in obj) {
// can only be truthy if the property is special somehow, like '__proto__' or 'constructor'
// https://github.com/luin/ioredis/issues/1267
Object.defineProperty(obj, key, {
value,
configurable: true,
enumerable: true,
writable: true,
});
}
else {
obj[key] = value;
}
}
return obj;
}
return result;
});
class MixedBuffers {
constructor() {
this.length = 0;
this.items = [];
}
push(x) {
this.length += Buffer.byteLength(x);
this.items.push(x);
}
toBuffer() {
const result = Buffer.allocUnsafe(this.length);
let offset = 0;
for (const item of this.items) {
const length = Buffer.byteLength(item);
Buffer.isBuffer(item)
? item.copy(result, offset)
: result.write(item, offset, length);
offset += length;
}
return result;
}
}
landvex/node_modules/ioredis/built/DataHandler.d.ts
Generated Vendored
+37
View File
@@ -0,0 +1,37 @@
/// <reference types="node" />
import { NetStream, CommandItem } from "./types";
import Deque = require("denque");
import { EventEmitter } from "events";
import SubscriptionSet from "./SubscriptionSet";
export interface Condition {
select: number;
auth?: string | [string, string];
subscriber: false | SubscriptionSet;
}
export declare type FlushQueueOptions = {
offlineQueue?: boolean;
commandQueue?: boolean;
};
export interface DataHandledable extends EventEmitter {
stream: NetStream;
status: string;
condition: Condition | null;
commandQueue: Deque<CommandItem>;
disconnect(reconnect: boolean): void;
recoverFromFatalError(commandError: Error, err: Error, options: FlushQueueOptions): void;
handleReconnection(err: Error, item: CommandItem): void;
}
interface ParserOptions {
stringNumbers: boolean;
}
export default class DataHandler {
private redis;
constructor(redis: DataHandledable, parserOptions: ParserOptions);
private returnFatalError;
private returnError;
private returnReply;
private handleSubscriberReply;
private handleMonitorReply;
private shiftCommand;
}
export {};
landvex/node_modules/ioredis/built/DataHandler.js
Generated Vendored
+224
View File
@@ -0,0 +1,224 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const Command_1 = require("./Command");
const utils_1 = require("./utils");
const RedisParser = require("redis-parser");
const SubscriptionSet_1 = require("./SubscriptionSet");
const debug = (0, utils_1.Debug)("dataHandler");
class DataHandler {
constructor(redis, parserOptions) {
this.redis = redis;
const parser = new RedisParser({
stringNumbers: parserOptions.stringNumbers,
returnBuffers: true,
returnError: (err) => {
this.returnError(err);
},
returnFatalError: (err) => {
this.returnFatalError(err);
},
returnReply: (reply) => {
this.returnReply(reply);
},
});
// prependListener ensures the parser receives and processes data before socket timeout checks are performed
redis.stream.prependListener("data", (data) => {
parser.execute(data);
});
// prependListener() doesn't enable flowing mode automatically - we need to resume the stream manually
redis.stream.resume();
}
returnFatalError(err) {
err.message += ". Please report this.";
this.redis.recoverFromFatalError(err, err, { offlineQueue: false });
}
returnError(err) {
const item = this.shiftCommand(err);
if (!item) {
return;
}
err.command = {
name: item.command.name,
args: item.command.args,
};
if (item.command.name == "ssubscribe" && err.message.includes("MOVED")) {
this.redis.emit("moved");
return;
}
this.redis.handleReconnection(err, item);
}
returnReply(reply) {
if (this.handleMonitorReply(reply)) {
return;
}
if (this.handleSubscriberReply(reply)) {
return;
}
const item = this.shiftCommand(reply);
if (!item) {
return;
}
if (Command_1.default.checkFlag("ENTER_SUBSCRIBER_MODE", item.command.name)) {
this.redis.condition.subscriber = new SubscriptionSet_1.default();
this.redis.condition.subscriber.add(item.command.name, reply[1].toString());
if (!fillSubCommand(item.command, reply[2])) {
this.redis.commandQueue.unshift(item);
}
}
else if (Command_1.default.checkFlag("EXIT_SUBSCRIBER_MODE", item.command.name)) {
if (!fillUnsubCommand(item.command, reply[2])) {
this.redis.commandQueue.unshift(item);
}
}
else {
item.command.resolve(reply);
}
}
handleSubscriberReply(reply) {
if (!this.redis.condition.subscriber) {
return false;
}
const replyType = Array.isArray(reply) ? reply[0].toString() : null;
debug('receive reply "%s" in subscriber mode', replyType);
switch (replyType) {
case "message":
if (this.redis.listeners("message").length > 0) {
// Check if there're listeners to avoid unnecessary `toString()`.
this.redis.emit("message", reply[1].toString(), reply[2] ? reply[2].toString() : "");
}
this.redis.emit("messageBuffer", reply[1], reply[2]);
break;
case "pmessage": {
const pattern = reply[1].toString();
if (this.redis.listeners("pmessage").length > 0) {
this.redis.emit("pmessage", pattern, reply[2].toString(), reply[3].toString());
}
this.redis.emit("pmessageBuffer", pattern, reply[2], reply[3]);
break;
}
case "smessage": {
if (this.redis.listeners("smessage").length > 0) {
this.redis.emit("smessage", reply[1].toString(), reply[2] ? reply[2].toString() : "");
}
this.redis.emit("smessageBuffer", reply[1], reply[2]);
break;
}
case "ssubscribe":
case "subscribe":
case "psubscribe": {
const channel = reply[1].toString();
this.redis.condition.subscriber.add(replyType, channel);
const item = this.shiftCommand(reply);
if (!item) {
return;
}
if (!fillSubCommand(item.command, reply[2])) {
this.redis.commandQueue.unshift(item);
}
break;
}
case "sunsubscribe":
case "unsubscribe":
case "punsubscribe": {
const channel = reply[1] ? reply[1].toString() : null;
if (channel) {
this.redis.condition.subscriber.del(replyType, channel);
}
const count = reply[2];
if (Number(count) === 0) {
this.redis.condition.subscriber = false;
}
const item = this.shiftCommand(reply);
if (!item) {
return;
}
if (!fillUnsubCommand(item.command, count)) {
this.redis.commandQueue.unshift(item);
}
break;
}
default: {
const item = this.shiftCommand(reply);
if (!item) {
return;
}
item.command.resolve(reply);
}
}
return true;
}
handleMonitorReply(reply) {
if (this.redis.status !== "monitoring") {
return false;
}
const replyStr = reply.toString();
if (replyStr === "OK") {
// Valid commands in the monitoring mode are AUTH and MONITOR,
// both of which always reply with 'OK'.
// So if we got an 'OK', we can make certain that
// the reply is made to AUTH & MONITOR.
return false;
}
// Since commands sent in the monitoring mode will trigger an exception,
// any replies we received in the monitoring mode should consider to be
// realtime monitor data instead of result of commands.
const len = replyStr.indexOf(" ");
const timestamp = replyStr.slice(0, len);
const argIndex = replyStr.indexOf('"');
const args = replyStr
.slice(argIndex + 1, -1)
.split('" "')
.map((elem) => elem.replace(/\\"/g, '"'));
const dbAndSource = replyStr.slice(len + 2, argIndex - 2).split(" ");
this.redis.emit("monitor", timestamp, args, dbAndSource[1], dbAndSource[0]);
return true;
}
shiftCommand(reply) {
const item = this.redis.commandQueue.shift();
if (!item) {
const message = "Command queue state error. If you can reproduce this, please report it.";
const error = new Error(message +
(reply instanceof Error
? ` Last error: ${reply.message}`
: ` Last reply: ${reply.toString()}`));
this.redis.emit("error", error);
return null;
}
return item;
}
}
exports.default = DataHandler;
const remainingRepliesMap = new WeakMap();
function fillSubCommand(command, count) {
let remainingReplies = remainingRepliesMap.has(command)
? remainingRepliesMap.get(command)
: command.args.length;
remainingReplies -= 1;
if (remainingReplies <= 0) {
command.resolve(count);
remainingRepliesMap.delete(command);
return true;
}
remainingRepliesMap.set(command, remainingReplies);
return false;
}
function fillUnsubCommand(command, count) {
let remainingReplies = remainingRepliesMap.has(command)
? remainingRepliesMap.get(command)
: command.args.length;
if (remainingReplies === 0) {
if (Number(count) === 0) {
remainingRepliesMap.delete(command);
command.resolve(count);
return true;
}
return false;
}
remainingReplies -= 1;
if (remainingReplies <= 0) {
command.resolve(count);
return true;
}
remainingRepliesMap.set(command, remainingReplies);
return false;
}
landvex/node_modules/ioredis/built/Pipeline.d.ts
Generated Vendored
+31
View File
@@ -0,0 +1,31 @@
import Redis from "./Redis";
import Cluster from "./cluster";
import Command from "./Command";
import Commander from "./utils/Commander";
declare class Pipeline extends Commander<{
type: "pipeline";
}> {
redis: Redis | Cluster;
isCluster: boolean;
isPipeline: boolean;
leftRedirections: {
value?: number;
};
promise: Promise<unknown>;
resolve: (result: unknown) => void;
reject: (error: Error) => void;
private replyPending;
private _queue;
private _result;
private _transactions;
private _shaToScript;
private preferKey;
constructor(redis: Redis | Cluster);
fillResult(value: unknown[], position: number): void;
sendCommand(command: Command): unknown;
addBatch(commands: any): this;
}
export default Pipeline;
interface Pipeline {
length: number;
}
landvex/node_modules/ioredis/built/Pipeline.js
Generated Vendored
+352
View File
@@ -0,0 +1,352 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const calculateSlot = require("cluster-key-slot");
const commands_1 = require("@ioredis/commands");
const standard_as_callback_1 = require("standard-as-callback");
const util_1 = require("util");
const Command_1 = require("./Command");
const buffer_1 = require("buffer");
const utils_1 = require("./utils");
const Commander_1 = require("./utils/Commander");
/*
This function derives from the cluster-key-slot implementation.
Instead of checking that all keys have the same slot, it checks that all slots are served by the same set of nodes.
If this is satisfied, it returns the first key's slot.
*/
function generateMultiWithNodes(redis, keys) {
const slot = calculateSlot(keys[0]);
const target = redis._groupsBySlot[slot];
for (let i = 1; i < keys.length; i++) {
if (redis._groupsBySlot[calculateSlot(keys[i])] !== target) {
return -1;
}
}
return slot;
}
class Pipeline extends Commander_1.default {
constructor(redis) {
super();
this.redis = redis;
this.isPipeline = true;
this.replyPending = 0;
this._queue = [];
this._result = [];
this._transactions = 0;
this._shaToScript = {};
this.isCluster =
this.redis.constructor.name === "Cluster" || this.redis.isCluster;
this.options = redis.options;
Object.keys(redis.scriptsSet).forEach((name) => {
const script = redis.scriptsSet[name];
this._shaToScript[script.sha] = script;
this[name] = redis[name];
this[name + "Buffer"] = redis[name + "Buffer"];
});
redis.addedBuiltinSet.forEach((name) => {
this[name] = redis[name];
this[name + "Buffer"] = redis[name + "Buffer"];
});
this.promise = new Promise((resolve, reject) => {
this.resolve = resolve;
this.reject = reject;
});
const _this = this;
Object.defineProperty(this, "length", {
get: function () {
return _this._queue.length;
},
});
}
fillResult(value, position) {
if (this._queue[position].name === "exec" && Array.isArray(value[1])) {
const execLength = value[1].length;
for (let i = 0; i < execLength; i++) {
if (value[1][i] instanceof Error) {
continue;
}
const cmd = this._queue[position - (execLength - i)];
try {
value[1][i] = cmd.transformReply(value[1][i]);
}
catch (err) {
value[1][i] = err;
}
}
}
this._result[position] = value;
if (--this.replyPending) {
return;
}
if (this.isCluster) {
let retriable = true;
let commonError;
for (let i = 0; i < this._result.length; ++i) {
const error = this._result[i][0];
const command = this._queue[i];
if (error) {
if (command.name === "exec" &&
error.message ===
"EXECABORT Transaction discarded because of previous errors.") {
continue;
}
if (!commonError) {
commonError = {
name: error.name,
message: error.message,
};
}
else if (commonError.name !== error.name ||
commonError.message !== error.message) {
retriable = false;
break;
}
}
else if (!command.inTransaction) {
const isReadOnly = (0, commands_1.exists)(command.name, { caseInsensitive: true }) &&
(0, commands_1.hasFlag)(command.name, "readonly", { nameCaseInsensitive: true });
if (!isReadOnly) {
retriable = false;
break;
}
}
}
if (commonError && retriable) {
const _this = this;
const errv = commonError.message.split(" ");
const queue = this._queue;
let inTransaction = false;
this._queue = [];
for (let i = 0; i < queue.length; ++i) {
if (errv[0] === "ASK" &&
!inTransaction &&
queue[i].name !== "asking" &&
(!queue[i - 1] || queue[i - 1].name !== "asking")) {
const asking = new Command_1.default("asking");
asking.ignore = true;
this.sendCommand(asking);
}
queue[i].initPromise();
this.sendCommand(queue[i]);
inTransaction = queue[i].inTransaction;
}
let matched = true;
if (typeof this.leftRedirections === "undefined") {
this.leftRedirections = {};
}
const exec = function () {
_this.exec();
};
const cluster = this.redis;
cluster.handleError(commonError, this.leftRedirections, {
moved: function (_slot, key) {
_this.preferKey = key;
if (cluster.slots[errv[1]]) {
if (cluster.slots[errv[1]][0] !== key) {
cluster.slots[errv[1]] = [key];
}
}
else {
cluster.slots[errv[1]] = [key];
}
cluster._groupsBySlot[errv[1]] =
cluster._groupsIds[cluster.slots[errv[1]].join(";")];
cluster.refreshSlotsCache();
_this.exec();
},
ask: function (_slot, key) {
_this.preferKey = key;
_this.exec();
},
tryagain: exec,
clusterDown: exec,
connectionClosed: exec,
maxRedirections: () => {
matched = false;
},
defaults: () => {
matched = false;
},
});
if (matched) {
return;
}
}
}
let ignoredCount = 0;
for (let i = 0; i < this._queue.length - ignoredCount; ++i) {
if (this._queue[i + ignoredCount].ignore) {
ignoredCount += 1;
}
this._result[i] = this._result[i + ignoredCount];
}
this.resolve(this._result.slice(0, this._result.length - ignoredCount));
}
sendCommand(command) {
if (this._transactions > 0) {
command.inTransaction = true;
}
const position = this._queue.length;
command.pipelineIndex = position;
command.promise
.then((result) => {
this.fillResult([null, result], position);
})
.catch((error) => {
this.fillResult([error], position);
});
this._queue.push(command);
return this;
}
addBatch(commands) {
let command, commandName, args;
for (let i = 0; i < commands.length; ++i) {
command = commands[i];
commandName = command[0];
args = command.slice(1);
this[commandName].apply(this, args);
}
return this;
}
}
exports.default = Pipeline;
// @ts-expect-error
const multi = Pipeline.prototype.multi;
// @ts-expect-error
Pipeline.prototype.multi = function () {
this._transactions += 1;
return multi.apply(this, arguments);
};
// @ts-expect-error
const execBuffer = Pipeline.prototype.execBuffer;
// @ts-expect-error
Pipeline.prototype.execBuffer = (0, util_1.deprecate)(function () {
if (this._transactions > 0) {
this._transactions -= 1;
}
return execBuffer.apply(this, arguments);
}, "Pipeline#execBuffer: Use Pipeline#exec instead");
// NOTE: To avoid an unhandled promise rejection, this will unconditionally always return this.promise,
// which always has the rejection handled by standard-as-callback
// adding the provided rejection callback.
//
// If a different promise instance were returned, that promise would cause its own unhandled promise rejection
// errors, even if that promise unconditionally resolved to **the resolved value of** this.promise.
Pipeline.prototype.exec = function (callback) {
// Wait for the cluster to be connected, since we need nodes information before continuing
if (this.isCluster && !this.redis.slots.length) {
if (this.redis.status === "wait")
this.redis.connect().catch(utils_1.noop);
if (callback && !this.nodeifiedPromise) {
this.nodeifiedPromise = true;
(0, standard_as_callback_1.default)(this.promise, callback);
}
this.redis.delayUntilReady((err) => {
if (err) {
this.reject(err);
return;
}
this.exec(callback);
});
return this.promise;
}
if (this._transactions > 0) {
this._transactions -= 1;
return execBuffer.apply(this, arguments);
}
if (!this.nodeifiedPromise) {
this.nodeifiedPromise = true;
(0, standard_as_callback_1.default)(this.promise, callback);
}
if (!this._queue.length) {
this.resolve([]);
}
let pipelineSlot;
if (this.isCluster) {
// List of the first key for each command
const sampleKeys = [];
for (let i = 0; i < this._queue.length; i++) {
const keys = this._queue[i].getKeys();
if (keys.length) {
sampleKeys.push(keys[0]);
}
// For each command, check that the keys belong to the same slot
if (keys.length && calculateSlot.generateMulti(keys) < 0) {
this.reject(new Error("All the keys in a pipeline command should belong to the same slot"));
return this.promise;
}
}
if (sampleKeys.length) {
pipelineSlot = generateMultiWithNodes(this.redis, sampleKeys);
if (pipelineSlot < 0) {
this.reject(new Error("All keys in the pipeline should belong to the same slots allocation group"));
return this.promise;
}
}
else {
// Send the pipeline to a random node
pipelineSlot = (Math.random() * 16384) | 0;
}
}
const _this = this;
execPipeline();
return this.promise;
function execPipeline() {
let writePending = (_this.replyPending = _this._queue.length);
let node;
if (_this.isCluster) {
node = {
slot: pipelineSlot,
redis: _this.redis.connectionPool.nodes.all[_this.preferKey],
};
}
let data = "";
let buffers;
const stream = {
isPipeline: true,
destination: _this.isCluster ? node : { redis: _this.redis },
write(writable) {
if (typeof writable !== "string") {
if (!buffers) {
buffers = [];
}
if (data) {
buffers.push(Buffer.from(data, "utf8"));
data = "";
}
buffers.push(writable);
}
else {
if (data.length + writable.length >= buffer_1.constants.MAX_STRING_LENGTH) {
if (!buffers) {
buffers = [];
}
if (data) {
buffers.push(Buffer.from(data, "utf8"));
data = "";
}
}
data += writable;
}
if (!--writePending) {
if (buffers) {
if (data) {
buffers.push(Buffer.from(data, "utf8"));
}
stream.destination.redis.stream.write(Buffer.concat(buffers));
}
else {
stream.destination.redis.stream.write(data);
}
// Reset writePending for resending
writePending = _this._queue.length;
data = "";
buffers = undefined;
}
},
};
for (let i = 0; i < _this._queue.length; ++i) {
_this.redis.sendCommand(_this._queue[i], stream, node);
}
return _this.promise;
}
};
landvex/node_modules/ioredis/built/Redis.d.ts
Generated Vendored
+243
View File
@@ -0,0 +1,243 @@
/// <reference types="node" />
import { EventEmitter } from "events";
import Cluster from "./cluster";
import Command from "./Command";
import { DataHandledable, FlushQueueOptions, Condition } from "./DataHandler";
import { RedisOptions } from "./redis/RedisOptions";
import ScanStream from "./ScanStream";
import { Transaction } from "./transaction";
import { Callback, CommandItem, NetStream, ScanStreamOptions, WriteableStream } from "./types";
import { type BatchOperationContext } from "./tracing";
import Commander from "./utils/Commander";
import Deque = require("denque");
declare type RedisStatus = "wait" | "reconnecting" | "connecting" | "connect" | "ready" | "close" | "end";
/**
* This is the major component of ioredis.
* Use it to connect to a standalone Redis server or Sentinels.
*
* ```typescript
* const redis = new Redis(); // Default port is 6379
* async function main() {
* redis.set("foo", "bar");
* redis.get("foo", (err, result) => {
* // `result` should be "bar"
* console.log(err, result);
* });
* // Or use Promise
* const result = await redis.get("foo");
* }
* ```
*/
declare class Redis extends Commander implements DataHandledable {
static Cluster: typeof Cluster;
static Command: typeof Command;
/**
* Default options
*/
private static defaultOptions;
/**
* Create a Redis instance.
* This is the same as `new Redis()` but is included for compatibility with node-redis.
*/
static createClient(...args: ConstructorParameters<typeof Redis>): Redis;
options: RedisOptions;
status: RedisStatus;
/**
* @ignore
*/
stream: NetStream;
/**
* @ignore
*/
isCluster: boolean;
/**
* @ignore
*/
condition: Condition | null;
/**
* @ignore
*/
commandQueue: Deque<CommandItem>;
private connector;
private reconnectTimeout;
private offlineQueue;
private connectionEpoch;
private retryAttempts;
private manuallyClosing;
private socketTimeoutTimer;
private _autoPipelines;
private _runningAutoPipelines;
constructor(port: number, host: string, options: RedisOptions);
constructor(path: string, options: RedisOptions);
constructor(port: number, options: RedisOptions);
constructor(port: number, host: string);
constructor(options: RedisOptions);
constructor(port: number);
constructor(path: string);
constructor();
get autoPipelineQueueSize(): number;
/**
* Create a connection to Redis.
* This method will be invoked automatically when creating a new Redis instance
* unless `lazyConnect: true` is passed.
*
* When calling this method manually, a Promise is returned, which will
* be resolved when the connection status is ready. The promise can reject
* if the connection fails, times out, or if Redis is already connecting/connected.
*/
connect(callback?: Callback<void>): Promise<void>;
private _connect;
/**
* Disconnect from Redis.
*
* This method closes the connection immediately,
* and may lose some pending replies that haven't written to client.
* If you want to wait for the pending replies, use Redis#quit instead.
*/
disconnect(reconnect?: boolean): void;
/**
* Disconnect from Redis.
*
* @deprecated
*/
end(): void;
/**
* Create a new instance with the same options as the current one.
*
* @example
* ```js
* var redis = new Redis(6380);
* var anotherRedis = redis.duplicate();
* ```
*/
duplicate(override?: Partial<RedisOptions>): Redis;
/**
* Mode of the connection.
*
* One of `"normal"`, `"subscriber"`, or `"monitor"`. When the connection is
* not in `"normal"` mode, certain commands are not allowed.
*/
get mode(): "normal" | "subscriber" | "monitor";
/**
* Listen for all requests received by the server in real time.
*
* This command will create a new connection to Redis and send a
* MONITOR command via the new connection in order to avoid disturbing
* the current connection.
*
* @param callback The callback function. If omit, a promise will be returned.
* @example
* ```js
* var redis = new Redis();
* redis.monitor(function (err, monitor) {
* // Entering monitoring mode.
* monitor.on('monitor', function (time, args, source, database) {
* console.log(time + ": " + util.inspect(args));
* });
* });
*
* // supports promise as well as other commands
* redis.monitor().then(function (monitor) {
* monitor.on('monitor', function (time, args, source, database) {
* console.log(time + ": " + util.inspect(args));
* });
* });
* ```
*/
monitor(callback?: Callback<Redis>): Promise<Redis>;
/**
* Send a command to Redis
*
* This method is used internally and in most cases you should not
* use it directly. If you need to send a command that is not supported
* by the library, you can use the `call` method:
*
* ```js
* const redis = new Redis();
*
* redis.call('set', 'foo', 'bar');
* // or
* redis.call(['set', 'foo', 'bar']);
* ```
*
* @ignore
*/
sendCommand(command: Command, stream?: WriteableStream): unknown;
private getBlockingTimeoutInMs;
private getConfiguredBlockingTimeout;
private setSocketTimeout;
scanStream(options?: ScanStreamOptions): ScanStream;
scanBufferStream(options?: ScanStreamOptions): ScanStream;
sscanStream(key: string, options?: ScanStreamOptions): ScanStream;
sscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream;
hscanStream(key: string, options?: ScanStreamOptions): ScanStream;
hscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream;
zscanStream(key: string, options?: ScanStreamOptions): ScanStream;
zscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream;
/**
* Emit only when there's at least one listener.
*
* @ignore
*/
silentEmit(eventName: string, arg?: unknown): boolean;
/**
* @ignore
*/
recoverFromFatalError(_commandError: Error, err: Error, options: FlushQueueOptions): void;
/**
* @ignore
*/
handleReconnection(err: Error, item: CommandItem): void;
/**
* @ignore
*/
_getServerAddress(): {
address: string;
port: number | undefined;
};
private _buildCommandContext;
_buildBatchContext(batchSize: number): BatchOperationContext;
/**
* Get description of the connection. Used for debugging.
*/
private _getDescription;
private resetCommandQueue;
private resetOfflineQueue;
private parseOptions;
/**
* Change instance's status
*/
private setStatus;
private createScanStream;
/**
* Flush offline queue and command queue with error.
*
* @param error The error object to send to the commands
* @param options options
*/
private flushQueue;
/**
* Check whether Redis has finished loading the persistent data and is able to
* process commands.
*/
private _readyCheck;
}
interface Redis extends EventEmitter {
on(event: "message", cb: (channel: string, message: string) => void): this;
once(event: "message", cb: (channel: string, message: string) => void): this;
on(event: "messageBuffer", cb: (channel: Buffer, message: Buffer) => void): this;
once(event: "messageBuffer", cb: (channel: Buffer, message: Buffer) => void): this;
on(event: "pmessage", cb: (pattern: string, channel: string, message: string) => void): this;
once(event: "pmessage", cb: (pattern: string, channel: string, message: string) => void): this;
on(event: "pmessageBuffer", cb: (pattern: string, channel: Buffer, message: Buffer) => void): this;
once(event: "pmessageBuffer", cb: (pattern: string, channel: Buffer, message: Buffer) => void): this;
on(event: "error", cb: (error: Error) => void): this;
once(event: "error", cb: (error: Error) => void): this;
on(event: RedisStatus, cb: () => void): this;
once(event: RedisStatus, cb: () => void): this;
on(event: string | symbol, listener: (...args: any[]) => void): this;
once(event: string | symbol, listener: (...args: any[]) => void): this;
}
interface Redis extends Transaction {
}
export default Redis;
landvex/node_modules/ioredis/built/Redis.js
Generated Vendored
+800
View File
@@ -0,0 +1,800 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const commands_1 = require("@ioredis/commands");
const events_1 = require("events");
const standard_as_callback_1 = require("standard-as-callback");
const cluster_1 = require("./cluster");
const Command_1 = require("./Command");
const connectors_1 = require("./connectors");
const SentinelConnector_1 = require("./connectors/SentinelConnector");
const eventHandler = require("./redis/event_handler");
const RedisOptions_1 = require("./redis/RedisOptions");
const ScanStream_1 = require("./ScanStream");
const transaction_1 = require("./transaction");
const utils_1 = require("./utils");
const tracing_1 = require("./tracing");
const applyMixin_1 = require("./utils/applyMixin");
const Commander_1 = require("./utils/Commander");
const lodash_1 = require("./utils/lodash");
const Deque = require("denque");
const debug = (0, utils_1.Debug)("redis");
/**
* This is the major component of ioredis.
* Use it to connect to a standalone Redis server or Sentinels.
*
* ```typescript
* const redis = new Redis(); // Default port is 6379
* async function main() {
* redis.set("foo", "bar");
* redis.get("foo", (err, result) => {
* // `result` should be "bar"
* console.log(err, result);
* });
* // Or use Promise
* const result = await redis.get("foo");
* }
* ```
*/
class Redis extends Commander_1.default {
constructor(arg1, arg2, arg3) {
super();
this.status = "wait";
/**
* @ignore
*/
this.isCluster = false;
this.reconnectTimeout = null;
this.connectionEpoch = 0;
this.retryAttempts = 0;
this.manuallyClosing = false;
// Prepare autopipelines structures
this._autoPipelines = new Map();
this._runningAutoPipelines = new Set();
this.parseOptions(arg1, arg2, arg3);
events_1.EventEmitter.call(this);
this.resetCommandQueue();
this.resetOfflineQueue();
if (this.options.Connector) {
this.connector = new this.options.Connector(this.options);
}
else if (this.options.sentinels) {
const sentinelConnector = new SentinelConnector_1.default(this.options);
sentinelConnector.emitter = this;
this.connector = sentinelConnector;
}
else {
this.connector = new connectors_1.StandaloneConnector(this.options);
}
if (this.options.scripts) {
Object.entries(this.options.scripts).forEach(([name, definition]) => {
this.defineCommand(name, definition);
});
}
// end(or wait) -> connecting -> connect -> ready -> end
if (this.options.lazyConnect) {
this.setStatus("wait");
}
else {
this.connect().catch(lodash_1.noop);
}
}
/**
* Create a Redis instance.
* This is the same as `new Redis()` but is included for compatibility with node-redis.
*/
static createClient(...args) {
return new Redis(...args);
}
get autoPipelineQueueSize() {
let queued = 0;
for (const pipeline of this._autoPipelines.values()) {
queued += pipeline.length;
}
return queued;
}
/**
* Create a connection to Redis.
* This method will be invoked automatically when creating a new Redis instance
* unless `lazyConnect: true` is passed.
*
* When calling this method manually, a Promise is returned, which will
* be resolved when the connection status is ready. The promise can reject
* if the connection fails, times out, or if Redis is already connecting/connected.
*/
connect(callback) {
const promise = (0, tracing_1.traceConnect)(() => this._connect(), () => {
const { address, port } = this._getServerAddress();
return {
serverAddress: address,
serverPort: port,
connectionEpoch: this.connectionEpoch,
};
});
return (0, standard_as_callback_1.default)(promise, callback);
}
_connect() {
return new Promise((resolve, reject) => {
if (this.status === "connecting" ||
this.status === "connect" ||
this.status === "ready") {
reject(new Error("Redis is already connecting/connected"));
return;
}
this.connectionEpoch += 1;
this.setStatus("connecting");
const { options } = this;
this.condition = {
select: options.db,
auth: options.username
? [options.username, options.password]
: options.password,
subscriber: false,
};
const _this = this;
(0, standard_as_callback_1.default)(this.connector.connect(function (type, err) {
_this.silentEmit(type, err);
}), function (err, stream) {
if (err) {
_this.flushQueue(err);
_this.silentEmit("error", err);
reject(err);
_this.setStatus("end");
return;
}
let CONNECT_EVENT = options.tls ? "secureConnect" : "connect";
if ("sentinels" in options &&
options.sentinels &&
!options.enableTLSForSentinelMode) {
CONNECT_EVENT = "connect";
}
_this.stream = stream;
if (options.noDelay) {
stream.setNoDelay(true);
}
// Node ignores setKeepAlive before connect, therefore we wait for the event:
// https://github.com/nodejs/node/issues/31663
if (typeof options.keepAlive === "number") {
if (stream.connecting) {
stream.once(CONNECT_EVENT, () => {
stream.setKeepAlive(true, options.keepAlive);
});
}
else {
stream.setKeepAlive(true, options.keepAlive);
}
}
if (stream.connecting) {
stream.once(CONNECT_EVENT, eventHandler.connectHandler(_this));
if (options.connectTimeout) {
/*
* Typically, Socket#setTimeout(0) will clear the timer
* set before. However, in some platforms (Electron 3.x~4.x),
* the timer will not be cleared. So we introduce a variable here.
*
* See https://github.com/electron/electron/issues/14915
*/
let connectTimeoutCleared = false;
stream.setTimeout(options.connectTimeout, function () {
if (connectTimeoutCleared) {
return;
}
stream.setTimeout(0);
stream.destroy();
const err = new Error("connect ETIMEDOUT");
// @ts-expect-error
err.errorno = "ETIMEDOUT";
// @ts-expect-error
err.code = "ETIMEDOUT";
// @ts-expect-error
err.syscall = "connect";
eventHandler.errorHandler(_this)(err);
});
stream.once(CONNECT_EVENT, function () {
connectTimeoutCleared = true;
stream.setTimeout(0);
});
}
}
else if (stream.destroyed) {
const firstError = _this.connector.firstError;
if (firstError) {
process.nextTick(() => {
eventHandler.errorHandler(_this)(firstError);
});
}
process.nextTick(eventHandler.closeHandler(_this));
}
else {
process.nextTick(eventHandler.connectHandler(_this));
}
if (!stream.destroyed) {
stream.once("error", eventHandler.errorHandler(_this));
stream.once("close", eventHandler.closeHandler(_this));
}
const connectionReadyHandler = function () {
_this.removeListener("close", connectionCloseHandler);
resolve();
};
var connectionCloseHandler = function () {
_this.removeListener("ready", connectionReadyHandler);
reject(new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG));
};
_this.once("ready", connectionReadyHandler);
_this.once("close", connectionCloseHandler);
});
});
}
/**
* Disconnect from Redis.
*
* This method closes the connection immediately,
* and may lose some pending replies that haven't written to client.
* If you want to wait for the pending replies, use Redis#quit instead.
*/
disconnect(reconnect = false) {
if (!reconnect) {
this.manuallyClosing = true;
}
if (this.reconnectTimeout && !reconnect) {
clearTimeout(this.reconnectTimeout);
this.reconnectTimeout = null;
}
if (this.status === "wait") {
eventHandler.closeHandler(this)();
}
else {
this.connector.disconnect();
}
}
/**
* Disconnect from Redis.
*
* @deprecated
*/
end() {
this.disconnect();
}
/**
* Create a new instance with the same options as the current one.
*
* @example
* ```js
* var redis = new Redis(6380);
* var anotherRedis = redis.duplicate();
* ```
*/
duplicate(override) {
return new Redis({ ...this.options, ...override });
}
/**
* Mode of the connection.
*
* One of `"normal"`, `"subscriber"`, or `"monitor"`. When the connection is
* not in `"normal"` mode, certain commands are not allowed.
*/
get mode() {
var _a;
return this.options.monitor
? "monitor"
: ((_a = this.condition) === null || _a === void 0 ? void 0 : _a.subscriber)
? "subscriber"
: "normal";
}
/**
* Listen for all requests received by the server in real time.
*
* This command will create a new connection to Redis and send a
* MONITOR command via the new connection in order to avoid disturbing
* the current connection.
*
* @param callback The callback function. If omit, a promise will be returned.
* @example
* ```js
* var redis = new Redis();
* redis.monitor(function (err, monitor) {
* // Entering monitoring mode.
* monitor.on('monitor', function (time, args, source, database) {
* console.log(time + ": " + util.inspect(args));
* });
* });
*
* // supports promise as well as other commands
* redis.monitor().then(function (monitor) {
* monitor.on('monitor', function (time, args, source, database) {
* console.log(time + ": " + util.inspect(args));
* });
* });
* ```
*/
monitor(callback) {
const monitorInstance = this.duplicate({
monitor: true,
lazyConnect: false,
});
return (0, standard_as_callback_1.default)(new Promise(function (resolve, reject) {
monitorInstance.once("error", reject);
monitorInstance.once("monitoring", function () {
resolve(monitorInstance);
});
}), callback);
}
/**
* Send a command to Redis
*
* This method is used internally and in most cases you should not
* use it directly. If you need to send a command that is not supported
* by the library, you can use the `call` method:
*
* ```js
* const redis = new Redis();
*
* redis.call('set', 'foo', 'bar');
* // or
* redis.call(['set', 'foo', 'bar']);
* ```
*
* @ignore
*/
sendCommand(command, stream) {
var _a, _b;
if (this.status === "wait") {
this.connect().catch(lodash_1.noop);
}
if (this.status === "end") {
command.reject(new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG));
return command.promise;
}
if (((_a = this.condition) === null || _a === void 0 ? void 0 : _a.subscriber) &&
!Command_1.default.checkFlag("VALID_IN_SUBSCRIBER_MODE", command.name)) {
command.reject(new Error("Connection in subscriber mode, only subscriber commands may be used"));
return command.promise;
}
if (typeof this.options.commandTimeout === "number") {
command.setTimeout(this.options.commandTimeout);
}
const blockingTimeout = this.getBlockingTimeoutInMs(command);
let writable = this.status === "ready" ||
(!stream &&
this.status === "connect" &&
(0, commands_1.exists)(command.name, { caseInsensitive: true }) &&
((0, commands_1.hasFlag)(command.name, "loading", { nameCaseInsensitive: true }) ||
Command_1.default.checkFlag("HANDSHAKE_COMMANDS", command.name)));
if (!this.stream) {
writable = false;
}
else if (!this.stream.writable) {
writable = false;
// @ts-expect-error
}
else if (this.stream._writableState && this.stream._writableState.ended) {
// TODO: We should be able to remove this as the PR has already been merged.
// https://github.com/iojs/io.js/pull/1217
writable = false;
}
if (!writable) {
if (!this.options.enableOfflineQueue) {
command.reject(new Error("Stream isn't writeable and enableOfflineQueue options is false"));
return command.promise;
}
if (command.name === "quit" && this.offlineQueue.length === 0) {
this.disconnect();
command.resolve(Buffer.from("OK"));
return command.promise;
}
// @ts-expect-error
if (debug.enabled) {
debug("queue command[%s]: %d -> %s(%o)", this._getDescription(), this.condition.select, command.name, command.args);
}
this.offlineQueue.push({
command: command,
stream: stream,
select: this.condition.select,
});
// For blocking commands in the offline queue, arm a client-side timeout
// only when blockingTimeout is configured. Without this option, queued
// blocking commands may wait indefinitely on a dead connection.
if (Command_1.default.checkFlag("BLOCKING_COMMANDS", command.name)) {
const offlineTimeout = this.getConfiguredBlockingTimeout();
if (offlineTimeout !== undefined) {
command.setBlockingTimeout(offlineTimeout);
}
}
}
else {
// @ts-expect-error
if (debug.enabled) {
debug("write command[%s]: %d -> %s(%o)", this._getDescription(), (_b = this.condition) === null || _b === void 0 ? void 0 : _b.select, command.name, command.args);
}
if (stream) {
if ("isPipeline" in stream && stream.isPipeline) {
stream.write(command.toWritable(stream.destination.redis.stream));
}
else {
stream.write(command.toWritable(stream));
}
}
else {
this.stream.write(command.toWritable(this.stream));
}
this.commandQueue.push({
command: command,
stream: stream,
select: this.condition.select,
});
if (blockingTimeout !== undefined) {
command.setBlockingTimeout(blockingTimeout);
}
if (Command_1.default.checkFlag("WILL_DISCONNECT", command.name)) {
this.manuallyClosing = true;
}
if (this.options.socketTimeout !== undefined &&
this.socketTimeoutTimer === undefined) {
this.setSocketTimeout();
}
}
if (command.name === "select" && (0, utils_1.isInt)(command.args[0])) {
const db = parseInt(command.args[0], 10);
if (this.condition.select !== db) {
this.condition.select = db;
this.emit("select", db);
debug("switch to db [%d]", this.condition.select);
}
}
if (!writable || command.isTraced) {
return command.promise;
}
// Trace on the write path only, and only once per command. Commands may
// pass through sendCommand multiple times (offline queue flush,
// prevCommandQueue resend after reconnect). The isTraced flag ensures
// we don't emit duplicate trace events.
command.isTraced = true;
return (0, tracing_1.traceCommand)(() => command.promise, () => this._buildCommandContext(command));
}
getBlockingTimeoutInMs(command) {
var _a;
if (!Command_1.default.checkFlag("BLOCKING_COMMANDS", command.name)) {
return undefined;
}
// Feature is opt-in: only enabled when blockingTimeout is set to a positive number
const configuredTimeout = this.getConfiguredBlockingTimeout();
if (configuredTimeout === undefined) {
return undefined;
}
const timeout = command.extractBlockingTimeout();
if (typeof timeout === "number") {
if (timeout > 0) {
// Finite timeout from command args - add grace period
return (timeout +
((_a = this.options.blockingTimeoutGrace) !== null && _a !== void 0 ? _a : RedisOptions_1.DEFAULT_REDIS_OPTIONS.blockingTimeoutGrace));
}
// Command has timeout=0 (block forever), use blockingTimeout option as safety net
return configuredTimeout;
}
if (timeout === null) {
// No BLOCK option found (e.g., XREAD without BLOCK), use blockingTimeout as safety net
return configuredTimeout;
}
return undefined;
}
getConfiguredBlockingTimeout() {
if (typeof this.options.blockingTimeout === "number" &&
this.options.blockingTimeout > 0) {
return this.options.blockingTimeout;
}
return undefined;
}
setSocketTimeout() {
this.socketTimeoutTimer = setTimeout(() => {
this.stream.destroy(new Error(`Socket timeout. Expecting data, but didn't receive any in ${this.options.socketTimeout}ms.`));
this.socketTimeoutTimer = undefined;
}, this.options.socketTimeout);
// this handler must run after the "data" handler in "DataHandler"
// so that `this.commandQueue.length` will be updated
this.stream.once("data", () => {
clearTimeout(this.socketTimeoutTimer);
this.socketTimeoutTimer = undefined;
if (this.commandQueue.length === 0)
return;
this.setSocketTimeout();
});
}
scanStream(options) {
return this.createScanStream("scan", { options });
}
scanBufferStream(options) {
return this.createScanStream("scanBuffer", { options });
}
sscanStream(key, options) {
return this.createScanStream("sscan", { key, options });
}
sscanBufferStream(key, options) {
return this.createScanStream("sscanBuffer", { key, options });
}
hscanStream(key, options) {
return this.createScanStream("hscan", { key, options });
}
hscanBufferStream(key, options) {
return this.createScanStream("hscanBuffer", { key, options });
}
zscanStream(key, options) {
return this.createScanStream("zscan", { key, options });
}
zscanBufferStream(key, options) {
return this.createScanStream("zscanBuffer", { key, options });
}
/**
* Emit only when there's at least one listener.
*
* @ignore
*/
silentEmit(eventName, arg) {
let error;
if (eventName === "error") {
error = arg;
if (this.status === "end") {
return;
}
if (this.manuallyClosing) {
// ignore connection related errors when manually disconnecting
if (error instanceof Error &&
(error.message === utils_1.CONNECTION_CLOSED_ERROR_MSG ||
// @ts-expect-error
error.syscall === "connect" ||
// @ts-expect-error
error.syscall === "read")) {
return;
}
}
}
if (this.listeners(eventName).length > 0) {
return this.emit.apply(this, arguments);
}
if (error && error instanceof Error) {
console.error("[ioredis] Unhandled error event:", error.stack);
}
return false;
}
/**
* @ignore
*/
recoverFromFatalError(_commandError, err, options) {
this.flushQueue(err, options);
this.silentEmit("error", err);
this.disconnect(true);
}
/**
* @ignore
*/
handleReconnection(err, item) {
var _a;
let needReconnect = false;
if (this.options.reconnectOnError &&
!Command_1.default.checkFlag("IGNORE_RECONNECT_ON_ERROR", item.command.name)) {
needReconnect = this.options.reconnectOnError(err);
}
switch (needReconnect) {
case 1:
case true:
if (this.status !== "reconnecting") {
this.disconnect(true);
}
item.command.reject(err);
break;
case 2:
if (this.status !== "reconnecting") {
this.disconnect(true);
}
if (((_a = this.condition) === null || _a === void 0 ? void 0 : _a.select) !== item.select &&
item.command.name !== "select") {
this.select(item.select);
}
// TODO
// @ts-expect-error
this.sendCommand(item.command);
break;
default:
item.command.reject(err);
}
}
/**
* @ignore
*/
_getServerAddress() {
if ("path" in this.options && this.options.path) {
return { address: this.options.path, port: undefined };
}
return {
address: ("host" in this.options && this.options.host) || "localhost",
port: ("port" in this.options && this.options.port) || 6379,
};
}
_buildCommandContext(command) {
var _a, _b, _c;
const { address, port } = this._getServerAddress();
return {
command: command.name,
args: (0, tracing_1.sanitizeArgs)(command.name, command.args),
database: (_c = (_b = (_a = this.condition) === null || _a === void 0 ? void 0 : _a.select) !== null && _b !== void 0 ? _b : this.options.db) !== null && _c !== void 0 ? _c : 0,
serverAddress: address,
serverPort: port,
};
}
_buildBatchContext(batchSize) {
var _a, _b, _c;
const { address, port } = this._getServerAddress();
return {
batchMode: "MULTI",
batchSize,
database: (_c = (_b = (_a = this.condition) === null || _a === void 0 ? void 0 : _a.select) !== null && _b !== void 0 ? _b : this.options.db) !== null && _c !== void 0 ? _c : 0,
serverAddress: address,
serverPort: port,
};
}
/**
* Get description of the connection. Used for debugging.
*/
_getDescription() {
let description;
if ("path" in this.options && this.options.path) {
description = this.options.path;
}
else if (this.stream &&
this.stream.remoteAddress &&
this.stream.remotePort) {
description = this.stream.remoteAddress + ":" + this.stream.remotePort;
}
else if ("host" in this.options && this.options.host) {
description = this.options.host + ":" + this.options.port;
}
else {
// Unexpected
description = "";
}
if (this.options.connectionName) {
description += ` (${this.options.connectionName})`;
}
return description;
}
resetCommandQueue() {
this.commandQueue = new Deque();
}
resetOfflineQueue() {
this.offlineQueue = new Deque();
}
parseOptions(...args) {
const options = {};
let isTls = false;
for (let i = 0; i < args.length; ++i) {
const arg = args[i];
if (arg === null || typeof arg === "undefined") {
continue;
}
if (typeof arg === "object") {
(0, lodash_1.defaults)(options, arg);
}
else if (typeof arg === "string") {
(0, lodash_1.defaults)(options, (0, utils_1.parseURL)(arg));
if (arg.startsWith("rediss://")) {
isTls = true;
}
}
else if (typeof arg === "number") {
options.port = arg;
}
else {
throw new Error("Invalid argument " + arg);
}
}
if (isTls) {
(0, lodash_1.defaults)(options, { tls: true });
}
(0, lodash_1.defaults)(options, Redis.defaultOptions);
if (typeof options.port === "string") {
options.port = parseInt(options.port, 10);
}
if (typeof options.db === "string") {
options.db = parseInt(options.db, 10);
}
// @ts-expect-error
this.options = (0, utils_1.resolveTLSProfile)(options);
}
/**
* Change instance's status
*/
setStatus(status, arg) {
// @ts-expect-error
if (debug.enabled) {
debug("status[%s]: %s -> %s", this._getDescription(), this.status || "[empty]", status);
}
this.status = status;
process.nextTick(this.emit.bind(this, status, arg));
}
createScanStream(command, { key, options = {} }) {
return new ScanStream_1.default({
objectMode: true,
key: key,
redis: this,
command: command,
...options,
});
}
/**
* Flush offline queue and command queue with error.
*
* @param error The error object to send to the commands
* @param options options
*/
flushQueue(error, options) {
options = (0, lodash_1.defaults)({}, options, {
offlineQueue: true,
commandQueue: true,
});
let item;
if (options.offlineQueue) {
while ((item = this.offlineQueue.shift())) {
item.command.reject(error);
}
}
if (options.commandQueue) {
if (this.commandQueue.length > 0) {
if (this.stream) {
this.stream.removeAllListeners("data");
}
while ((item = this.commandQueue.shift())) {
item.command.reject(error);
}
}
}
}
/**
* Check whether Redis has finished loading the persistent data and is able to
* process commands.
*/
_readyCheck(callback) {
const _this = this;
this.info(function (err, res) {
if (err) {
if (err.message && err.message.includes("NOPERM")) {
console.warn(`Skipping the ready check because INFO command fails: "${err.message}". You can disable ready check with "enableReadyCheck". More: https://github.com/luin/ioredis/wiki/Disable-ready-check.`);
return callback(null, {});
}
return callback(err);
}
if (typeof res !== "string") {
return callback(null, res);
}
const info = {};
const lines = res.split("\r\n");
for (let i = 0; i < lines.length; ++i) {
const [fieldName, ...fieldValueParts] = lines[i].split(":");
const fieldValue = fieldValueParts.join(":");
if (fieldValue) {
info[fieldName] = fieldValue;
}
}
if (!info.loading || info.loading === "0") {
callback(null, info);
}
else {
const loadingEtaMs = (info.loading_eta_seconds || 1) * 1000;
const retryTime = _this.options.maxLoadingRetryTime &&
_this.options.maxLoadingRetryTime < loadingEtaMs
? _this.options.maxLoadingRetryTime
: loadingEtaMs;
debug("Redis server still loading, trying again in " + retryTime + "ms");
setTimeout(function () {
_this._readyCheck(callback);
}, retryTime);
}
}).catch(lodash_1.noop);
}
}
Redis.Cluster = cluster_1.default;
Redis.Command = Command_1.default;
/**
* Default options
*/
Redis.defaultOptions = RedisOptions_1.DEFAULT_REDIS_OPTIONS;
(0, applyMixin_1.default)(Redis, events_1.EventEmitter);
(0, transaction_1.addTransactionSupport)(Redis.prototype);
exports.default = Redis;
landvex/node_modules/ioredis/built/ScanStream.d.ts
Generated Vendored
+23
View File
@@ -0,0 +1,23 @@
/// <reference types="node" />
import { Readable, ReadableOptions } from "stream";
interface Options extends ReadableOptions {
key?: string;
match?: string;
type?: string;
command: string;
redis: any;
count?: string | number;
noValues?: boolean;
}
/**
* Convenient class to convert the process of scanning keys to a readable stream.
*/
export default class ScanStream extends Readable {
private opt;
private _redisCursor;
private _redisDrained;
constructor(opt: Options);
_read(): void;
close(): void;
}
export {};
landvex/node_modules/ioredis/built/ScanStream.js
Generated Vendored
+51
View File
@@ -0,0 +1,51 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const stream_1 = require("stream");
/**
* Convenient class to convert the process of scanning keys to a readable stream.
*/
class ScanStream extends stream_1.Readable {
constructor(opt) {
super(opt);
this.opt = opt;
this._redisCursor = "0";
this._redisDrained = false;
}
_read() {
if (this._redisDrained) {
this.push(null);
return;
}
const args = [this._redisCursor];
if (this.opt.key) {
args.unshift(this.opt.key);
}
if (this.opt.match) {
args.push("MATCH", this.opt.match);
}
if (this.opt.type) {
args.push("TYPE", this.opt.type);
}
if (this.opt.count) {
args.push("COUNT", String(this.opt.count));
}
if (this.opt.noValues) {
args.push("NOVALUES");
}
this.opt.redis[this.opt.command](args, (err, res) => {
if (err) {
this.emit("error", err);
return;
}
this._redisCursor = res[0] instanceof Buffer ? res[0].toString() : res[0];
if (this._redisCursor === "0") {
this._redisDrained = true;
}
this.push(res[1]);
});
}
close() {
this._redisDrained = true;
}
}
exports.default = ScanStream;
landvex/node_modules/ioredis/built/Script.d.ts
Generated Vendored
+11
View File
@@ -0,0 +1,11 @@
import { Callback } from "./types";
export default class Script {
private lua;
private numberOfKeys;
private keyPrefix;
private readOnly;
private sha;
private Command;
constructor(lua: string, numberOfKeys?: number | null, keyPrefix?: string, readOnly?: boolean);
execute(container: any, args: any[], options: any, callback?: Callback): any;
}
landvex/node_modules/ioredis/built/Script.js
Generated Vendored
+62
View File
@@ -0,0 +1,62 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const crypto_1 = require("crypto");
const Command_1 = require("./Command");
const standard_as_callback_1 = require("standard-as-callback");
class Script {
constructor(lua, numberOfKeys = null, keyPrefix = "", readOnly = false) {
this.lua = lua;
this.numberOfKeys = numberOfKeys;
this.keyPrefix = keyPrefix;
this.readOnly = readOnly;
this.sha = (0, crypto_1.createHash)("sha1").update(lua).digest("hex");
const sha = this.sha;
const socketHasScriptLoaded = new WeakSet();
this.Command = class CustomScriptCommand extends Command_1.default {
toWritable(socket) {
const origReject = this.reject;
this.reject = (err) => {
if (err.message.indexOf("NOSCRIPT") !== -1) {
socketHasScriptLoaded.delete(socket);
}
origReject.call(this, err);
};
if (!socketHasScriptLoaded.has(socket)) {
socketHasScriptLoaded.add(socket);
this.name = "eval";
this.args[0] = lua;
}
else if (this.name === "eval") {
this.name = "evalsha";
this.args[0] = sha;
}
return super.toWritable(socket);
}
};
}
execute(container, args, options, callback) {
if (typeof this.numberOfKeys === "number") {
args.unshift(this.numberOfKeys);
}
if (this.keyPrefix) {
options.keyPrefix = this.keyPrefix;
}
if (this.readOnly) {
options.readOnly = true;
}
const evalsha = new this.Command("evalsha", [this.sha, ...args], options);
evalsha.promise = evalsha.promise.catch((err) => {
if (err.message.indexOf("NOSCRIPT") === -1) {
throw err;
}
// Resend the same custom evalsha command that gets transformed
// to an eval in case it's not loaded yet on the connection.
const resend = new this.Command("evalsha", [this.sha, ...args], options);
const client = container.isPipeline ? container.redis : container;
return client.sendCommand(resend);
});
(0, standard_as_callback_1.default)(evalsha.promise, callback);
return container.sendCommand(evalsha);
}
}
exports.default = Script;
landvex/node_modules/ioredis/built/SubscriptionSet.d.ts
Generated Vendored
+14
View File
@@ -0,0 +1,14 @@
import { CommandNameFlags } from "./Command";
declare type AddSet = CommandNameFlags["ENTER_SUBSCRIBER_MODE"][number];
declare type DelSet = CommandNameFlags["EXIT_SUBSCRIBER_MODE"][number];
/**
* Tiny class to simplify dealing with subscription set
*/
export default class SubscriptionSet {
private set;
add(set: AddSet, channel: string): void;
del(set: DelSet, channel: string): void;
channels(set: AddSet | DelSet): string[];
isEmpty(): boolean;
}
export {};
landvex/node_modules/ioredis/built/SubscriptionSet.js
Generated Vendored
+41
View File
@@ -0,0 +1,41 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
/**
* Tiny class to simplify dealing with subscription set
*/
class SubscriptionSet {
constructor() {
this.set = {
subscribe: {},
psubscribe: {},
ssubscribe: {},
};
}
add(set, channel) {
this.set[mapSet(set)][channel] = true;
}
del(set, channel) {
delete this.set[mapSet(set)][channel];
}
channels(set) {
return Object.keys(this.set[mapSet(set)]);
}
isEmpty() {
return (this.channels("subscribe").length === 0 &&
this.channels("psubscribe").length === 0 &&
this.channels("ssubscribe").length === 0);
}
}
exports.default = SubscriptionSet;
function mapSet(set) {
if (set === "unsubscribe") {
return "subscribe";
}
if (set === "punsubscribe") {
return "psubscribe";
}
if (set === "sunsubscribe") {
return "ssubscribe";
}
return set;
}
landvex/node_modules/ioredis/built/autoPipelining.d.ts
Generated Vendored
+8
View File
@@ -0,0 +1,8 @@
/// <reference types="node" />
import { ArgumentType } from "./Command";
export declare const kExec: unique symbol;
export declare const kCallbacks: unique symbol;
export declare const notAllowedAutoPipelineCommands: string[];
export declare function shouldUseAutoPipelining(client: any, functionName: string, commandName: string): boolean;
export declare function getFirstValueInFlattenedArray(args: ArgumentType[]): string | Buffer | number | null | undefined;
export declare function executeWithAutoPipelining(client: any, functionName: string, commandName: string, args: ArgumentType[], callback: any): Promise<unknown>;
landvex/node_modules/ioredis/built/autoPipelining.js
Generated Vendored
+177
View File
@@ -0,0 +1,177 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.executeWithAutoPipelining = exports.getFirstValueInFlattenedArray = exports.shouldUseAutoPipelining = exports.notAllowedAutoPipelineCommands = exports.kCallbacks = exports.kExec = void 0;
const lodash_1 = require("./utils/lodash");
const calculateSlot = require("cluster-key-slot");
const standard_as_callback_1 = require("standard-as-callback");
const commands_1 = require("@ioredis/commands");
exports.kExec = Symbol("exec");
exports.kCallbacks = Symbol("callbacks");
exports.notAllowedAutoPipelineCommands = [
"auth",
"info",
"script",
"quit",
"cluster",
"pipeline",
"multi",
"subscribe",
"psubscribe",
"unsubscribe",
"unpsubscribe",
"select",
"client",
];
function executeAutoPipeline(client, slotKey) {
/*
If a pipeline is already executing, keep queueing up commands
since ioredis won't serve two pipelines at the same time
*/
if (client._runningAutoPipelines.has(slotKey)) {
return;
}
if (!client._autoPipelines.has(slotKey)) {
/*
Rare edge case. Somehow, something has deleted this running autopipeline in an immediate
call to executeAutoPipeline.
Maybe the callback in the pipeline.exec is sometimes called in the same tick,
e.g. if redis is disconnected?
*/
return;
}
client._runningAutoPipelines.add(slotKey);
// Get the pipeline and immediately delete it so that new commands are queued on a new pipeline
const pipeline = client._autoPipelines.get(slotKey);
client._autoPipelines.delete(slotKey);
const callbacks = pipeline[exports.kCallbacks];
// Stop keeping a reference to callbacks immediately after the callbacks stop being used.
// This allows the GC to reclaim objects referenced by callbacks, especially with 16384 slots
// in Redis.Cluster
pipeline[exports.kCallbacks] = null;
// Perform the call
pipeline.exec(function (err, results) {
client._runningAutoPipelines.delete(slotKey);
/*
Invoke all callback in nextTick so the stack is cleared
and callbacks can throw errors without affecting other callbacks.
*/
if (err) {
for (let i = 0; i < callbacks.length; i++) {
process.nextTick(callbacks[i], err);
}
}
else {
for (let i = 0; i < callbacks.length; i++) {
process.nextTick(callbacks[i], ...results[i]);
}
}
// If there is another pipeline on the same node, immediately execute it without waiting for nextTick
if (client._autoPipelines.has(slotKey)) {
executeAutoPipeline(client, slotKey);
}
});
}
function shouldUseAutoPipelining(client, functionName, commandName) {
return (functionName &&
client.options.enableAutoPipelining &&
!client.isPipeline &&
!exports.notAllowedAutoPipelineCommands.includes(commandName) &&
!client.options.autoPipeliningIgnoredCommands.includes(commandName));
}
exports.shouldUseAutoPipelining = shouldUseAutoPipelining;
function getFirstValueInFlattenedArray(args) {
for (let i = 0; i < args.length; i++) {
const arg = args[i];
if (typeof arg === "string") {
return arg;
}
else if (Array.isArray(arg) || (0, lodash_1.isArguments)(arg)) {
if (arg.length === 0) {
continue;
}
return arg[0];
}
const flattened = [arg].flat();
if (flattened.length > 0) {
return flattened[0];
}
}
return undefined;
}
exports.getFirstValueInFlattenedArray = getFirstValueInFlattenedArray;
function getFirstKeyForCommand(commandName, args) {
if ((0, commands_1.exists)(commandName, { caseInsensitive: true })) {
const flattenedArgs = args.flat();
const keyIndexes = (0, commands_1.getKeyIndexes)(commandName, flattenedArgs, {
nameCaseInsensitive: true,
});
if (keyIndexes.length) {
return flattenedArgs[keyIndexes[0]];
}
}
return getFirstValueInFlattenedArray(args);
}
function executeWithAutoPipelining(client, functionName, commandName, args, callback) {
// On cluster mode let's wait for slots to be available
if (client.isCluster && !client.slots.length) {
if (client.status === "wait")
client.connect().catch(lodash_1.noop);
return (0, standard_as_callback_1.default)(new Promise(function (resolve, reject) {
client.delayUntilReady((err) => {
if (err) {
reject(err);
return;
}
executeWithAutoPipelining(client, functionName, commandName, args, null).then(resolve, reject);
});
}), callback);
}
// If we have slot information, we can improve routing by grouping slots served by the same subset of nodes
const prefix = client.options.keyPrefix || "";
let slotKey = client.isCluster
? client.slots[calculateSlot(`${prefix}${getFirstKeyForCommand(commandName, args)}`)].join(",")
: "main";
// When scaleReads is enabled, separate read and write commands into different pipelines
// so they can be routed to replicas and masters respectively
if (client.isCluster && client.options.scaleReads !== "master") {
const isReadOnly = (0, commands_1.exists)(commandName) && (0, commands_1.hasFlag)(commandName, "readonly");
slotKey += isReadOnly ? ":read" : ":write";
}
if (!client._autoPipelines.has(slotKey)) {
const pipeline = client.pipeline();
pipeline[exports.kExec] = false;
pipeline[exports.kCallbacks] = [];
client._autoPipelines.set(slotKey, pipeline);
}
const pipeline = client._autoPipelines.get(slotKey);
/*
Mark the pipeline as scheduled.
The symbol will make sure that the pipeline is only scheduled once per tick.
New commands are appended to an already scheduled pipeline.
*/
if (!pipeline[exports.kExec]) {
pipeline[exports.kExec] = true;
/*
Deferring with setImmediate so we have a chance to capture multiple
commands that can be scheduled by I/O events already in the event loop queue.
*/
setImmediate(executeAutoPipeline, client, slotKey);
}
// Create the promise which will execute the command in the pipeline.
const autoPipelinePromise = new Promise(function (resolve, reject) {
pipeline[exports.kCallbacks].push(function (err, value) {
if (err) {
reject(err);
return;
}
resolve(value);
});
if (functionName === "call") {
args.unshift(commandName);
}
pipeline[functionName](...args);
});
return (0, standard_as_callback_1.default)(autoPipelinePromise, callback);
}
exports.executeWithAutoPipelining = executeWithAutoPipelining;
landvex/node_modules/ioredis/built/cluster/ClusterOptions.d.ts
Generated Vendored
+189
View File
@@ -0,0 +1,189 @@
/// <reference types="node" />
import { SrvRecord } from "dns";
import { RedisOptions, RetryStrategy } from "../redis/RedisOptions";
import { CommanderOptions } from "../utils/Commander";
import { NodeRole } from "./util";
export declare type DNSResolveSrvFunction = (hostname: string, callback: (err: NodeJS.ErrnoException | null | undefined, records?: SrvRecord[]) => void) => void;
export declare type DNSLookupFunction = (hostname: string, callback: (err: NodeJS.ErrnoException | null | undefined, address: string, family?: number) => void) => void;
export declare type NatMapFunction = (key: string) => {
host: string;
port: number;
} | null;
export declare type NatMap = {
[key: string]: {
host: string;
port: number;
};
} | NatMapFunction;
export declare type ClusterNodeRetryStrategy = RetryStrategy;
/**
* Options for Cluster constructor
*/
export interface ClusterOptions extends CommanderOptions {
/**
* See "Quick Start" section.
*
* @default (times) => Math.min(100 + times * 2, 2000)
*/
clusterRetryStrategy?: ((times: number, reason?: Error) => number | void | null) | null | undefined;
/**
* See Redis class.
*
* @default true
*/
enableOfflineQueue?: boolean | undefined;
/**
* When enabled, ioredis only emits "ready" event when `CLUSTER INFO`
* command reporting the cluster is ready for handling commands.
*
* @default true
*/
enableReadyCheck?: boolean | undefined;
/**
* Scale reads to the node with the specified role.
*
* @default "master"
*/
scaleReads?: NodeRole | Function | undefined;
/**
* When a MOVED or ASK error is received, client will redirect the
* command to another node.
* This option limits the max redirections allowed to send a command.
*
* @default 16
*/
maxRedirections?: number | undefined;
/**
* When an error is received when sending a command (e.g.
* "Connection is closed." when the target Redis node is down), client will retry
* if `retryDelayOnFailover` is valid delay time (in ms).
*
* @default 100
*/
retryDelayOnFailover?: number | undefined;
/**
* When a CLUSTERDOWN error is received, client will retry
* if `retryDelayOnClusterDown` is valid delay time (in ms).
*
* @default 100
*/
retryDelayOnClusterDown?: number | undefined;
/**
* When a TRYAGAIN error is received, client will retry
* if `retryDelayOnTryAgain` is valid delay time (in ms).
*
* @default 100
*/
retryDelayOnTryAgain?: number | undefined;
/**
* By default, this value is 0, which means when a `MOVED` error is received,
* the client will resend the command instantly to the node returned together with
* the `MOVED` error. However, sometimes it takes time for a cluster to become
* state stabilized after a failover, so adding a delay before resending can
* prevent a ping pong effect.
*
* @default 0
*/
retryDelayOnMoved?: number | undefined;
/**
* The milliseconds before a timeout occurs while refreshing
* slots from the cluster.
*
* @default 1000
*/
slotsRefreshTimeout?: number | undefined;
/**
* The milliseconds between every automatic slots refresh.
*
* @default 5000
*/
slotsRefreshInterval?: number | undefined;
/**
* Use sharded subscribers instead of a single subscriber.
*
* If sharded subscribers are used, then one additional subscriber connection per master node
* is established. If you don't plan to use SPUBLISH/SSUBSCRIBE, then this should be disabled.
*
* @default false
*/
shardedSubscribers?: boolean | undefined;
/**
* When a cluster node connection is closed, this function will be called
* to determine the retry delay (in ms). Returning `null` or a non-number
* disables reconnection for that node.
*
* By default this is `null`, meaning cluster nodes will NOT automatically
* reconnect — the cluster relies on `MOVED` errors to refresh topology.
* Set this to enable reconnection, e.g. for replica nodes that restart
* without any slot changes.
*
* @example
* clusterNodeRetryStrategy: (times) => Math.min(times * 100, 3000)
*
* @default null
*/
clusterNodeRetryStrategy?: ClusterNodeRetryStrategy;
/**
* Passed to the constructor of `Redis`
*
* @default null
*/
redisOptions?: Omit<RedisOptions, "port" | "host" | "path" | "sentinels" | "retryStrategy" | "enableOfflineQueue" | "readOnly"> | undefined;
/**
* By default, When a new Cluster instance is created,
* it will connect to the Redis cluster automatically.
* If you want to keep the instance disconnected until the first command is called,
* set this option to `true`.
*
* @default false
*/
lazyConnect?: boolean | undefined;
/**
* Discover nodes using SRV records
*
* @default false
*/
useSRVRecords?: boolean | undefined;
/**
* SRV records will be resolved via this function.
*
* You may provide a custom `resolveSrv` function when you want to customize
* the cache behavior of the default function.
*
* @default require('dns').resolveSrv
*/
resolveSrv?: DNSResolveSrvFunction | undefined;
/**
* Hostnames will be resolved to IP addresses via this function.
* This is needed when the addresses of startup nodes are hostnames instead
* of IPs.
*
* You may provide a custom `lookup` function when you want to customize
* the cache behavior of the default function.
*
* @default require('dns').lookup
*/
dnsLookup?: DNSLookupFunction | undefined;
natMap?: NatMap | undefined;
/**
* See Redis class.
*
* @default false
*/
enableAutoPipelining?: boolean | undefined;
/**
* See Redis class.
*
* @default []
*/
autoPipeliningIgnoredCommands?: string[] | undefined;
/**
* Custom LUA commands
*/
scripts?: Record<string, {
lua: string;
numberOfKeys?: number;
readOnly?: boolean;
}> | undefined;
}
export declare const DEFAULT_CLUSTER_OPTIONS: ClusterOptions;
landvex/node_modules/ioredis/built/cluster/ClusterOptions.js
Generated Vendored
+23
View File
@@ -0,0 +1,23 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.DEFAULT_CLUSTER_OPTIONS = void 0;
const dns_1 = require("dns");
exports.DEFAULT_CLUSTER_OPTIONS = {
clusterRetryStrategy: (times) => Math.min(100 + times * 2, 2000),
clusterNodeRetryStrategy: null,
enableOfflineQueue: true,
enableReadyCheck: true,
scaleReads: "master",
maxRedirections: 16,
retryDelayOnMoved: 0,
retryDelayOnFailover: 100,
retryDelayOnClusterDown: 100,
retryDelayOnTryAgain: 100,
slotsRefreshTimeout: 1000,
useSRVRecords: false,
resolveSrv: dns_1.resolveSrv,
dnsLookup: dns_1.lookup,
enableAutoPipelining: false,
autoPipeliningIgnoredCommands: [],
shardedSubscribers: false,
};
landvex/node_modules/ioredis/built/cluster/ClusterSubscriber.d.ts
Generated Vendored
+29
View File
@@ -0,0 +1,29 @@
/// <reference types="node" />
import { EventEmitter } from "events";
import ConnectionPool from "./ConnectionPool";
export default class ClusterSubscriber {
private connectionPool;
private emitter;
private isSharded;
private started;
private subscriber;
private lastActiveSubscriber;
private slotRange;
constructor(connectionPool: ConnectionPool, emitter: EventEmitter, isSharded?: boolean);
getInstance(): any;
/**
* Associate this subscriber to a specific slot range.
*
* Returns the range or an empty array if the slot range couldn't be associated.
*
* BTW: This is more for debugging and testing purposes.
*
* @param range
*/
associateSlotRange(range: number[]): number[];
start(): void;
stop(): void;
isStarted(): boolean;
private onSubscriberEnd;
private selectSubscriber;
}
landvex/node_modules/ioredis/built/cluster/ClusterSubscriber.js
Generated Vendored
+223
View File
@@ -0,0 +1,223 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const util_1 = require("./util");
const utils_1 = require("../utils");
const Redis_1 = require("../Redis");
const debug = (0, utils_1.Debug)("cluster:subscriber");
class ClusterSubscriber {
constructor(connectionPool, emitter, isSharded = false) {
this.connectionPool = connectionPool;
this.emitter = emitter;
this.isSharded = isSharded;
this.started = false;
//There is only one connection for the entire pool
this.subscriber = null;
//The slot range for which this subscriber is responsible
this.slotRange = [];
this.onSubscriberEnd = () => {
if (!this.started) {
debug("subscriber has disconnected, but ClusterSubscriber is not started, so not reconnecting.");
return;
}
// If the subscriber closes whilst it's still the active connection,
// we might as well try to connecting to a new node if possible to
// minimise the number of missed publishes.
debug("subscriber has disconnected, selecting a new one...");
this.selectSubscriber();
};
// If the current node we're using as the subscriber disappears
// from the node pool for some reason, we will select a new one
// to connect to.
// Note that this event is only triggered if the connection to
// the node has been used; cluster subscriptions are setup with
// lazyConnect = true. It's possible for the subscriber node to
// disappear without this method being called!
// See https://github.com/luin/ioredis/pull/1589
this.connectionPool.on("-node", (_, key) => {
if (!this.started || !this.subscriber) {
return;
}
if ((0, util_1.getNodeKey)(this.subscriber.options) === key) {
debug("subscriber has left, selecting a new one...");
this.selectSubscriber();
}
});
this.connectionPool.on("+node", () => {
if (!this.started || this.subscriber) {
return;
}
debug("a new node is discovered and there is no subscriber, selecting a new one...");
this.selectSubscriber();
});
}
getInstance() {
return this.subscriber;
}
/**
* Associate this subscriber to a specific slot range.
*
* Returns the range or an empty array if the slot range couldn't be associated.
*
* BTW: This is more for debugging and testing purposes.
*
* @param range
*/
associateSlotRange(range) {
if (this.isSharded) {
this.slotRange = range;
}
return this.slotRange;
}
start() {
this.started = true;
this.selectSubscriber();
debug("started");
}
stop() {
this.started = false;
if (this.subscriber) {
this.subscriber.disconnect();
this.subscriber = null;
}
}
isStarted() {
return this.started;
}
selectSubscriber() {
const lastActiveSubscriber = this.lastActiveSubscriber;
// Disconnect the previous subscriber even if there
// will not be a new one.
if (lastActiveSubscriber) {
lastActiveSubscriber.off("end", this.onSubscriberEnd);
lastActiveSubscriber.disconnect();
}
if (this.subscriber) {
this.subscriber.off("end", this.onSubscriberEnd);
this.subscriber.disconnect();
}
const sampleNode = (0, utils_1.sample)(this.connectionPool.getNodes());
if (!sampleNode) {
debug("selecting subscriber failed since there is no node discovered in the cluster yet");
this.subscriber = null;
return;
}
const { options } = sampleNode;
debug("selected a subscriber %s:%s", options.host, options.port);
/*
* Create a specialized Redis connection for the subscription.
* Note that auto reconnection is enabled here.
*
* `enableReadyCheck` is also enabled because although subscription is allowed
* while redis is loading data from the disk, we can check if the password
* provided for the subscriber is correct, and if not, the current subscriber
* will be disconnected and a new subscriber will be selected.
*/
let connectionPrefix = "subscriber";
if (this.isSharded)
connectionPrefix = "ssubscriber";
this.subscriber = new Redis_1.default({
port: options.port,
host: options.host,
username: options.username,
password: options.password,
enableReadyCheck: true,
connectionName: (0, util_1.getConnectionName)(connectionPrefix, options.connectionName),
lazyConnect: true,
tls: options.tls,
// Don't try to reconnect the subscriber connection. If the connection fails
// we will get an end event (handled below), at which point we'll pick a new
// node from the pool and try to connect to that as the subscriber connection.
retryStrategy: null,
});
// Ignore the errors since they're handled in the connection pool.
this.subscriber.on("error", utils_1.noop);
this.subscriber.on("moved", () => {
this.emitter.emit("forceRefresh");
});
// The node we lost connection to may not come back up in a
// reasonable amount of time (e.g. a slave that's taken down
// for maintainence), we could potentially miss many published
// messages so we should reconnect as quickly as possible, to
// a different node if needed.
this.subscriber.once("end", this.onSubscriberEnd);
// Re-subscribe previous channels
const previousChannels = { subscribe: [], psubscribe: [], ssubscribe: [] };
if (lastActiveSubscriber) {
const condition = lastActiveSubscriber.condition || lastActiveSubscriber.prevCondition;
if (condition && condition.subscriber) {
previousChannels.subscribe = condition.subscriber.channels("subscribe");
previousChannels.psubscribe =
condition.subscriber.channels("psubscribe");
previousChannels.ssubscribe =
condition.subscriber.channels("ssubscribe");
}
}
if (previousChannels.subscribe.length ||
previousChannels.psubscribe.length ||
previousChannels.ssubscribe.length) {
let pending = 0;
for (const type of ["subscribe", "psubscribe", "ssubscribe"]) {
const channels = previousChannels[type];
if (channels.length == 0) {
continue;
}
debug("%s %d channels", type, channels.length);
if (type === "ssubscribe") {
for (const channel of channels) {
pending += 1;
this.subscriber[type](channel)
.then(() => {
if (!--pending) {
this.lastActiveSubscriber = this.subscriber;
}
})
.catch(() => {
// TODO: should probably disconnect the subscriber and try again.
debug("failed to ssubscribe to channel: %s", channel);
});
}
}
else {
pending += 1;
this.subscriber[type](channels)
.then(() => {
if (!--pending) {
this.lastActiveSubscriber = this.subscriber;
}
})
.catch(() => {
// TODO: should probably disconnect the subscriber and try again.
debug("failed to %s %d channels", type, channels.length);
});
}
}
}
else {
this.lastActiveSubscriber = this.subscriber;
}
for (const event of [
"message",
"messageBuffer",
]) {
this.subscriber.on(event, (arg1, arg2) => {
this.emitter.emit(event, arg1, arg2);
});
}
for (const event of ["pmessage", "pmessageBuffer"]) {
this.subscriber.on(event, (arg1, arg2, arg3) => {
this.emitter.emit(event, arg1, arg2, arg3);
});
}
if (this.isSharded == true) {
for (const event of [
"smessage",
"smessageBuffer",
]) {
this.subscriber.on(event, (arg1, arg2) => {
this.emitter.emit(event, arg1, arg2);
});
}
}
}
}
exports.default = ClusterSubscriber;
landvex/node_modules/ioredis/built/cluster/ClusterSubscriberGroup.d.ts
Generated Vendored
+108
View File
@@ -0,0 +1,108 @@
/// <reference types="node" />
import * as EventEmitter from "events";
import ShardedSubscriber from "./ShardedSubscriber";
import { ClusterOptions } from "./ClusterOptions";
/**
* Redis distinguishes between "normal" and sharded PubSub. When using the normal PubSub feature,
* exactly one subscriber exists per cluster instance because the Redis cluster bus forwards
* messages between shards. Sharded PubSub removes this limitation by making each shard
* responsible for its own messages.
*
* This class coordinates one ShardedSubscriber per master node in the cluster, providing
* sharded PubSub support while keeping the public API backward compatible.
*/
export default class ClusterSubscriberGroup {
private readonly subscriberGroupEmitter;
private readonly options;
private shardedSubscribers;
private clusterSlots;
private subscriberToSlotsIndex;
private channels;
private failedAttemptsByNode;
private isResetting;
private pendingReset;
private static readonly MAX_RETRY_ATTEMPTS;
private static readonly MAX_BACKOFF_MS;
private static readonly BASE_BACKOFF_MS;
/**
* Register callbacks
*
* @param cluster
*/
constructor(subscriberGroupEmitter: EventEmitter, options: ClusterOptions);
/**
* Get the responsible subscriber.
*
* @param slot
*/
getResponsibleSubscriber(slot: number): ShardedSubscriber | undefined;
/**
* Adds a channel for which this subscriber group is responsible
*
* @param channels
*/
addChannels(channels: (string | Buffer)[]): number;
/**
* Removes channels for which the subscriber group is responsible by optionally unsubscribing
* @param channels
*/
removeChannels(channels: (string | Buffer)[]): number;
/**
* Disconnect all subscribers and clear some of the internal state.
*/
stop(): void;
/**
* Start all not yet started subscribers
*/
start(): Promise<any[]>;
/**
* Resets the subscriber group by disconnecting all subscribers that are no longer needed and connecting new ones.
*/
reset(clusterSlots: string[][], clusterNodes: any[]): Promise<void>;
/**
* Refreshes the subscriber-related slot ranges
*
* Returns false if no refresh was needed
*
* @param targetSlots
*/
private _refreshSlots;
/**
* Resubscribes to the previous channels
*
* @private
*/
private _resubscribe;
/**
* Deep equality of the cluster slots objects
*
* @param other
* @private
*/
private _slotsAreEqual;
/**
* Checks if any subscribers are in an unhealthy state.
*
* A subscriber is considered unhealthy if:
* - It exists but is not started (failed/disconnected)
* - It's missing entirely for a node that should have one
*
* @returns true if any subscribers need to be recreated
*/
private hasUnhealthySubscribers;
/**
* Handles failed subscriber connections by emitting an event to refresh the slots cache
* after a backoff period.
*
* @param error
* @param nodeKey
*/
private handleSubscriberConnectFailed;
/**
* Handles successful subscriber connections by resetting the failed attempts counter.
*
* @param nodeKey
*/
private handleSubscriberConnectSucceeded;
private shouldStartSubscriber;
}
landvex/node_modules/ioredis/built/cluster/ClusterSubscriberGroup.js
Generated Vendored
+373
View File
@@ -0,0 +1,373 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const utils_1 = require("../utils");
const util_1 = require("./util");
const calculateSlot = require("cluster-key-slot");
const ShardedSubscriber_1 = require("./ShardedSubscriber");
const debug = (0, utils_1.Debug)("cluster:subscriberGroup");
/**
* Redis distinguishes between "normal" and sharded PubSub. When using the normal PubSub feature,
* exactly one subscriber exists per cluster instance because the Redis cluster bus forwards
* messages between shards. Sharded PubSub removes this limitation by making each shard
* responsible for its own messages.
*
* This class coordinates one ShardedSubscriber per master node in the cluster, providing
* sharded PubSub support while keeping the public API backward compatible.
*/
class ClusterSubscriberGroup {
/**
* Register callbacks
*
* @param cluster
*/
constructor(subscriberGroupEmitter, options) {
this.subscriberGroupEmitter = subscriberGroupEmitter;
this.options = options;
this.shardedSubscribers = new Map();
this.clusterSlots = [];
// Simple [min, max] slot ranges aren't enough because you can migrate single slots
this.subscriberToSlotsIndex = new Map();
this.channels = new Map();
this.failedAttemptsByNode = new Map();
// Only latest pending reset kept; throttled by refreshSlotsCache's isRefreshing + backoff delay
this.isResetting = false;
this.pendingReset = null;
/**
* Handles failed subscriber connections by emitting an event to refresh the slots cache
* after a backoff period.
*
* @param error
* @param nodeKey
*/
this.handleSubscriberConnectFailed = (error, nodeKey) => {
const currentAttempts = this.failedAttemptsByNode.get(nodeKey) || 0;
const failedAttempts = currentAttempts + 1;
this.failedAttemptsByNode.set(nodeKey, failedAttempts);
const attempts = Math.min(failedAttempts, ClusterSubscriberGroup.MAX_RETRY_ATTEMPTS);
const backoff = Math.min(ClusterSubscriberGroup.BASE_BACKOFF_MS * 2 ** attempts, ClusterSubscriberGroup.MAX_BACKOFF_MS);
const jitter = Math.floor((Math.random() - 0.5) * (backoff * 0.5));
const delay = Math.max(0, backoff + jitter);
debug("Failed to connect subscriber for %s. Refreshing slots in %dms", nodeKey, delay);
this.subscriberGroupEmitter.emit("subscriberConnectFailed", {
delay,
error,
});
};
/**
* Handles successful subscriber connections by resetting the failed attempts counter.
*
* @param nodeKey
*/
this.handleSubscriberConnectSucceeded = (nodeKey) => {
this.failedAttemptsByNode.delete(nodeKey);
};
}
/**
* Get the responsible subscriber.
*
* @param slot
*/
getResponsibleSubscriber(slot) {
const nodeKey = this.clusterSlots[slot][0];
const sub = this.shardedSubscribers.get(nodeKey);
if (sub && sub.subscriberStatus === "idle") {
sub
.start()
.then(() => {
this.handleSubscriberConnectSucceeded(sub.getNodeKey());
})
.catch((err) => {
this.handleSubscriberConnectFailed(err, sub.getNodeKey());
});
}
return sub;
}
/**
* Adds a channel for which this subscriber group is responsible
*
* @param channels
*/
addChannels(channels) {
const slot = calculateSlot(channels[0]);
// Check if the all channels belong to the same slot and otherwise reject the operation
for (const c of channels) {
if (calculateSlot(c) !== slot) {
return -1;
}
}
const currChannels = this.channels.get(slot);
if (!currChannels) {
this.channels.set(slot, channels);
}
else {
this.channels.set(slot, currChannels.concat(channels));
}
return Array.from(this.channels.values()).reduce((sum, array) => sum + array.length, 0);
}
/**
* Removes channels for which the subscriber group is responsible by optionally unsubscribing
* @param channels
*/
removeChannels(channels) {
const slot = calculateSlot(channels[0]);
// Check if the all channels belong to the same slot and otherwise reject the operation
for (const c of channels) {
if (calculateSlot(c) !== slot) {
return -1;
}
}
const slotChannels = this.channels.get(slot);
if (slotChannels) {
const updatedChannels = slotChannels.filter((c) => !channels.includes(c));
this.channels.set(slot, updatedChannels);
}
return Array.from(this.channels.values()).reduce((sum, array) => sum + array.length, 0);
}
/**
* Disconnect all subscribers and clear some of the internal state.
*/
stop() {
for (const s of this.shardedSubscribers.values()) {
s.stop();
}
// Clear subscriber instances and pending operations.
// Channels are preserved for resubscription on reconnect.
this.pendingReset = null;
this.shardedSubscribers.clear();
this.subscriberToSlotsIndex.clear();
}
/**
* Start all not yet started subscribers
*/
start() {
const startPromises = [];
for (const s of this.shardedSubscribers.values()) {
if (this.shouldStartSubscriber(s)) {
startPromises.push(s
.start()
.then(() => {
this.handleSubscriberConnectSucceeded(s.getNodeKey());
})
.catch((err) => {
this.handleSubscriberConnectFailed(err, s.getNodeKey());
}));
this.subscriberGroupEmitter.emit("+subscriber");
}
}
return Promise.all(startPromises);
}
/**
* Resets the subscriber group by disconnecting all subscribers that are no longer needed and connecting new ones.
*/
async reset(clusterSlots, clusterNodes) {
if (this.isResetting) {
this.pendingReset = { slots: clusterSlots, nodes: clusterNodes };
return;
}
this.isResetting = true;
try {
const hasTopologyChanged = this._refreshSlots(clusterSlots);
const hasFailedSubscribers = this.hasUnhealthySubscribers();
if (!hasTopologyChanged && !hasFailedSubscribers) {
debug("No topology change detected or failed subscribers. Skipping reset.");
return;
}
// For each of the sharded subscribers
for (const [nodeKey, shardedSubscriber] of this.shardedSubscribers) {
if (
// If the subscriber is still responsible for a slot range and is healthy then keep it
this.subscriberToSlotsIndex.has(nodeKey) &&
shardedSubscriber.isHealthy()) {
debug("Skipping deleting subscriber for %s", nodeKey);
continue;
}
debug("Removing subscriber for %s", nodeKey);
// Otherwise stop the subscriber and remove it
shardedSubscriber.stop();
this.shardedSubscribers.delete(nodeKey);
this.subscriberGroupEmitter.emit("-subscriber");
}
const startPromises = [];
// For each node in slots cache
for (const [nodeKey, _] of this.subscriberToSlotsIndex) {
const existingSubscriber = this.shardedSubscribers.get(nodeKey);
// If we already have a subscriber for this node, only ensure it is healthy
// when it now owns slots with active channel subscriptions.
if (existingSubscriber && existingSubscriber.isHealthy()) {
debug("Skipping creating new subscriber for %s", nodeKey);
if (!existingSubscriber.isStarted() &&
this.shouldStartSubscriber(existingSubscriber)) {
startPromises.push(existingSubscriber
.start()
.then(() => {
this.handleSubscriberConnectSucceeded(nodeKey);
})
.catch((error) => {
this.handleSubscriberConnectFailed(error, nodeKey);
}));
}
continue;
}
// If we have an existing subscriber but it is not healthy, stop it
if (existingSubscriber && !existingSubscriber.isHealthy()) {
debug("Replacing subscriber for %s", nodeKey);
existingSubscriber.stop();
this.shardedSubscribers.delete(nodeKey);
this.subscriberGroupEmitter.emit("-subscriber");
}
debug("Creating new subscriber for %s", nodeKey);
// Otherwise create a new subscriber
const redis = clusterNodes.find((node) => {
return (0, util_1.getNodeKey)(node.options) === nodeKey;
});
if (!redis) {
debug("Failed to find node for key %s", nodeKey);
continue;
}
const sub = new ShardedSubscriber_1.default(this.subscriberGroupEmitter, redis.options, this.options.redisOptions);
this.shardedSubscribers.set(nodeKey, sub);
if (this.shouldStartSubscriber(sub)) {
startPromises.push(sub
.start()
.then(() => {
this.handleSubscriberConnectSucceeded(nodeKey);
})
.catch((error) => {
this.handleSubscriberConnectFailed(error, nodeKey);
}));
}
this.subscriberGroupEmitter.emit("+subscriber");
}
// It's vital to await the start promises before resubscribing
// Otherwise we might try to resubscribe to a subscriber that is not yet connected
// This can cause a race condition
await Promise.all(startPromises);
this._resubscribe();
this.subscriberGroupEmitter.emit("subscribersReady");
}
finally {
this.isResetting = false;
if (this.pendingReset) {
const { slots, nodes } = this.pendingReset;
this.pendingReset = null;
await this.reset(slots, nodes);
}
}
}
/**
* Refreshes the subscriber-related slot ranges
*
* Returns false if no refresh was needed
*
* @param targetSlots
*/
_refreshSlots(targetSlots) {
//If there was an actual change, then reassign the slot ranges
// Also rebuild if subscriberToSlotsIndex is empty (e.g., after stop() was called)
if (this._slotsAreEqual(targetSlots) && this.subscriberToSlotsIndex.size > 0) {
debug("Nothing to refresh because the new cluster map is equal to the previous one.");
return false;
}
debug("Refreshing the slots of the subscriber group.");
//Rebuild the slots index
this.subscriberToSlotsIndex = new Map();
for (let slot = 0; slot < targetSlots.length; slot++) {
const node = targetSlots[slot][0];
if (!this.subscriberToSlotsIndex.has(node)) {
this.subscriberToSlotsIndex.set(node, []);
}
this.subscriberToSlotsIndex.get(node).push(Number(slot));
}
//Update the cached slots map
this.clusterSlots = JSON.parse(JSON.stringify(targetSlots));
return true;
}
/**
* Resubscribes to the previous channels
*
* @private
*/
_resubscribe() {
if (this.shardedSubscribers) {
this.shardedSubscribers.forEach((s, nodeKey) => {
const subscriberSlots = this.subscriberToSlotsIndex.get(nodeKey);
if (subscriberSlots) {
//Resubscribe on the underlying connection
subscriberSlots.forEach((ss) => {
//Might return null if being disconnected
const redis = s.getInstance();
const channels = this.channels.get(ss);
if (channels && channels.length > 0) {
if (!redis || redis.status === "end") {
return;
}
if (redis.status === "ready") {
redis.ssubscribe(...channels).catch((err) => {
// TODO: Should we emit an error event here?
debug("Failed to ssubscribe on node %s: %s", nodeKey, err);
});
}
else {
redis.once("ready", () => {
redis.ssubscribe(...channels).catch((err) => {
// TODO: Should we emit an error event here?
debug("Failed to ssubscribe on node %s: %s", nodeKey, err);
});
});
}
}
});
}
});
}
}
/**
* Deep equality of the cluster slots objects
*
* @param other
* @private
*/
_slotsAreEqual(other) {
if (this.clusterSlots === undefined) {
return false;
}
else {
return JSON.stringify(this.clusterSlots) === JSON.stringify(other);
}
}
/**
* Checks if any subscribers are in an unhealthy state.
*
* A subscriber is considered unhealthy if:
* - It exists but is not started (failed/disconnected)
* - It's missing entirely for a node that should have one
*
* @returns true if any subscribers need to be recreated
*/
hasUnhealthySubscribers() {
const hasFailedSubscribers = Array.from(this.shardedSubscribers.values()).some((sub) => !sub.isHealthy());
const hasMissingSubscribers = Array.from(this.subscriberToSlotsIndex.keys()).some((nodeKey) => !this.shardedSubscribers.has(nodeKey));
return hasFailedSubscribers || hasMissingSubscribers;
}
shouldStartSubscriber(sub) {
if (sub.isStarted()) {
return false;
}
if (!sub.isLazyConnect()) {
return true;
}
const subscriberSlots = this.subscriberToSlotsIndex.get(sub.getNodeKey());
if (!subscriberSlots) {
return false;
}
return subscriberSlots.some((slot) => {
const channels = this.channels.get(slot);
return Boolean(channels && channels.length > 0);
});
}
}
exports.default = ClusterSubscriberGroup;
// Retry strategy
ClusterSubscriberGroup.MAX_RETRY_ATTEMPTS = 10;
ClusterSubscriberGroup.MAX_BACKOFF_MS = 2000;
ClusterSubscriberGroup.BASE_BACKOFF_MS = 100;
landvex/node_modules/ioredis/built/cluster/ConnectionPool.d.ts
Generated Vendored
+39
View File
@@ -0,0 +1,39 @@
/// <reference types="node" />
import { EventEmitter } from "events";
import { RedisOptions, NodeKey, NodeRole } from "./util";
import { ClusterOptions, ClusterNodeRetryStrategy } from "./ClusterOptions";
import Redis from "../Redis";
export default class ConnectionPool extends EventEmitter {
private redisOptions;
private clusterNodeRetryStrategy;
private nodes;
private specifiedOptions;
constructor(redisOptions: NonNullable<ClusterOptions["redisOptions"]>, clusterNodeRetryStrategy?: ClusterNodeRetryStrategy);
getNodes(role?: NodeRole): Redis[];
getInstanceByKey(key: NodeKey): Redis;
getSampleInstance(role: NodeRole): Redis;
/**
* Add a master node to the pool
* @param node
*/
addMasterNode(node: RedisOptions): boolean;
/**
* Creates a Redis connection instance from the node options
* @param node
* @param readOnly
*/
createRedisFromOptions(node: RedisOptions, readOnly: boolean): Redis;
/**
* Find or create a connection to the node
*/
findOrCreate(node: RedisOptions, readOnly?: boolean): Redis;
/**
* Reset the pool with a set of nodes.
* The old node will be removed.
*/
reset(nodes: RedisOptions[]): void;
/**
* Remove a node from the pool.
*/
private removeNode;
}
landvex/node_modules/ioredis/built/cluster/ConnectionPool.js
Generated Vendored
+159
View File
@@ -0,0 +1,159 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const events_1 = require("events");
const utils_1 = require("../utils");
const util_1 = require("./util");
const Redis_1 = require("../Redis");
const debug = (0, utils_1.Debug)("cluster:connectionPool");
class ConnectionPool extends events_1.EventEmitter {
constructor(redisOptions, clusterNodeRetryStrategy = null) {
super();
this.redisOptions = redisOptions;
this.clusterNodeRetryStrategy = clusterNodeRetryStrategy;
// master + slave = all
this.nodes = {
all: {},
master: {},
slave: {},
};
this.specifiedOptions = {};
}
getNodes(role = "all") {
const nodes = this.nodes[role];
return Object.keys(nodes).map((key) => nodes[key]);
}
getInstanceByKey(key) {
return this.nodes.all[key];
}
getSampleInstance(role) {
const keys = Object.keys(this.nodes[role]);
const sampleKey = (0, utils_1.sample)(keys);
return this.nodes[role][sampleKey];
}
/**
* Add a master node to the pool
* @param node
*/
addMasterNode(node) {
const key = (0, util_1.getNodeKey)(node.options);
const redis = this.createRedisFromOptions(node, node.options.readOnly);
//Master nodes aren't read-only
if (!node.options.readOnly) {
this.nodes.all[key] = redis;
this.nodes.master[key] = redis;
return true;
}
return false;
}
/**
* Creates a Redis connection instance from the node options
* @param node
* @param readOnly
*/
createRedisFromOptions(node, readOnly) {
const redis = new Redis_1.default((0, utils_1.defaults)({
// By default, never try to reconnect when a node is lost,
// instead, waiting for a `MOVED` error and fetching slots again.
// When `clusterNodeRetryStrategy` is set, use it to allow
// reconnection (e.g. for replica nodes that restart without
// any slot changes).
retryStrategy: typeof this.clusterNodeRetryStrategy === "function"
? this.clusterNodeRetryStrategy
: null,
// Offline queue should be enabled so that
// we don't need to wait for the `ready` event
// before sending commands to the node.
enableOfflineQueue: true,
readOnly: readOnly,
}, node, this.redisOptions, { lazyConnect: true }));
return redis;
}
/**
* Find or create a connection to the node
*/
findOrCreate(node, readOnly = false) {
const key = (0, util_1.getNodeKey)(node);
readOnly = Boolean(readOnly);
if (this.specifiedOptions[key]) {
Object.assign(node, this.specifiedOptions[key]);
}
else {
this.specifiedOptions[key] = node;
}
let redis;
if (this.nodes.all[key]) {
redis = this.nodes.all[key];
if (redis.options.readOnly !== readOnly) {
redis.options.readOnly = readOnly;
debug("Change role of %s to %s", key, readOnly ? "slave" : "master");
redis[readOnly ? "readonly" : "readwrite"]().catch(utils_1.noop);
if (readOnly) {
delete this.nodes.master[key];
this.nodes.slave[key] = redis;
}
else {
delete this.nodes.slave[key];
this.nodes.master[key] = redis;
}
}
}
else {
debug("Connecting to %s as %s", key, readOnly ? "slave" : "master");
redis = this.createRedisFromOptions(node, readOnly);
this.nodes.all[key] = redis;
this.nodes[readOnly ? "slave" : "master"][key] = redis;
redis.once("end", () => {
this.removeNode(key);
this.emit("-node", redis, key);
if (!Object.keys(this.nodes.all).length) {
this.emit("drain");
}
});
this.emit("+node", redis, key);
redis.on("error", (error) => {
this.emit("nodeError", error, key);
});
}
return redis;
}
/**
* Reset the pool with a set of nodes.
* The old node will be removed.
*/
reset(nodes) {
debug("Reset with %O", nodes);
const newNodes = {};
nodes.forEach((node) => {
const key = (0, util_1.getNodeKey)(node);
// Don't override the existing (master) node
// when the current one is slave.
if (!(node.readOnly && newNodes[key])) {
newNodes[key] = node;
}
});
Object.keys(this.nodes.all).forEach((key) => {
if (!newNodes[key]) {
debug("Disconnect %s because the node does not hold any slot", key);
this.nodes.all[key].disconnect();
this.removeNode(key);
}
});
Object.keys(newNodes).forEach((key) => {
const node = newNodes[key];
this.findOrCreate(node, node.readOnly);
});
}
/**
* Remove a node from the pool.
*/
removeNode(key) {
const { nodes } = this;
if (nodes.all[key]) {
debug("Remove %s from the pool", key);
delete nodes.all[key];
}
delete nodes.master[key];
delete nodes.slave[key];
}
}
exports.default = ConnectionPool;
landvex/node_modules/ioredis/built/cluster/DelayQueue.d.ts
Generated Vendored
+20
View File
@@ -0,0 +1,20 @@
export interface DelayQueueOptions {
callback?: Function;
timeout: number;
}
/**
* Queue that runs items after specified duration
*/
export default class DelayQueue {
private queues;
private timeouts;
/**
* Add a new item to the queue
*
* @param bucket bucket name
* @param item function that will run later
* @param options
*/
push(bucket: string, item: Function, options: DelayQueueOptions): void;
private execute;
}
landvex/node_modules/ioredis/built/cluster/DelayQueue.js
Generated Vendored
+53
View File
@@ -0,0 +1,53 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const utils_1 = require("../utils");
const Deque = require("denque");
const debug = (0, utils_1.Debug)("delayqueue");
/**
* Queue that runs items after specified duration
*/
class DelayQueue {
constructor() {
this.queues = {};
this.timeouts = {};
}
/**
* Add a new item to the queue
*
* @param bucket bucket name
* @param item function that will run later
* @param options
*/
push(bucket, item, options) {
const callback = options.callback || process.nextTick;
if (!this.queues[bucket]) {
this.queues[bucket] = new Deque();
}
const queue = this.queues[bucket];
queue.push(item);
if (!this.timeouts[bucket]) {
this.timeouts[bucket] = setTimeout(() => {
callback(() => {
this.timeouts[bucket] = null;
this.execute(bucket);
});
}, options.timeout);
}
}
execute(bucket) {
const queue = this.queues[bucket];
if (!queue) {
return;
}
const { length } = queue;
if (!length) {
return;
}
debug("send %d commands in %s queue", length, bucket);
this.queues[bucket] = null;
while (queue.length > 0) {
queue.shift()();
}
}
}
exports.default = DelayQueue;
landvex/node_modules/ioredis/built/cluster/ShardedSubscriber.d.ts
Generated Vendored
+36
View File
@@ -0,0 +1,36 @@
/// <reference types="node" />
import EventEmitter = require("events");
import { RedisOptions } from "./util";
import Redis from "../Redis";
import { ClusterOptions } from "./ClusterOptions";
declare const SubscriberStatus: {
readonly IDLE: "idle";
readonly STARTING: "starting";
readonly CONNECTED: "connected";
readonly STOPPING: "stopping";
readonly ENDED: "ended";
};
declare type SubscriberStatus = typeof SubscriberStatus[keyof typeof SubscriberStatus];
export default class ShardedSubscriber {
private readonly emitter;
private readonly nodeKey;
private status;
private instance;
private connectPromise;
private lazyConnect;
private readonly messageListeners;
constructor(emitter: EventEmitter, options: RedisOptions, redisOptions?: ClusterOptions["redisOptions"]);
start(): Promise<void>;
stop(): void;
isStarted(): boolean;
get subscriberStatus(): SubscriberStatus;
isHealthy(): boolean;
getInstance(): Redis | null;
getNodeKey(): string;
isLazyConnect(): boolean;
private onEnd;
private onError;
private onMoved;
private updateStatus;
}
export {};
landvex/node_modules/ioredis/built/cluster/ShardedSubscriber.js
Generated Vendored
+147
View File
@@ -0,0 +1,147 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const util_1 = require("./util");
const utils_1 = require("../utils");
const Redis_1 = require("../Redis");
const debug = (0, utils_1.Debug)("cluster:subscriberGroup:shardedSubscriber");
const SubscriberStatus = {
IDLE: "idle",
STARTING: "starting",
CONNECTED: "connected",
STOPPING: "stopping",
ENDED: "ended",
};
const ALLOWED_STATUS_UPDATES = {
[SubscriberStatus.IDLE]: [
SubscriberStatus.STARTING,
SubscriberStatus.STOPPING,
SubscriberStatus.ENDED,
],
[SubscriberStatus.STARTING]: [
SubscriberStatus.CONNECTED,
SubscriberStatus.STOPPING,
SubscriberStatus.ENDED,
],
[SubscriberStatus.CONNECTED]: [
SubscriberStatus.STOPPING,
SubscriberStatus.ENDED,
],
[SubscriberStatus.STOPPING]: [SubscriberStatus.ENDED],
[SubscriberStatus.ENDED]: [],
};
class ShardedSubscriber {
constructor(emitter, options, redisOptions) {
var _a;
this.emitter = emitter;
this.status = SubscriberStatus.IDLE;
this.instance = null;
this.connectPromise = null;
// Store listener references for cleanup
this.messageListeners = new Map();
this.onEnd = () => {
this.updateStatus(SubscriberStatus.ENDED);
this.emitter.emit("-node", this.instance, this.nodeKey);
};
this.onError = (error) => {
this.emitter.emit("nodeError", error, this.nodeKey);
};
this.onMoved = () => {
this.emitter.emit("moved");
};
this.instance = new Redis_1.default((0, utils_1.defaults)({
enableReadyCheck: false,
enableOfflineQueue: true,
connectionName: (0, util_1.getConnectionName)("ssubscriber", options.connectionName),
/**
* Disable auto reconnection for subscribers.
* The ClusterSubscriberGroup will handle the reconnection.
*/
retryStrategy: null,
lazyConnect: true,
}, options, redisOptions));
this.lazyConnect = (_a = redisOptions === null || redisOptions === void 0 ? void 0 : redisOptions.lazyConnect) !== null && _a !== void 0 ? _a : true;
this.nodeKey = (0, util_1.getNodeKey)(options);
// Register listeners
this.instance.on("end", this.onEnd);
this.instance.on("error", this.onError);
this.instance.on("moved", this.onMoved);
for (const event of ["smessage", "smessageBuffer"]) {
const listener = (...args) => {
this.emitter.emit(event, ...args);
};
this.messageListeners.set(event, listener);
this.instance.on(event, listener);
}
}
async start() {
if (this.connectPromise) {
return this.connectPromise;
}
if (this.status === SubscriberStatus.STARTING ||
this.status === SubscriberStatus.CONNECTED) {
return;
}
if (this.status === SubscriberStatus.ENDED || !this.instance) {
throw new Error(`Sharded subscriber ${this.nodeKey} cannot be restarted once ended.`);
}
this.updateStatus(SubscriberStatus.STARTING);
this.connectPromise = this.instance.connect();
try {
await this.connectPromise;
this.updateStatus(SubscriberStatus.CONNECTED);
}
catch (err) {
this.updateStatus(SubscriberStatus.ENDED);
throw err;
}
finally {
this.connectPromise = null;
}
}
stop() {
this.updateStatus(SubscriberStatus.STOPPING);
if (this.instance) {
this.instance.disconnect();
this.instance.removeAllListeners();
this.messageListeners.clear();
this.instance = null;
}
this.updateStatus(SubscriberStatus.ENDED);
debug("stopped %s", this.nodeKey);
}
isStarted() {
return [
SubscriberStatus.CONNECTED,
SubscriberStatus.STARTING,
].includes(this.status);
}
get subscriberStatus() {
return this.status;
}
isHealthy() {
return ((this.status === SubscriberStatus.IDLE ||
this.status === SubscriberStatus.CONNECTED ||
this.status === SubscriberStatus.STARTING) &&
this.instance !== null);
}
getInstance() {
return this.instance;
}
getNodeKey() {
return this.nodeKey;
}
isLazyConnect() {
return this.lazyConnect;
}
updateStatus(nextStatus) {
if (this.status === nextStatus) {
return;
}
if (!ALLOWED_STATUS_UPDATES[this.status].includes(nextStatus)) {
debug("Invalid status transition for %s: %s -> %s", this.nodeKey, this.status, nextStatus);
return;
}
this.status = nextStatus;
}
}
exports.default = ShardedSubscriber;
landvex/node_modules/ioredis/built/cluster/index.d.ts
Generated Vendored
+163
View File
@@ -0,0 +1,163 @@
/// <reference types="node" />
import { EventEmitter } from "events";
import Command from "../Command";
import Redis from "../Redis";
import ScanStream from "../ScanStream";
import { Transaction } from "../transaction";
import { Callback, ScanStreamOptions, WriteableStream } from "../types";
import Commander from "../utils/Commander";
import { ClusterOptions } from "./ClusterOptions";
import { NodeKey, NodeRole } from "./util";
export declare type ClusterNode = string | number | {
host?: string | undefined;
port?: number | undefined;
};
declare type ClusterStatus = "end" | "close" | "wait" | "connecting" | "connect" | "ready" | "reconnecting" | "disconnecting";
/**
* Client for the official Redis Cluster
*/
declare class Cluster extends Commander {
options: ClusterOptions;
slots: NodeKey[][];
status: ClusterStatus;
/**
* @ignore
*/
_groupsIds: {
[key: string]: number;
};
/**
* @ignore
*/
_groupsBySlot: number[];
/**
* @ignore
*/
isCluster: boolean;
private startupNodes;
private connectionPool;
private manuallyClosing;
private retryAttempts;
private delayQueue;
private offlineQueue;
private subscriber;
private shardedSubscribers;
private slotsTimer;
private reconnectTimeout;
private isRefreshing;
private _refreshSlotsCacheCallbacks;
private _autoPipelines;
private _runningAutoPipelines;
private _readyDelayedCallbacks;
private subscriberGroupEmitter;
/**
* Every time Cluster#connect() is called, this value will be
* auto-incrementing. The purpose of this value is used for
* discarding previous connect attampts when creating a new
* connection.
*/
private connectionEpoch;
/**
* Creates an instance of Cluster.
*/
constructor(startupNodes: ClusterNode[], options?: ClusterOptions);
/**
* Connect to a cluster
*/
connect(): Promise<void>;
/**
* Disconnect from every node in the cluster.
*/
disconnect(reconnect?: boolean): void;
/**
* Quit the cluster gracefully.
*/
quit(callback?: Callback<"OK">): Promise<"OK">;
/**
* Create a new instance with the same startup nodes and options as the current one.
*
* @example
* ```js
* var cluster = new Redis.Cluster([{ host: "127.0.0.1", port: "30001" }]);
* var anotherCluster = cluster.duplicate();
* ```
*/
duplicate(overrideStartupNodes?: any[], overrideOptions?: {}): Cluster;
/**
* Get nodes with the specified role
*/
nodes(role?: NodeRole): Redis[];
/**
* This is needed in order not to install a listener for each auto pipeline
*
* @ignore
*/
delayUntilReady(callback: Callback): void;
/**
* Get the number of commands queued in automatic pipelines.
*
* This is not available (and returns 0) until the cluster is connected and slots information have been received.
*/
get autoPipelineQueueSize(): number;
/**
* Refresh the slot cache
*
* @ignore
*/
refreshSlotsCache(callback?: Callback<void>): void;
/**
* @ignore
*/
sendCommand(command: Command, stream?: WriteableStream, node?: any): unknown;
sscanStream(key: string, options?: ScanStreamOptions): ScanStream;
sscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream;
hscanStream(key: string, options?: ScanStreamOptions): ScanStream;
hscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream;
zscanStream(key: string, options?: ScanStreamOptions): ScanStream;
zscanBufferStream(key: string, options?: ScanStreamOptions): ScanStream;
/**
* @ignore
*/
handleError(error: Error, ttl: {
value?: any;
}, handlers: any): void;
private resetOfflineQueue;
private clearNodesRefreshInterval;
private resetNodesRefreshInterval;
/**
* Change cluster instance's status
*/
private setStatus;
/**
* Called when closed to check whether a reconnection should be made
*/
private handleCloseEvent;
/**
* Flush offline queue with error.
*/
private flushQueue;
private executeOfflineCommands;
private natMapper;
private getInfoFromNode;
private invokeReadyDelayedCallbacks;
/**
* Check whether Cluster is able to process commands
*/
private readyCheck;
private resolveSrv;
private dnsLookup;
/**
* Normalize startup nodes, and resolving hostnames to IPs.
*
* This process happens every time when #connect() is called since
* #startupNodes and DNS records may chanage.
*/
private resolveStartupNodeHostnames;
private createScanStream;
private createShardedSubscriberGroup;
}
interface Cluster extends EventEmitter {
}
interface Cluster extends Transaction {
}
export default Cluster;
landvex/node_modules/ioredis/built/cluster/index.js
Generated Vendored
+945
View File
@@ -0,0 +1,945 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const commands_1 = require("@ioredis/commands");
const events_1 = require("events");
const redis_errors_1 = require("redis-errors");
const standard_as_callback_1 = require("standard-as-callback");
const Command_1 = require("../Command");
const ClusterAllFailedError_1 = require("../errors/ClusterAllFailedError");
const Redis_1 = require("../Redis");
const ScanStream_1 = require("../ScanStream");
const transaction_1 = require("../transaction");
const utils_1 = require("../utils");
const applyMixin_1 = require("../utils/applyMixin");
const Commander_1 = require("../utils/Commander");
const ClusterOptions_1 = require("./ClusterOptions");
const ClusterSubscriber_1 = require("./ClusterSubscriber");
const ConnectionPool_1 = require("./ConnectionPool");
const DelayQueue_1 = require("./DelayQueue");
const util_1 = require("./util");
const Deque = require("denque");
const ClusterSubscriberGroup_1 = require("./ClusterSubscriberGroup");
const debug = (0, utils_1.Debug)("cluster");
const REJECT_OVERWRITTEN_COMMANDS = new WeakSet();
/**
* Client for the official Redis Cluster
*/
class Cluster extends Commander_1.default {
/**
* Creates an instance of Cluster.
*/
//TODO: Add an option that enables or disables sharded PubSub
constructor(startupNodes, options = {}) {
var _a;
super();
this.slots = [];
/**
* @ignore
*/
this._groupsIds = {};
/**
* @ignore
*/
this._groupsBySlot = Array(16384);
/**
* @ignore
*/
this.isCluster = true;
this.retryAttempts = 0;
this.delayQueue = new DelayQueue_1.default();
this.offlineQueue = new Deque();
this.isRefreshing = false;
this._refreshSlotsCacheCallbacks = [];
this._autoPipelines = new Map();
this._runningAutoPipelines = new Set();
this._readyDelayedCallbacks = [];
/**
* Every time Cluster#connect() is called, this value will be
* auto-incrementing. The purpose of this value is used for
* discarding previous connect attampts when creating a new
* connection.
*/
this.connectionEpoch = 0;
events_1.EventEmitter.call(this);
this.startupNodes = startupNodes;
this.options = (0, utils_1.defaults)({}, options, ClusterOptions_1.DEFAULT_CLUSTER_OPTIONS, this.options);
if (this.options.shardedSubscribers) {
this.createShardedSubscriberGroup();
}
if (this.options.redisOptions &&
this.options.redisOptions.keyPrefix &&
!this.options.keyPrefix) {
this.options.keyPrefix = this.options.redisOptions.keyPrefix;
}
// validate options
if (typeof this.options.scaleReads !== "function" &&
["all", "master", "slave"].indexOf(this.options.scaleReads) === -1) {
throw new Error('Invalid option scaleReads "' +
this.options.scaleReads +
'". Expected "all", "master", "slave" or a custom function');
}
this.connectionPool = new ConnectionPool_1.default((_a = this.options.redisOptions) !== null && _a !== void 0 ? _a : {}, this.options.clusterNodeRetryStrategy);
this.connectionPool.on("-node", (redis, key) => {
this.emit("-node", redis);
});
this.connectionPool.on("+node", (redis) => {
this.emit("+node", redis);
});
this.connectionPool.on("drain", () => {
this.setStatus("close");
});
this.connectionPool.on("nodeError", (error, key) => {
this.emit("node error", error, key);
});
this.subscriber = new ClusterSubscriber_1.default(this.connectionPool, this);
if (this.options.scripts) {
Object.entries(this.options.scripts).forEach(([name, definition]) => {
this.defineCommand(name, definition);
});
}
if (this.options.lazyConnect) {
this.setStatus("wait");
}
else {
this.connect().catch((err) => {
debug("connecting failed: %s", err);
});
}
}
/**
* Connect to a cluster
*/
connect() {
return new Promise((resolve, reject) => {
if (this.status === "connecting" ||
this.status === "connect" ||
this.status === "ready") {
reject(new Error("Redis is already connecting/connected"));
return;
}
const epoch = ++this.connectionEpoch;
this.setStatus("connecting");
this.resolveStartupNodeHostnames()
.then((nodes) => {
if (this.connectionEpoch !== epoch) {
debug("discard connecting after resolving startup nodes because epoch not match: %d != %d", epoch, this.connectionEpoch);
reject(new redis_errors_1.RedisError("Connection is discarded because a new connection is made"));
return;
}
if (this.status !== "connecting") {
debug("discard connecting after resolving startup nodes because the status changed to %s", this.status);
reject(new redis_errors_1.RedisError("Connection is aborted"));
return;
}
this.connectionPool.reset(nodes);
if (this.options.shardedSubscribers) {
this.shardedSubscribers
.reset(this.slots, this.connectionPool.getNodes("all"))
.catch((err) => {
// TODO should we emit an error event here?
debug("Error while starting subscribers: %s", err);
});
}
const readyHandler = () => {
this.setStatus("ready");
this.retryAttempts = 0;
this.executeOfflineCommands();
this.resetNodesRefreshInterval();
resolve();
};
let closeListener = undefined;
const refreshListener = () => {
this.invokeReadyDelayedCallbacks(undefined);
this.removeListener("close", closeListener);
this.manuallyClosing = false;
this.setStatus("connect");
if (this.options.enableReadyCheck) {
this.readyCheck((err, fail) => {
if (err || fail) {
debug("Ready check failed (%s). Reconnecting...", err || fail);
if (this.status === "connect") {
this.disconnect(true);
}
}
else {
readyHandler();
}
});
}
else {
readyHandler();
}
};
closeListener = () => {
const error = new Error("None of startup nodes is available");
this.removeListener("refresh", refreshListener);
this.invokeReadyDelayedCallbacks(error);
reject(error);
};
this.once("refresh", refreshListener);
this.once("close", closeListener);
this.once("close", this.handleCloseEvent.bind(this));
this.refreshSlotsCache((err) => {
if (err && err.message === ClusterAllFailedError_1.default.defaultMessage) {
Redis_1.default.prototype.silentEmit.call(this, "error", err);
this.connectionPool.reset([]);
}
});
this.subscriber.start();
if (this.options.shardedSubscribers) {
this.shardedSubscribers.start().catch((err) => {
// TODO should we emit an error event here?
debug("Error while starting subscribers: %s", err);
});
}
})
.catch((err) => {
this.setStatus("close");
this.handleCloseEvent(err);
this.invokeReadyDelayedCallbacks(err);
reject(err);
});
});
}
/**
* Disconnect from every node in the cluster.
*/
disconnect(reconnect = false) {
const status = this.status;
this.setStatus("disconnecting");
if (!reconnect) {
this.manuallyClosing = true;
}
if (this.reconnectTimeout && !reconnect) {
clearTimeout(this.reconnectTimeout);
this.reconnectTimeout = null;
debug("Canceled reconnecting attempts");
}
this.clearNodesRefreshInterval();
this.subscriber.stop();
if (this.options.shardedSubscribers) {
this.shardedSubscribers.stop();
}
if (status === "wait") {
this.setStatus("close");
this.handleCloseEvent();
}
else {
this.connectionPool.reset([]);
}
}
/**
* Quit the cluster gracefully.
*/
quit(callback) {
const status = this.status;
this.setStatus("disconnecting");
this.manuallyClosing = true;
if (this.reconnectTimeout) {
clearTimeout(this.reconnectTimeout);
this.reconnectTimeout = null;
}
this.clearNodesRefreshInterval();
this.subscriber.stop();
if (this.options.shardedSubscribers) {
this.shardedSubscribers.stop();
}
if (status === "wait") {
const ret = (0, standard_as_callback_1.default)(Promise.resolve("OK"), callback);
// use setImmediate to make sure "close" event
// being emitted after quit() is returned
setImmediate(function () {
this.setStatus("close");
this.handleCloseEvent();
}.bind(this));
return ret;
}
return (0, standard_as_callback_1.default)(Promise.all(this.nodes().map((node) => node.quit().catch((err) => {
// Ignore the error caused by disconnecting since
// we're disconnecting...
if (err.message === utils_1.CONNECTION_CLOSED_ERROR_MSG) {
return "OK";
}
throw err;
}))).then(() => "OK"), callback);
}
/**
* Create a new instance with the same startup nodes and options as the current one.
*
* @example
* ```js
* var cluster = new Redis.Cluster([{ host: "127.0.0.1", port: "30001" }]);
* var anotherCluster = cluster.duplicate();
* ```
*/
duplicate(overrideStartupNodes = [], overrideOptions = {}) {
const startupNodes = overrideStartupNodes.length > 0
? overrideStartupNodes
: this.startupNodes.slice(0);
const options = Object.assign({}, this.options, overrideOptions);
return new Cluster(startupNodes, options);
}
/**
* Get nodes with the specified role
*/
nodes(role = "all") {
if (role !== "all" && role !== "master" && role !== "slave") {
throw new Error('Invalid role "' + role + '". Expected "all", "master" or "slave"');
}
return this.connectionPool.getNodes(role);
}
/**
* This is needed in order not to install a listener for each auto pipeline
*
* @ignore
*/
delayUntilReady(callback) {
this._readyDelayedCallbacks.push(callback);
}
/**
* Get the number of commands queued in automatic pipelines.
*
* This is not available (and returns 0) until the cluster is connected and slots information have been received.
*/
get autoPipelineQueueSize() {
let queued = 0;
for (const pipeline of this._autoPipelines.values()) {
queued += pipeline.length;
}
return queued;
}
/**
* Refresh the slot cache
*
* @ignore
*/
refreshSlotsCache(callback) {
if (callback) {
this._refreshSlotsCacheCallbacks.push(callback);
}
if (this.isRefreshing) {
return;
}
this.isRefreshing = true;
const _this = this;
const wrapper = (error) => {
this.isRefreshing = false;
for (const callback of this._refreshSlotsCacheCallbacks) {
callback(error);
}
this._refreshSlotsCacheCallbacks = [];
};
const nodes = (0, utils_1.shuffle)(this.connectionPool.getNodes());
let lastNodeError = null;
function tryNode(index) {
if (index === nodes.length) {
const error = new ClusterAllFailedError_1.default(ClusterAllFailedError_1.default.defaultMessage, lastNodeError);
return wrapper(error);
}
const node = nodes[index];
const key = `${node.options.host}:${node.options.port}`;
debug("getting slot cache from %s", key);
_this.getInfoFromNode(node, function (err) {
switch (_this.status) {
case "close":
case "end":
return wrapper(new Error("Cluster is disconnected."));
case "disconnecting":
return wrapper(new Error("Cluster is disconnecting."));
}
if (err) {
_this.emit("node error", err, key);
lastNodeError = err;
tryNode(index + 1);
}
else {
_this.emit("refresh");
wrapper();
}
});
}
tryNode(0);
}
/**
* @ignore
*/
sendCommand(command, stream, node) {
if (this.status === "wait") {
this.connect().catch(utils_1.noop);
}
if (this.status === "end") {
command.reject(new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG));
return command.promise;
}
let to = this.options.scaleReads;
if (to !== "master") {
const isCommandReadOnly = command.isReadOnly ||
((0, commands_1.exists)(command.name) && (0, commands_1.hasFlag)(command.name, "readonly"));
if (!isCommandReadOnly) {
to = "master";
}
}
let targetSlot = node ? node.slot : command.getSlot();
const ttl = {};
const _this = this;
if (!node && !REJECT_OVERWRITTEN_COMMANDS.has(command)) {
REJECT_OVERWRITTEN_COMMANDS.add(command);
const reject = command.reject;
command.reject = function (err) {
const partialTry = tryConnection.bind(null, true);
_this.handleError(err, ttl, {
moved: function (slot, key) {
debug("command %s is moved to %s", command.name, key);
targetSlot = Number(slot);
if (_this.slots[slot]) {
_this.slots[slot][0] = key;
}
else {
_this.slots[slot] = [key];
}
_this._groupsBySlot[slot] =
_this._groupsIds[_this.slots[slot].join(";")];
_this.connectionPool.findOrCreate(_this.natMapper(key));
tryConnection();
debug("refreshing slot caches... (triggered by MOVED error)");
_this.refreshSlotsCache();
},
ask: function (slot, key) {
debug("command %s is required to ask %s:%s", command.name, key);
const mapped = _this.natMapper(key);
_this.connectionPool.findOrCreate(mapped);
tryConnection(false, `${mapped.host}:${mapped.port}`);
},
tryagain: partialTry,
clusterDown: partialTry,
connectionClosed: partialTry,
maxRedirections: function (redirectionError) {
reject.call(command, redirectionError);
},
defaults: function () {
reject.call(command, err);
},
});
};
}
tryConnection();
function tryConnection(random, asking) {
if (_this.status === "end") {
command.reject(new redis_errors_1.AbortError("Cluster is ended."));
return;
}
let redis;
if (_this.status === "ready" || command.name === "cluster") {
if (node && node.redis) {
redis = node.redis;
}
else if (Command_1.default.checkFlag("ENTER_SUBSCRIBER_MODE", command.name) ||
Command_1.default.checkFlag("EXIT_SUBSCRIBER_MODE", command.name)) {
if (_this.options.shardedSubscribers &&
(command.name == "ssubscribe" || command.name == "sunsubscribe")) {
const sub = _this.shardedSubscribers.getResponsibleSubscriber(targetSlot);
if (!sub) {
command.reject(new redis_errors_1.AbortError(`No sharded subscriber for slot: ${targetSlot}`));
return;
}
let status = -1;
if (command.name == "ssubscribe") {
status = _this.shardedSubscribers.addChannels(command.getKeys());
}
if (command.name == "sunsubscribe") {
status = _this.shardedSubscribers.removeChannels(command.getKeys());
}
if (status !== -1) {
redis = sub.getInstance();
}
else {
command.reject(new redis_errors_1.AbortError("Possible CROSSSLOT error: All channels must hash to the same slot"));
}
}
else {
redis = _this.subscriber.getInstance();
}
if (!redis) {
command.reject(new redis_errors_1.AbortError("No subscriber for the cluster"));
return;
}
}
else {
if (!random) {
if (typeof targetSlot === "number" && _this.slots[targetSlot]) {
const nodeKeys = _this.slots[targetSlot];
if (typeof to === "function") {
const nodes = nodeKeys.map(function (key) {
return _this.connectionPool.getInstanceByKey(key);
});
redis = to(nodes, command);
if (Array.isArray(redis)) {
redis = (0, utils_1.sample)(redis);
}
if (!redis) {
redis = nodes[0];
}
}
else {
let key;
if (to === "all") {
key = (0, utils_1.sample)(nodeKeys);
}
else if (to === "slave" && nodeKeys.length > 1) {
key = (0, utils_1.sample)(nodeKeys, 1);
}
else {
key = nodeKeys[0];
}
redis = _this.connectionPool.getInstanceByKey(key);
}
}
if (asking) {
redis = _this.connectionPool.getInstanceByKey(asking);
redis.asking();
}
}
if (!redis) {
redis =
(typeof to === "function"
? null
: _this.connectionPool.getSampleInstance(to)) ||
_this.connectionPool.getSampleInstance("all");
}
if (redis &&
!_this.options.enableOfflineQueue &&
redis.status !== "ready" &&
redis.status !== "wait") {
command.reject(new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG));
return;
}
}
if (node && !node.redis) {
node.redis = redis;
}
}
if (!redis && _this.options.enableOfflineQueue) {
_this.offlineQueue.push({
command: command,
stream: stream,
node: node,
});
return;
}
if (!redis) {
command.reject(new Error("Cluster isn't ready and enableOfflineQueue options is false"));
return;
}
redis.sendCommand(command, stream);
}
return command.promise;
}
sscanStream(key, options) {
return this.createScanStream("sscan", { key, options });
}
sscanBufferStream(key, options) {
return this.createScanStream("sscanBuffer", { key, options });
}
hscanStream(key, options) {
return this.createScanStream("hscan", { key, options });
}
hscanBufferStream(key, options) {
return this.createScanStream("hscanBuffer", { key, options });
}
zscanStream(key, options) {
return this.createScanStream("zscan", { key, options });
}
zscanBufferStream(key, options) {
return this.createScanStream("zscanBuffer", { key, options });
}
/**
* @ignore
*/
handleError(error, ttl, handlers) {
if (typeof ttl.value === "undefined") {
ttl.value = this.options.maxRedirections;
}
else {
ttl.value -= 1;
}
if (ttl.value <= 0) {
handlers.maxRedirections(new Error("Too many Cluster redirections. Last error: " + error));
return;
}
const errv = error.message.split(" ");
if (errv[0] === "MOVED") {
const timeout = this.options.retryDelayOnMoved;
if (timeout && typeof timeout === "number") {
this.delayQueue.push("moved", handlers.moved.bind(null, errv[1], errv[2]), { timeout });
}
else {
handlers.moved(errv[1], errv[2]);
}
}
else if (errv[0] === "ASK") {
handlers.ask(errv[1], errv[2]);
}
else if (errv[0] === "TRYAGAIN") {
this.delayQueue.push("tryagain", handlers.tryagain, {
timeout: this.options.retryDelayOnTryAgain,
});
}
else if (errv[0] === "CLUSTERDOWN" &&
this.options.retryDelayOnClusterDown > 0) {
this.delayQueue.push("clusterdown", handlers.connectionClosed, {
timeout: this.options.retryDelayOnClusterDown,
callback: this.refreshSlotsCache.bind(this),
});
}
else if (error.message === utils_1.CONNECTION_CLOSED_ERROR_MSG &&
this.options.retryDelayOnFailover > 0 &&
this.status === "ready") {
this.delayQueue.push("failover", handlers.connectionClosed, {
timeout: this.options.retryDelayOnFailover,
callback: this.refreshSlotsCache.bind(this),
});
}
else {
handlers.defaults();
}
}
resetOfflineQueue() {
this.offlineQueue = new Deque();
}
clearNodesRefreshInterval() {
if (this.slotsTimer) {
clearTimeout(this.slotsTimer);
this.slotsTimer = null;
}
}
resetNodesRefreshInterval() {
if (this.slotsTimer || !this.options.slotsRefreshInterval) {
return;
}
const nextRound = () => {
this.slotsTimer = setTimeout(() => {
debug('refreshing slot caches... (triggered by "slotsRefreshInterval" option)');
this.refreshSlotsCache(() => {
nextRound();
});
}, this.options.slotsRefreshInterval);
};
nextRound();
}
/**
* Change cluster instance's status
*/
setStatus(status) {
debug("status: %s -> %s", this.status || "[empty]", status);
this.status = status;
process.nextTick(() => {
this.emit(status);
});
}
/**
* Called when closed to check whether a reconnection should be made
*/
handleCloseEvent(reason) {
var _a;
if (reason) {
debug("closed because %s", reason);
}
let retryDelay;
if (!this.manuallyClosing &&
typeof this.options.clusterRetryStrategy === "function") {
retryDelay = this.options.clusterRetryStrategy.call(this, ++this.retryAttempts, reason);
}
if (typeof retryDelay === "number") {
this.setStatus("reconnecting");
this.reconnectTimeout = setTimeout(() => {
this.reconnectTimeout = null;
debug("Cluster is disconnected. Retrying after %dms", retryDelay);
this.connect().catch(function (err) {
debug("Got error %s when reconnecting. Ignoring...", err);
});
}, retryDelay);
}
else {
if (this.options.shardedSubscribers) {
(_a = this.subscriberGroupEmitter) === null || _a === void 0 ? void 0 : _a.removeAllListeners();
}
this.setStatus("end");
this.flushQueue(new Error("None of startup nodes is available"));
}
}
/**
* Flush offline queue with error.
*/
flushQueue(error) {
let item;
while ((item = this.offlineQueue.shift())) {
item.command.reject(error);
}
}
executeOfflineCommands() {
if (this.offlineQueue.length) {
debug("send %d commands in offline queue", this.offlineQueue.length);
const offlineQueue = this.offlineQueue;
this.resetOfflineQueue();
let item;
while ((item = offlineQueue.shift())) {
this.sendCommand(item.command, item.stream, item.node);
}
}
}
natMapper(nodeKey) {
const key = typeof nodeKey === "string"
? nodeKey
: `${nodeKey.host}:${nodeKey.port}`;
let mapped = null;
if (this.options.natMap && typeof this.options.natMap === "function") {
mapped = this.options.natMap(key);
}
else if (this.options.natMap && typeof this.options.natMap === "object") {
mapped = this.options.natMap[key];
}
if (mapped) {
debug("NAT mapping %s -> %O", key, mapped);
return Object.assign({}, mapped);
}
return typeof nodeKey === "string"
? (0, util_1.nodeKeyToRedisOptions)(nodeKey)
: nodeKey;
}
getInfoFromNode(redis, callback) {
if (!redis) {
return callback(new Error("Node is disconnected"));
}
// Use a duplication of the connection to avoid
// timeouts when the connection is in the blocking
// mode (e.g. waiting for BLPOP).
const duplicatedConnection = redis.duplicate({
enableOfflineQueue: true,
enableReadyCheck: false,
retryStrategy: null,
connectionName: (0, util_1.getConnectionName)("refresher", this.options.redisOptions && this.options.redisOptions.connectionName),
});
// Ignore error events since we will handle
// exceptions for the CLUSTER SLOTS command.
duplicatedConnection.on("error", utils_1.noop);
duplicatedConnection.cluster("SLOTS", (0, utils_1.timeout)((err, result) => {
duplicatedConnection.disconnect();
if (err) {
debug("error encountered running CLUSTER.SLOTS: %s", err);
return callback(err);
}
if (this.status === "disconnecting" ||
this.status === "close" ||
this.status === "end") {
debug("ignore CLUSTER.SLOTS results (count: %d) since cluster status is %s", result.length, this.status);
callback();
return;
}
const nodes = [];
debug("cluster slots result count: %d", result.length);
for (let i = 0; i < result.length; ++i) {
const items = result[i];
const slotRangeStart = items[0];
const slotRangeEnd = items[1];
const keys = [];
for (let j = 2; j < items.length; j++) {
if (!items[j][0]) {
continue;
}
const node = this.natMapper({
host: items[j][0],
port: items[j][1],
});
node.readOnly = j !== 2;
nodes.push(node);
keys.push(node.host + ":" + node.port);
}
debug("cluster slots result [%d]: slots %d~%d served by %s", i, slotRangeStart, slotRangeEnd, keys);
for (let slot = slotRangeStart; slot <= slotRangeEnd; slot++) {
this.slots[slot] = keys;
}
}
// Assign to each node keys a numeric value to make autopipeline comparison faster.
this._groupsIds = Object.create(null);
let j = 0;
for (let i = 0; i < 16384; i++) {
const target = (this.slots[i] || []).join(";");
if (!target.length) {
this._groupsBySlot[i] = undefined;
continue;
}
if (!this._groupsIds[target]) {
this._groupsIds[target] = ++j;
}
this._groupsBySlot[i] = this._groupsIds[target];
}
this.connectionPool.reset(nodes);
if (this.options.shardedSubscribers) {
this.shardedSubscribers
.reset(this.slots, this.connectionPool.getNodes("all"))
.catch((err) => {
// TODO should we emit an error event here?
debug("Error while starting subscribers: %s", err);
});
}
callback();
}, this.options.slotsRefreshTimeout));
}
invokeReadyDelayedCallbacks(err) {
for (const c of this._readyDelayedCallbacks) {
process.nextTick(c, err);
}
this._readyDelayedCallbacks = [];
}
/**
* Check whether Cluster is able to process commands
*/
readyCheck(callback) {
this.cluster("INFO", (err, res) => {
if (err) {
return callback(err);
}
if (typeof res !== "string") {
return callback();
}
let state;
const lines = res.split("\r\n");
for (let i = 0; i < lines.length; ++i) {
const parts = lines[i].split(":");
if (parts[0] === "cluster_state") {
state = parts[1];
break;
}
}
if (state === "fail") {
debug("cluster state not ok (%s)", state);
callback(null, state);
}
else {
callback();
}
});
}
resolveSrv(hostname) {
return new Promise((resolve, reject) => {
this.options.resolveSrv(hostname, (err, records) => {
if (err) {
return reject(err);
}
const self = this, groupedRecords = (0, util_1.groupSrvRecords)(records), sortedKeys = Object.keys(groupedRecords).sort((a, b) => parseInt(a) - parseInt(b));
function tryFirstOne(err) {
if (!sortedKeys.length) {
return reject(err);
}
const key = sortedKeys[0], group = groupedRecords[key], record = (0, util_1.weightSrvRecords)(group);
if (!group.records.length) {
sortedKeys.shift();
}
self.dnsLookup(record.name).then((host) => resolve({
host,
port: record.port,
}), tryFirstOne);
}
tryFirstOne();
});
});
}
dnsLookup(hostname) {
return new Promise((resolve, reject) => {
this.options.dnsLookup(hostname, (err, address) => {
if (err) {
debug("failed to resolve hostname %s to IP: %s", hostname, err.message);
reject(err);
}
else {
debug("resolved hostname %s to IP %s", hostname, address);
resolve(address);
}
});
});
}
/**
* Normalize startup nodes, and resolving hostnames to IPs.
*
* This process happens every time when #connect() is called since
* #startupNodes and DNS records may chanage.
*/
async resolveStartupNodeHostnames() {
if (!Array.isArray(this.startupNodes) || this.startupNodes.length === 0) {
throw new Error("`startupNodes` should contain at least one node.");
}
const startupNodes = (0, util_1.normalizeNodeOptions)(this.startupNodes);
const hostnames = (0, util_1.getUniqueHostnamesFromOptions)(startupNodes);
if (hostnames.length === 0) {
return startupNodes;
}
const configs = await Promise.all(hostnames.map((this.options.useSRVRecords ? this.resolveSrv : this.dnsLookup).bind(this)));
const hostnameToConfig = (0, utils_1.zipMap)(hostnames, configs);
return startupNodes.map((node) => {
const config = hostnameToConfig.get(node.host);
if (!config) {
return node;
}
if (this.options.useSRVRecords) {
return Object.assign({}, node, config);
}
return Object.assign({}, node, { host: config });
});
}
createScanStream(command, { key, options = {} }) {
return new ScanStream_1.default({
objectMode: true,
key: key,
redis: this,
command: command,
...options,
});
}
createShardedSubscriberGroup() {
this.subscriberGroupEmitter = new events_1.EventEmitter();
this.shardedSubscribers = new ClusterSubscriberGroup_1.default(this.subscriberGroupEmitter, this.options);
// Error handler used only for sharded-subscriber-triggered slots cache refreshes.
// Normal (non-subscriber) connections are created with lazyConnect: true and can
// become zombied. For sharded subscribers, a ClusterAllFailedError means
// we have lost all nodes from the subscriber perspective and must tear down.
const refreshSlotsCacheCallback = (err) => {
// Disconnect only when refreshing the slots cache fails with ClusterAllFailedError
if (err instanceof ClusterAllFailedError_1.default) {
this.disconnect(true);
}
};
this.subscriberGroupEmitter.on("-node", (redis, nodeKey) => {
this.emit("-node", redis, nodeKey);
this.refreshSlotsCache(refreshSlotsCacheCallback);
});
this.subscriberGroupEmitter.on("subscriberConnectFailed", ({ delay, error }) => {
this.emit("error", error);
setTimeout(() => {
this.refreshSlotsCache(refreshSlotsCacheCallback);
}, delay);
});
this.subscriberGroupEmitter.on("moved", () => {
this.refreshSlotsCache(refreshSlotsCacheCallback);
});
this.subscriberGroupEmitter.on("-subscriber", () => {
this.emit("-subscriber");
});
this.subscriberGroupEmitter.on("+subscriber", () => {
this.emit("+subscriber");
});
this.subscriberGroupEmitter.on("nodeError", (error, nodeKey) => {
this.emit("nodeError", error, nodeKey);
});
this.subscriberGroupEmitter.on("subscribersReady", () => {
this.emit("subscribersReady");
});
for (const event of ["smessage", "smessageBuffer"]) {
this.subscriberGroupEmitter.on(event, (arg1, arg2, arg3) => {
this.emit(event, arg1, arg2, arg3);
});
}
}
}
(0, applyMixin_1.default)(Cluster, events_1.EventEmitter);
(0, transaction_1.addTransactionSupport)(Cluster.prototype);
exports.default = Cluster;
landvex/node_modules/ioredis/built/cluster/util.d.ts
Generated Vendored
+25
View File
@@ -0,0 +1,25 @@
/// <reference types="node" />
import { SrvRecord } from "dns";
export declare type NodeKey = string;
export declare type NodeRole = "master" | "slave" | "all";
export interface RedisOptions {
port: number;
host: string;
username?: string | undefined;
password?: string | undefined;
[key: string]: any;
}
export interface SrvRecordsGroup {
totalWeight: number;
records: SrvRecord[];
}
export interface GroupedSrvRecords {
[key: number]: SrvRecordsGroup;
}
export declare function getNodeKey(node: RedisOptions): NodeKey;
export declare function nodeKeyToRedisOptions(nodeKey: NodeKey): RedisOptions;
export declare function normalizeNodeOptions(nodes: Array<string | number | object>): RedisOptions[];
export declare function getUniqueHostnamesFromOptions(nodes: RedisOptions[]): string[];
export declare function groupSrvRecords(records: SrvRecord[]): GroupedSrvRecords;
export declare function weightSrvRecords(recordsGroup: SrvRecordsGroup): SrvRecord;
export declare function getConnectionName(component: any, nodeConnectionName: any): string;
landvex/node_modules/ioredis/built/cluster/util.js
Generated Vendored
+100
View File
@@ -0,0 +1,100 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.getConnectionName = exports.weightSrvRecords = exports.groupSrvRecords = exports.getUniqueHostnamesFromOptions = exports.normalizeNodeOptions = exports.nodeKeyToRedisOptions = exports.getNodeKey = void 0;
const utils_1 = require("../utils");
const net_1 = require("net");
function getNodeKey(node) {
node.port = node.port || 6379;
node.host = node.host || "127.0.0.1";
return node.host + ":" + node.port;
}
exports.getNodeKey = getNodeKey;
function nodeKeyToRedisOptions(nodeKey) {
const portIndex = nodeKey.lastIndexOf(":");
if (portIndex === -1) {
throw new Error(`Invalid node key ${nodeKey}`);
}
return {
host: nodeKey.slice(0, portIndex),
port: Number(nodeKey.slice(portIndex + 1)),
};
}
exports.nodeKeyToRedisOptions = nodeKeyToRedisOptions;
function normalizeNodeOptions(nodes) {
return nodes.map((node) => {
const options = {};
if (typeof node === "object") {
Object.assign(options, node);
}
else if (typeof node === "string") {
Object.assign(options, (0, utils_1.parseURL)(node));
}
else if (typeof node === "number") {
options.port = node;
}
else {
throw new Error("Invalid argument " + node);
}
if (typeof options.port === "string") {
options.port = parseInt(options.port, 10);
}
// Cluster mode only support db 0
delete options.db;
if (!options.port) {
options.port = 6379;
}
if (!options.host) {
options.host = "127.0.0.1";
}
return (0, utils_1.resolveTLSProfile)(options);
});
}
exports.normalizeNodeOptions = normalizeNodeOptions;
function getUniqueHostnamesFromOptions(nodes) {
const uniqueHostsMap = {};
nodes.forEach((node) => {
uniqueHostsMap[node.host] = true;
});
return Object.keys(uniqueHostsMap).filter((host) => !(0, net_1.isIP)(host));
}
exports.getUniqueHostnamesFromOptions = getUniqueHostnamesFromOptions;
function groupSrvRecords(records) {
const recordsByPriority = {};
for (const record of records) {
if (!recordsByPriority.hasOwnProperty(record.priority)) {
recordsByPriority[record.priority] = {
totalWeight: record.weight,
records: [record],
};
}
else {
recordsByPriority[record.priority].totalWeight += record.weight;
recordsByPriority[record.priority].records.push(record);
}
}
return recordsByPriority;
}
exports.groupSrvRecords = groupSrvRecords;
function weightSrvRecords(recordsGroup) {
if (recordsGroup.records.length === 1) {
recordsGroup.totalWeight = 0;
return recordsGroup.records.shift();
}
// + `recordsGroup.records.length` to support `weight` 0
const random = Math.floor(Math.random() * (recordsGroup.totalWeight + recordsGroup.records.length));
let total = 0;
for (const [i, record] of recordsGroup.records.entries()) {
total += 1 + record.weight;
if (total > random) {
recordsGroup.totalWeight -= record.weight;
recordsGroup.records.splice(i, 1);
return record;
}
}
}
exports.weightSrvRecords = weightSrvRecords;
function getConnectionName(component, nodeConnectionName) {
const prefix = `ioredis-cluster(${component})`;
return nodeConnectionName ? `${prefix}:${nodeConnectionName}` : prefix;
}
exports.getConnectionName = getConnectionName;
landvex/node_modules/ioredis/built/connectors/AbstractConnector.d.ts
Generated Vendored
+12
View File
@@ -0,0 +1,12 @@
import { NetStream } from "../types";
export declare type ErrorEmitter = (type: string, err: Error) => void;
export default abstract class AbstractConnector {
firstError?: Error;
protected connecting: boolean;
protected stream: NetStream;
private disconnectTimeout;
constructor(disconnectTimeout: number);
check(info: any): boolean;
disconnect(): void;
abstract connect(_: ErrorEmitter): Promise<NetStream>;
}
landvex/node_modules/ioredis/built/connectors/AbstractConnector.js
Generated Vendored
+26
View File
@@ -0,0 +1,26 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const utils_1 = require("../utils");
const debug = (0, utils_1.Debug)("AbstractConnector");
class AbstractConnector {
constructor(disconnectTimeout) {
this.connecting = false;
this.disconnectTimeout = disconnectTimeout;
}
check(info) {
return true;
}
disconnect() {
this.connecting = false;
if (this.stream) {
const stream = this.stream; // Make sure callbacks refer to the same instance
const timeout = setTimeout(() => {
debug("stream %s:%s still open, destroying it", stream.remoteAddress, stream.remotePort);
stream.destroy();
}, this.disconnectTimeout);
stream.on("close", () => clearTimeout(timeout));
stream.end();
}
}
}
exports.default = AbstractConnector;
landvex/node_modules/ioredis/built/connectors/ConnectorConstructor.d.ts
Generated Vendored
+5
View File
@@ -0,0 +1,5 @@
import AbstractConnector from "./AbstractConnector";
interface ConnectorConstructor {
new (options: unknown): AbstractConnector;
}
export default ConnectorConstructor;
landvex/node_modules/ioredis/built/connectors/ConnectorConstructor.js
Generated Vendored
+2
View File
@@ -0,0 +1,2 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
landvex/node_modules/ioredis/built/connectors/SentinelConnector/FailoverDetector.d.ts
Generated Vendored
+11
View File
@@ -0,0 +1,11 @@
import SentinelConnector from "./index";
import { Sentinel } from "./types";
export declare class FailoverDetector {
private connector;
private sentinels;
private isDisconnected;
constructor(connector: SentinelConnector, sentinels: Sentinel[]);
cleanup(): void;
subscribe(): Promise<void>;
private disconnect;
}
landvex/node_modules/ioredis/built/connectors/SentinelConnector/FailoverDetector.js
Generated Vendored
+45
View File
@@ -0,0 +1,45 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.FailoverDetector = void 0;
const utils_1 = require("../../utils");
const debug = (0, utils_1.Debug)("FailoverDetector");
const CHANNEL_NAME = "+switch-master";
class FailoverDetector {
// sentinels can't be used for regular commands after this
constructor(connector, sentinels) {
this.isDisconnected = false;
this.connector = connector;
this.sentinels = sentinels;
}
cleanup() {
this.isDisconnected = true;
for (const sentinel of this.sentinels) {
sentinel.client.disconnect();
}
}
async subscribe() {
debug("Starting FailoverDetector");
const promises = [];
for (const sentinel of this.sentinels) {
const promise = sentinel.client.subscribe(CHANNEL_NAME).catch((err) => {
debug("Failed to subscribe to failover messages on sentinel %s:%s (%s)", sentinel.address.host || "127.0.0.1", sentinel.address.port || 26739, err.message);
});
promises.push(promise);
sentinel.client.on("message", (channel) => {
if (!this.isDisconnected && channel === CHANNEL_NAME) {
this.disconnect();
}
});
}
await Promise.all(promises);
}
disconnect() {
// Avoid disconnecting more than once per failover.
// A new FailoverDetector will be created after reconnecting.
this.isDisconnected = true;
debug("Failover detected, disconnecting");
// Will call this.cleanup()
this.connector.disconnect();
}
}
exports.FailoverDetector = FailoverDetector;
landvex/node_modules/ioredis/built/connectors/SentinelConnector/SentinelIterator.d.ts
Generated Vendored
+13
View File
@@ -0,0 +1,13 @@
import { SentinelAddress } from "./types";
export default class SentinelIterator implements Iterator<Partial<SentinelAddress>> {
private cursor;
private sentinels;
constructor(sentinels: Array<Partial<SentinelAddress>>);
next(): {
done: boolean;
value: Partial<SentinelAddress>;
};
reset(moveCurrentEndpointToFirst: boolean): void;
add(sentinel: SentinelAddress): boolean;
toString(): string;
}
landvex/node_modules/ioredis/built/connectors/SentinelConnector/SentinelIterator.js
Generated Vendored
+37
View File
@@ -0,0 +1,37 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
function isSentinelEql(a, b) {
return ((a.host || "127.0.0.1") === (b.host || "127.0.0.1") &&
(a.port || 26379) === (b.port || 26379));
}
class SentinelIterator {
constructor(sentinels) {
this.cursor = 0;
this.sentinels = sentinels.slice(0);
}
next() {
const done = this.cursor >= this.sentinels.length;
return { done, value: done ? undefined : this.sentinels[this.cursor++] };
}
reset(moveCurrentEndpointToFirst) {
if (moveCurrentEndpointToFirst &&
this.sentinels.length > 1 &&
this.cursor !== 1) {
this.sentinels.unshift(...this.sentinels.splice(this.cursor - 1));
}
this.cursor = 0;
}
add(sentinel) {
for (let i = 0; i < this.sentinels.length; i++) {
if (isSentinelEql(sentinel, this.sentinels[i])) {
return false;
}
}
this.sentinels.push(sentinel);
return true;
}
toString() {
return `${JSON.stringify(this.sentinels)} @${this.cursor}`;
}
}
exports.default = SentinelIterator;
landvex/node_modules/ioredis/built/connectors/SentinelConnector/index.d.ts
Generated Vendored
+72
View File
@@ -0,0 +1,72 @@
/// <reference types="node" />
import { EventEmitter } from "events";
import { NatMap } from "../../cluster/ClusterOptions";
import { ConnectionOptions } from "tls";
import SentinelIterator from "./SentinelIterator";
import { SentinelAddress } from "./types";
import AbstractConnector, { ErrorEmitter } from "../AbstractConnector";
import { NetStream } from "../../types";
interface AddressFromResponse {
port: string;
ip: string;
flags?: string | undefined;
}
declare type PreferredSlaves = ((slaves: AddressFromResponse[]) => AddressFromResponse | null) | Array<{
port: string;
ip: string;
prio?: number | undefined;
}> | {
port: string;
ip: string;
prio?: number | undefined;
};
export { SentinelAddress, SentinelIterator };
export interface SentinelConnectionOptions {
/**
* Master group name of the Sentinel
*/
name?: string | undefined;
/**
* @default "master"
*/
role?: "master" | "slave" | undefined;
tls?: ConnectionOptions | undefined;
sentinelUsername?: string | undefined;
sentinelPassword?: string | undefined;
sentinels?: Array<Partial<SentinelAddress>> | undefined;
sentinelRetryStrategy?: ((retryAttempts: number) => number | void | null) | undefined;
sentinelReconnectStrategy?: ((retryAttempts: number) => number | void | null) | undefined;
preferredSlaves?: PreferredSlaves | undefined;
connectTimeout?: number | undefined;
disconnectTimeout?: number | undefined;
sentinelCommandTimeout?: number | undefined;
enableTLSForSentinelMode?: boolean | undefined;
sentinelTLS?: ConnectionOptions | undefined;
natMap?: NatMap | undefined;
updateSentinels?: boolean | undefined;
/**
* @default 10
*/
sentinelMaxConnections?: number | undefined;
failoverDetector?: boolean | undefined;
}
export default class SentinelConnector extends AbstractConnector {
protected options: SentinelConnectionOptions;
emitter: EventEmitter | null;
protected sentinelIterator: SentinelIterator;
private retryAttempts;
private failoverDetector;
constructor(options: SentinelConnectionOptions);
check(info: {
role?: string;
}): boolean;
disconnect(): void;
connect(eventEmitter: ErrorEmitter): Promise<NetStream>;
private updateSentinels;
private resolveMaster;
private resolveSlave;
private sentinelNatResolve;
private connectToSentinel;
private resolve;
private initFailoverDetector;
}
landvex/node_modules/ioredis/built/connectors/SentinelConnector/index.js
Generated Vendored
+305
View File
@@ -0,0 +1,305 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SentinelIterator = void 0;
const net_1 = require("net");
const utils_1 = require("../../utils");
const tls_1 = require("tls");
const SentinelIterator_1 = require("./SentinelIterator");
exports.SentinelIterator = SentinelIterator_1.default;
const AbstractConnector_1 = require("../AbstractConnector");
const Redis_1 = require("../../Redis");
const FailoverDetector_1 = require("./FailoverDetector");
const debug = (0, utils_1.Debug)("SentinelConnector");
class SentinelConnector extends AbstractConnector_1.default {
constructor(options) {
super(options.disconnectTimeout);
this.options = options;
this.emitter = null;
this.failoverDetector = null;
if (!this.options.sentinels.length) {
throw new Error("Requires at least one sentinel to connect to.");
}
if (!this.options.name) {
throw new Error("Requires the name of master.");
}
this.sentinelIterator = new SentinelIterator_1.default(this.options.sentinels);
}
check(info) {
const roleMatches = !info.role || this.options.role === info.role;
if (!roleMatches) {
debug("role invalid, expected %s, but got %s", this.options.role, info.role);
// Start from the next item.
// Note that `reset` will move the cursor to the previous element,
// so we advance two steps here.
this.sentinelIterator.next();
this.sentinelIterator.next();
this.sentinelIterator.reset(true);
}
return roleMatches;
}
disconnect() {
super.disconnect();
if (this.failoverDetector) {
this.failoverDetector.cleanup();
}
}
connect(eventEmitter) {
this.connecting = true;
this.retryAttempts = 0;
let lastError;
const connectToNext = async () => {
const endpoint = this.sentinelIterator.next();
if (endpoint.done) {
this.sentinelIterator.reset(false);
const retryDelay = typeof this.options.sentinelRetryStrategy === "function"
? this.options.sentinelRetryStrategy(++this.retryAttempts)
: null;
let errorMsg = typeof retryDelay !== "number"
? "All sentinels are unreachable and retry is disabled."
: `All sentinels are unreachable. Retrying from scratch after ${retryDelay}ms.`;
if (lastError) {
errorMsg += ` Last error: ${lastError.message}`;
}
debug(errorMsg);
const error = new Error(errorMsg);
if (typeof retryDelay === "number") {
eventEmitter("error", error);
await new Promise((resolve) => setTimeout(resolve, retryDelay));
return connectToNext();
}
else {
throw error;
}
}
let resolved = null;
let err = null;
try {
resolved = await this.resolve(endpoint.value);
}
catch (error) {
err = error;
}
if (!this.connecting) {
throw new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG);
}
const endpointAddress = endpoint.value.host + ":" + endpoint.value.port;
if (resolved) {
debug("resolved: %s:%s from sentinel %s", resolved.host, resolved.port, endpointAddress);
if (this.options.enableTLSForSentinelMode && this.options.tls) {
Object.assign(resolved, this.options.tls);
this.stream = (0, tls_1.connect)(resolved);
this.stream.once("secureConnect", this.initFailoverDetector.bind(this));
}
else {
this.stream = (0, net_1.createConnection)(resolved);
this.stream.once("connect", this.initFailoverDetector.bind(this));
}
this.stream.once("error", (err) => {
this.firstError = err;
});
return this.stream;
}
else {
const errorMsg = err
? "failed to connect to sentinel " +
endpointAddress +
" because " +
err.message
: "connected to sentinel " +
endpointAddress +
" successfully, but got an invalid reply: " +
resolved;
debug(errorMsg);
eventEmitter("sentinelError", new Error(errorMsg));
if (err) {
lastError = err;
}
return connectToNext();
}
};
return connectToNext();
}
async updateSentinels(client) {
if (!this.options.updateSentinels) {
return;
}
const result = await client.sentinel("sentinels", this.options.name);
if (!Array.isArray(result)) {
return;
}
result
.map(utils_1.packObject)
.forEach((sentinel) => {
const flags = sentinel.flags ? sentinel.flags.split(",") : [];
if (flags.indexOf("disconnected") === -1 &&
sentinel.ip &&
sentinel.port) {
const endpoint = this.sentinelNatResolve(addressResponseToAddress(sentinel));
if (this.sentinelIterator.add(endpoint)) {
debug("adding sentinel %s:%s", endpoint.host, endpoint.port);
}
}
});
debug("Updated internal sentinels: %s", this.sentinelIterator);
}
async resolveMaster(client) {
const result = await client.sentinel("get-master-addr-by-name", this.options.name);
await this.updateSentinels(client);
return this.sentinelNatResolve(Array.isArray(result)
? { host: result[0], port: Number(result[1]) }
: null);
}
async resolveSlave(client) {
const result = await client.sentinel("slaves", this.options.name);
if (!Array.isArray(result)) {
return null;
}
const availableSlaves = result
.map(utils_1.packObject)
.filter((slave) => slave.flags && !slave.flags.match(/(disconnected|s_down|o_down)/));
return this.sentinelNatResolve(selectPreferredSentinel(availableSlaves, this.options.preferredSlaves));
}
sentinelNatResolve(item) {
if (!item || !this.options.natMap)
return item;
const key = `${item.host}:${item.port}`;
let result = item;
if (typeof this.options.natMap === "function") {
result = this.options.natMap(key) || item;
}
else if (typeof this.options.natMap === "object") {
result = this.options.natMap[key] || item;
}
return result;
}
connectToSentinel(endpoint, options) {
const redis = new Redis_1.default({
port: endpoint.port || 26379,
host: endpoint.host,
username: this.options.sentinelUsername || null,
password: this.options.sentinelPassword || null,
family: endpoint.family ||
// @ts-expect-error
("path" in this.options && this.options.path
? undefined
: // @ts-expect-error
this.options.family),
tls: this.options.sentinelTLS,
retryStrategy: null,
enableReadyCheck: false,
connectTimeout: this.options.connectTimeout,
commandTimeout: this.options.sentinelCommandTimeout,
...options,
});
// @ts-expect-error
return redis;
}
async resolve(endpoint) {
const client = this.connectToSentinel(endpoint);
// ignore the errors since resolve* methods will handle them
client.on("error", noop);
try {
if (this.options.role === "slave") {
return await this.resolveSlave(client);
}
else {
return await this.resolveMaster(client);
}
}
finally {
client.disconnect();
}
}
async initFailoverDetector() {
var _a;
if (!this.options.failoverDetector) {
return;
}
// Move the current sentinel to the first position
this.sentinelIterator.reset(true);
const sentinels = [];
// In case of a large amount of sentinels, limit the number of concurrent connections
while (sentinels.length < this.options.sentinelMaxConnections) {
const { done, value } = this.sentinelIterator.next();
if (done) {
break;
}
const client = this.connectToSentinel(value, {
lazyConnect: true,
retryStrategy: this.options.sentinelReconnectStrategy,
});
client.on("reconnecting", () => {
var _a;
// Tests listen to this event
(_a = this.emitter) === null || _a === void 0 ? void 0 : _a.emit("sentinelReconnecting");
});
sentinels.push({ address: value, client });
}
this.sentinelIterator.reset(false);
if (this.failoverDetector) {
// Clean up previous detector
this.failoverDetector.cleanup();
}
this.failoverDetector = new FailoverDetector_1.FailoverDetector(this, sentinels);
await this.failoverDetector.subscribe();
// Tests listen to this event
(_a = this.emitter) === null || _a === void 0 ? void 0 : _a.emit("failoverSubscribed");
}
}
exports.default = SentinelConnector;
function selectPreferredSentinel(availableSlaves, preferredSlaves) {
if (availableSlaves.length === 0) {
return null;
}
let selectedSlave;
if (typeof preferredSlaves === "function") {
selectedSlave = preferredSlaves(availableSlaves);
}
else if (preferredSlaves !== null && typeof preferredSlaves === "object") {
const preferredSlavesArray = Array.isArray(preferredSlaves)
? preferredSlaves
: [preferredSlaves];
// sort by priority
preferredSlavesArray.sort((a, b) => {
// default the priority to 1
if (!a.prio) {
a.prio = 1;
}
if (!b.prio) {
b.prio = 1;
}
// lowest priority first
if (a.prio < b.prio) {
return -1;
}
if (a.prio > b.prio) {
return 1;
}
return 0;
});
// loop over preferred slaves and return the first match
for (let p = 0; p < preferredSlavesArray.length; p++) {
for (let a = 0; a < availableSlaves.length; a++) {
const slave = availableSlaves[a];
if (slave.ip === preferredSlavesArray[p].ip) {
if (slave.port === preferredSlavesArray[p].port) {
selectedSlave = slave;
break;
}
}
}
if (selectedSlave) {
break;
}
}
}
// if none of the preferred slaves are available, a random available slave is returned
if (!selectedSlave) {
selectedSlave = (0, utils_1.sample)(availableSlaves);
}
return addressResponseToAddress(selectedSlave);
}
function addressResponseToAddress(input) {
return { host: input.ip, port: Number(input.port) };
}
function noop() { }
landvex/node_modules/ioredis/built/connectors/SentinelConnector/types.d.ts
Generated Vendored
+21
View File
@@ -0,0 +1,21 @@
import { RedisOptions } from "../../redis/RedisOptions";
export interface SentinelAddress {
port: number;
host: string;
family?: number;
}
export interface RedisClient {
options: RedisOptions;
sentinel(subcommand: "sentinels", name: string): Promise<string[]>;
sentinel(subcommand: "get-master-addr-by-name", name: string): Promise<string[]>;
sentinel(subcommand: "slaves", name: string): Promise<string[]>;
subscribe(...channelNames: string[]): Promise<number>;
on(event: "message", callback: (channel: string, message: string) => void): void;
on(event: "error", callback: (error: Error) => void): void;
on(event: "reconnecting", callback: () => void): void;
disconnect(): void;
}
export interface Sentinel {
address: Partial<SentinelAddress>;
client: RedisClient;
}
landvex/node_modules/ioredis/built/connectors/SentinelConnector/types.js
Generated Vendored
+2
View File
@@ -0,0 +1,2 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
landvex/node_modules/ioredis/built/connectors/StandaloneConnector.d.ts
Generated Vendored
+17
View File
@@ -0,0 +1,17 @@
/// <reference types="node" />
import { IpcNetConnectOpts, TcpNetConnectOpts } from "net";
import { ConnectionOptions } from "tls";
import { NetStream } from "../types";
import AbstractConnector, { ErrorEmitter } from "./AbstractConnector";
declare type TcpOptions = Pick<TcpNetConnectOpts, "port" | "host" | "family">;
declare type IpcOptions = Pick<IpcNetConnectOpts, "path">;
export declare type StandaloneConnectionOptions = Partial<TcpOptions & IpcOptions> & {
disconnectTimeout?: number | undefined;
tls?: ConnectionOptions | undefined;
};
export default class StandaloneConnector extends AbstractConnector {
protected options: StandaloneConnectionOptions;
constructor(options: StandaloneConnectionOptions);
connect(_: ErrorEmitter): Promise<NetStream>;
}
export {};
landvex/node_modules/ioredis/built/connectors/StandaloneConnector.js
Generated Vendored
+69
View File
@@ -0,0 +1,69 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const net_1 = require("net");
const tls_1 = require("tls");
const utils_1 = require("../utils");
const AbstractConnector_1 = require("./AbstractConnector");
class StandaloneConnector extends AbstractConnector_1.default {
constructor(options) {
super(options.disconnectTimeout);
this.options = options;
}
connect(_) {
const { options } = this;
this.connecting = true;
let connectionOptions;
if ("path" in options && options.path) {
connectionOptions = {
path: options.path,
};
}
else {
connectionOptions = {};
if ("port" in options && options.port != null) {
connectionOptions.port = options.port;
}
if ("host" in options && options.host != null) {
connectionOptions.host = options.host;
}
if ("family" in options && options.family != null) {
connectionOptions.family = options.family;
}
}
if (options.tls) {
Object.assign(connectionOptions, options.tls);
}
// TODO:
// We use native Promise here since other Promise
// implementation may use different schedulers that
// cause issue when the stream is resolved in the
// next tick.
// Should use the provided promise in the next major
// version and do not connect before resolved.
return new Promise((resolve, reject) => {
process.nextTick(() => {
if (!this.connecting) {
reject(new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG));
return;
}
try {
if (options.tls) {
this.stream = (0, tls_1.connect)(connectionOptions);
}
else {
this.stream = (0, net_1.createConnection)(connectionOptions);
}
}
catch (err) {
reject(err);
return;
}
this.stream.once("error", (err) => {
this.firstError = err;
});
resolve(this.stream);
});
});
}
}
exports.default = StandaloneConnector;
landvex/node_modules/ioredis/built/connectors/index.d.ts
Generated Vendored
+3
View File
@@ -0,0 +1,3 @@
import StandaloneConnector from "./StandaloneConnector";
import SentinelConnector from "./SentinelConnector";
export { StandaloneConnector, SentinelConnector };
landvex/node_modules/ioredis/built/connectors/index.js
Generated Vendored
+7
View File
@@ -0,0 +1,7 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.SentinelConnector = exports.StandaloneConnector = void 0;
const StandaloneConnector_1 = require("./StandaloneConnector");
exports.StandaloneConnector = StandaloneConnector_1.default;
const SentinelConnector_1 = require("./SentinelConnector");
exports.SentinelConnector = SentinelConnector_1.default;
landvex/node_modules/ioredis/built/constants/TLSProfiles.d.ts
Generated Vendored
+9
View File
File diff suppressed because one or more lines are too long
landvex/node_modules/ioredis/built/constants/TLSProfiles.js
Generated Vendored
+149
View File
@@ -0,0 +1,149 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
/**
* TLS settings for Redis Cloud. Updated on 2022-08-19.
*/
const RedisCloudCA = `-----BEGIN CERTIFICATE-----
MIIDTzCCAjegAwIBAgIJAKSVpiDswLcwMA0GCSqGSIb3DQEBBQUAMD4xFjAUBgNV
BAoMDUdhcmFudGlhIERhdGExJDAiBgNVBAMMG1NTTCBDZXJ0aWZpY2F0aW9uIEF1
dGhvcml0eTAeFw0xMzEwMDExMjE0NTVaFw0yMzA5MjkxMjE0NTVaMD4xFjAUBgNV
BAoMDUdhcmFudGlhIERhdGExJDAiBgNVBAMMG1NTTCBDZXJ0aWZpY2F0aW9uIEF1
dGhvcml0eTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALZqkh/DczWP
JnxnHLQ7QL0T4B4CDKWBKCcisriGbA6ZePWVNo4hfKQC6JrzfR+081NeD6VcWUiz
rmd+jtPhIY4c+WVQYm5PKaN6DT1imYdxQw7aqO5j2KUCEh/cznpLxeSHoTxlR34E
QwF28Wl3eg2vc5ct8LjU3eozWVk3gb7alx9mSA2SgmuX5lEQawl++rSjsBStemY2
BDwOpAMXIrdEyP/cVn8mkvi/BDs5M5G+09j0gfhyCzRWMQ7Hn71u1eolRxwVxgi3
TMn+/vTaFSqxKjgck6zuAYjBRPaHe7qLxHNr1So/Mc9nPy+3wHebFwbIcnUojwbp
4nctkWbjb2cCAwEAAaNQME4wHQYDVR0OBBYEFP1whtcrydmW3ZJeuSoKZIKjze3w
MB8GA1UdIwQYMBaAFP1whtcrydmW3ZJeuSoKZIKjze3wMAwGA1UdEwQFMAMBAf8w
DQYJKoZIhvcNAQEFBQADggEBAG2erXhwRAa7+ZOBs0B6X57Hwyd1R4kfmXcs0rta
lbPpvgULSiB+TCbf3EbhJnHGyvdCY1tvlffLjdA7HJ0PCOn+YYLBA0pTU/dyvrN6
Su8NuS5yubnt9mb13nDGYo1rnt0YRfxN+8DM3fXIVr038A30UlPX2Ou1ExFJT0MZ
uFKY6ZvLdI6/1cbgmguMlAhM+DhKyV6Sr5699LM3zqeI816pZmlREETYkGr91q7k
BpXJu/dtHaGxg1ZGu6w/PCsYGUcECWENYD4VQPd8N32JjOfu6vEgoEAwfPP+3oGp
Z4m3ewACcWOAenqflb+cQYC4PsF7qbXDmRaWrbKntOlZ3n0=
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIGMTCCBBmgAwIBAgICEAAwDQYJKoZIhvcNAQELBQAwajELMAkGA1UEBhMCVVMx
CzAJBgNVBAgMAkNBMQswCQYDVQQHDAJDQTESMBAGA1UECgwJUmVkaXNMYWJzMS0w
KwYDVQQDDCRSZWRpc0xhYnMgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwHhcN
MTgwMjI1MTUzNzM3WhcNMjgwMjIzMTUzNzM3WjBfMQswCQYDVQQGEwJVUzELMAkG
A1UECAwCQ0ExEjAQBgNVBAoMCVJlZGlzTGFiczEvMC0GA1UEAwwmUkNQIEludGVy
bWVkaWF0ZSBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkwggIiMA0GCSqGSIb3DQEBAQUA
A4ICDwAwggIKAoICAQDf9dqbxc8Bq7Ctq9rWcxrGNKKHivqLAFpPq02yLPx6fsOv
Tq7GsDChAYBBc4v7Y2Ap9RD5Vs3dIhEANcnolf27QwrG9RMnnvzk8pCvp1o6zSU4
VuOE1W66/O1/7e2rVxyrnTcP7UgK43zNIXu7+tiAqWsO92uSnuMoGPGpeaUm1jym
hjWKtkAwDFSqvHY+XL5qDVBEjeUe+WHkYUg40cAXjusAqgm2hZt29c2wnVrxW25W
P0meNlzHGFdA2AC5z54iRiqj57dTfBTkHoBczQxcyw6hhzxZQ4e5I5zOKjXXEhZN
r0tA3YC14CTabKRus/JmZieyZzRgEy2oti64tmLYTqSlAD78pRL40VNoaSYetXLw
hhNsXCHgWaY6d5bLOc/aIQMAV5oLvZQKvuXAF1IDmhPA+bZbpWipp0zagf1P1H3s
UzsMdn2KM0ejzgotbtNlj5TcrVwpmvE3ktvUAuA+hi3FkVx1US+2Gsp5x4YOzJ7u
P1WPk6ShF0JgnJH2ILdj6kttTWwFzH17keSFICWDfH/+kM+k7Y1v3EXMQXE7y0T9
MjvJskz6d/nv+sQhY04xt64xFMGTnZjlJMzfQNi7zWFLTZnDD0lPowq7l3YiPoTT
t5Xky83lu0KZsZBo0WlWaDG00gLVdtRgVbcuSWxpi5BdLb1kRab66JptWjxwXQID
AQABo4HrMIHoMDoGA1UdHwQzMDEwL6AtoCuGKWh0dHBzOi8vcmwtY2Etc2VydmVy
LnJlZGlzbGFicy5jb20vdjEvY3JsMEYGCCsGAQUFBwEBBDowODA2BggrBgEFBQcw
AYYqaHR0cHM6Ly9ybC1jYS1zZXJ2ZXIucmVkaXNsYWJzLmNvbS92MS9vY3NwMB0G
A1UdDgQWBBQHar5OKvQUpP2qWt6mckzToeCOHDAfBgNVHSMEGDAWgBQi42wH6hM4
L2sujEvLM0/u8lRXTzASBgNVHRMBAf8ECDAGAQH/AgEAMA4GA1UdDwEB/wQEAwIB
hjANBgkqhkiG9w0BAQsFAAOCAgEAirEn/iTsAKyhd+pu2W3Z5NjCko4NPU0EYUbr
AP7+POK2rzjIrJO3nFYQ/LLuC7KCXG+2qwan2SAOGmqWst13Y+WHp44Kae0kaChW
vcYLXXSoGQGC8QuFSNUdaeg3RbMDYFT04dOkqufeWVccoHVxyTSg9eD8LZuHn5jw
7QDLiEECBmIJHk5Eeo2TAZrx4Yx6ufSUX5HeVjlAzqwtAqdt99uCJ/EL8bgpWbe+
XoSpvUv0SEC1I1dCAhCKAvRlIOA6VBcmzg5Am12KzkqTul12/VEFIgzqu0Zy2Jbc
AUPrYVu/+tOGXQaijy7YgwH8P8n3s7ZeUa1VABJHcxrxYduDDJBLZi+MjheUDaZ1
jQRHYevI2tlqeSBqdPKG4zBY5lS0GiAlmuze5oENt0P3XboHoZPHiqcK3VECgTVh
/BkJcuudETSJcZDmQ8YfoKfBzRQNg2sv/hwvUv73Ss51Sco8GEt2lD8uEdib1Q6z
zDT5lXJowSzOD5ZA9OGDjnSRL+2riNtKWKEqvtEG3VBJoBzu9GoxbAc7wIZLxmli
iF5a/Zf5X+UXD3s4TMmy6C4QZJpAA2egsSQCnraWO2ULhh7iXMysSkF/nzVfZn43
iqpaB8++9a37hWq14ZmOv0TJIDz//b2+KC4VFXWQ5W5QC6whsjT+OlG4p5ZYG0jo
616pxqo=
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIFujCCA6KgAwIBAgIJAJ1aTT1lu2ScMA0GCSqGSIb3DQEBCwUAMGoxCzAJBgNV
BAYTAlVTMQswCQYDVQQIDAJDQTELMAkGA1UEBwwCQ0ExEjAQBgNVBAoMCVJlZGlz
TGFiczEtMCsGA1UEAwwkUmVkaXNMYWJzIFJvb3QgQ2VydGlmaWNhdGUgQXV0aG9y
aXR5MB4XDTE4MDIyNTE1MjA0MloXDTM4MDIyMDE1MjA0MlowajELMAkGA1UEBhMC
VVMxCzAJBgNVBAgMAkNBMQswCQYDVQQHDAJDQTESMBAGA1UECgwJUmVkaXNMYWJz
MS0wKwYDVQQDDCRSZWRpc0xhYnMgUm9vdCBDZXJ0aWZpY2F0ZSBBdXRob3JpdHkw
ggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQDLEjXy7YrbN5Waau5cd6g1
G5C2tMmeTpZ0duFAPxNU4oE3RHS5gGiok346fUXuUxbZ6QkuzeN2/2Z+RmRcJhQY
Dm0ZgdG4x59An1TJfnzKKoWj8ISmoHS/TGNBdFzXV7FYNLBuqZouqePI6ReC6Qhl
pp45huV32Q3a6IDrrvx7Wo5ZczEQeFNbCeCOQYNDdTmCyEkHqc2AGo8eoIlSTutT
ULOC7R5gzJVTS0e1hesQ7jmqHjbO+VQS1NAL4/5K6cuTEqUl+XhVhPdLWBXJQ5ag
54qhX4v+ojLzeU1R/Vc6NjMvVtptWY6JihpgplprN0Yh2556ewcXMeturcKgXfGJ
xeYzsjzXerEjrVocX5V8BNrg64NlifzTMKNOOv4fVZszq1SIHR8F9ROrqiOdh8iC
JpUbLpXH9hWCSEO6VRMB2xJoKu3cgl63kF30s77x7wLFMEHiwsQRKxooE1UhgS9K
2sO4TlQ1eWUvFvHSTVDQDlGQ6zu4qjbOpb3Q8bQwoK+ai2alkXVR4Ltxe9QlgYK3
StsnPhruzZGA0wbXdpw0bnM+YdlEm5ffSTpNIfgHeaa7Dtb801FtA71ZlH7A6TaI
SIQuUST9EKmv7xrJyx0W1pGoPOLw5T029aTjnICSLdtV9bLwysrLhIYG5bnPq78B
cS+jZHFGzD7PUVGQD01nOQIDAQABo2MwYTAdBgNVHQ4EFgQUIuNsB+oTOC9rLoxL
yzNP7vJUV08wHwYDVR0jBBgwFoAUIuNsB+oTOC9rLoxLyzNP7vJUV08wDwYDVR0T
AQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMCAYYwDQYJKoZIhvcNAQELBQADggIBAHfg
z5pMNUAKdMzK1aS1EDdK9yKz4qicILz5czSLj1mC7HKDRy8cVADUxEICis++CsCu
rYOvyCVergHQLREcxPq4rc5Nq1uj6J6649NEeh4WazOOjL4ZfQ1jVznMbGy+fJm3
3Hoelv6jWRG9iqeJZja7/1s6YC6bWymI/OY1e4wUKeNHAo+Vger7MlHV+RuabaX+
hSJ8bJAM59NCM7AgMTQpJCncrcdLeceYniGy5Q/qt2b5mJkQVkIdy4TPGGB+AXDJ
D0q3I/JDRkDUFNFdeW0js7fHdsvCR7O3tJy5zIgEV/o/BCkmJVtuwPYOrw/yOlKj
TY/U7ATAx9VFF6/vYEOMYSmrZlFX+98L6nJtwDqfLB5VTltqZ4H/KBxGE3IRSt9l
FXy40U+LnXzhhW+7VBAvyYX8GEXhHkKU8Gqk1xitrqfBXY74xKgyUSTolFSfFVgj
mcM/X4K45bka+qpkj7Kfv/8D4j6aZekwhN2ly6hhC1SmQ8qjMjpG/mrWOSSHZFmf
ybu9iD2AYHeIOkshIl6xYIa++Q/00/vs46IzAbQyriOi0XxlSMMVtPx0Q3isp+ji
n8Mq9eOuxYOEQ4of8twUkUDd528iwGtEdwf0Q01UyT84S62N8AySl1ZBKXJz6W4F
UhWfa/HQYOAPDdEjNgnVwLI23b8t0TozyCWw7q8h
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIEjzCCA3egAwIBAgIQe55B/ALCKJDZtdNT8kD6hTANBgkqhkiG9w0BAQsFADBM
MSAwHgYDVQQLExdHbG9iYWxTaWduIFJvb3QgQ0EgLSBSMzETMBEGA1UEChMKR2xv
YmFsU2lnbjETMBEGA1UEAxMKR2xvYmFsU2lnbjAeFw0yMjAxMjYxMjAwMDBaFw0y
NTAxMjYwMDAwMDBaMFgxCzAJBgNVBAYTAkJFMRkwFwYDVQQKExBHbG9iYWxTaWdu
IG52LXNhMS4wLAYDVQQDEyVHbG9iYWxTaWduIEF0bGFzIFIzIE9WIFRMUyBDQSAy
MDIyIFEyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAmGmg1LW9b7Lf
8zDD83yBDTEkt+FOxKJZqF4veWc5KZsQj9HfnUS2e5nj/E+JImlGPsQuoiosLuXD
BVBNAMcUFa11buFMGMeEMwiTmCXoXRrXQmH0qjpOfKgYc5gHG3BsRGaRrf7VR4eg
ofNMG9wUBw4/g/TT7+bQJdA4NfE7Y4d5gEryZiBGB/swaX6Jp/8MF4TgUmOWmalK
dZCKyb4sPGQFRTtElk67F7vU+wdGcrcOx1tDcIB0ncjLPMnaFicagl+daWGsKqTh
counQb6QJtYHa91KvCfKWocMxQ7OIbB5UARLPmC4CJ1/f8YFm35ebfzAeULYdGXu
jE9CLor0OwIDAQABo4IBXzCCAVswDgYDVR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQG
CCsGAQUFBwMBBggrBgEFBQcDAjASBgNVHRMBAf8ECDAGAQH/AgEAMB0GA1UdDgQW
BBSH5Zq7a7B/t95GfJWkDBpA8HHqdjAfBgNVHSMEGDAWgBSP8Et/qC5FJK5NUPpj
move4t0bvDB7BggrBgEFBQcBAQRvMG0wLgYIKwYBBQUHMAGGImh0dHA6Ly9vY3Nw
Mi5nbG9iYWxzaWduLmNvbS9yb290cjMwOwYIKwYBBQUHMAKGL2h0dHA6Ly9zZWN1
cmUuZ2xvYmFsc2lnbi5jb20vY2FjZXJ0L3Jvb3QtcjMuY3J0MDYGA1UdHwQvMC0w
K6ApoCeGJWh0dHA6Ly9jcmwuZ2xvYmFsc2lnbi5jb20vcm9vdC1yMy5jcmwwIQYD
VR0gBBowGDAIBgZngQwBAgIwDAYKKwYBBAGgMgoBAjANBgkqhkiG9w0BAQsFAAOC
AQEAKRic9/f+nmhQU/wz04APZLjgG5OgsuUOyUEZjKVhNGDwxGTvKhyXGGAMW2B/
3bRi+aElpXwoxu3pL6fkElbX3B0BeS5LoDtxkyiVEBMZ8m+sXbocwlPyxrPbX6mY
0rVIvnuUeBH8X0L5IwfpNVvKnBIilTbcebfHyXkPezGwz7E1yhUULjJFm2bt0SdX
y+4X/WeiiYIv+fTVgZZgl+/2MKIsu/qdBJc3f3TvJ8nz+Eax1zgZmww+RSQWeOj3
15Iw6Z5FX+NwzY/Ab+9PosR5UosSeq+9HhtaxZttXG1nVh+avYPGYddWmiMT90J5
ZgKnO/Fx2hBgTxhOTMYaD312kg==
-----END CERTIFICATE-----
-----BEGIN CERTIFICATE-----
MIIDXzCCAkegAwIBAgILBAAAAAABIVhTCKIwDQYJKoZIhvcNAQELBQAwTDEgMB4G
A1UECxMXR2xvYmFsU2lnbiBSb290IENBIC0gUjMxEzARBgNVBAoTCkdsb2JhbFNp
Z24xEzARBgNVBAMTCkdsb2JhbFNpZ24wHhcNMDkwMzE4MTAwMDAwWhcNMjkwMzE4
MTAwMDAwWjBMMSAwHgYDVQQLExdHbG9iYWxTaWduIFJvb3QgQ0EgLSBSMzETMBEG
A1UEChMKR2xvYmFsU2lnbjETMBEGA1UEAxMKR2xvYmFsU2lnbjCCASIwDQYJKoZI
hvcNAQEBBQADggEPADCCAQoCggEBAMwldpB5BngiFvXAg7aEyiie/QV2EcWtiHL8
RgJDx7KKnQRfJMsuS+FggkbhUqsMgUdwbN1k0ev1LKMPgj0MK66X17YUhhB5uzsT
gHeMCOFJ0mpiLx9e+pZo34knlTifBtc+ycsmWQ1z3rDI6SYOgxXG71uL0gRgykmm
KPZpO/bLyCiR5Z2KYVc3rHQU3HTgOu5yLy6c+9C7v/U9AOEGM+iCK65TpjoWc4zd
QQ4gOsC0p6Hpsk+QLjJg6VfLuQSSaGjlOCZgdbKfd/+RFO+uIEn8rUAVSNECMWEZ
XriX7613t2Saer9fwRPvm2L7DWzgVGkWqQPabumDk3F2xmmFghcCAwEAAaNCMEAw
DgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFI/wS3+o
LkUkrk1Q+mOai97i3Ru8MA0GCSqGSIb3DQEBCwUAA4IBAQBLQNvAUKr+yAzv95ZU
RUm7lgAJQayzE4aGKAczymvmdLm6AC2upArT9fHxD4q/c2dKg8dEe3jgr25sbwMp
jjM5RcOO5LlXbKr8EpbsU8Yt5CRsuZRj+9xTaGdWPoO4zzUhw8lo/s7awlOqzJCK
6fBdRoyV3XpYKBovHd7NADdBj+1EbddTKJd+82cEHhXXipa0095MJ6RMG3NzdvQX
mcIfeg7jLQitChws/zyrVQ4PkX4268NXSb7hLi18YIvDQVETI53O9zJrlAGomecs
Mx86OyXShkDOOyyGeMlhLxS67ttVb9+E7gUJTb0o2HLO02JQZR7rkpeDMdmztcpH
WD9f
-----END CERTIFICATE-----`;
const TLSProfiles = {
RedisCloudFixed: { ca: RedisCloudCA },
RedisCloudFlexible: { ca: RedisCloudCA },
};
exports.default = TLSProfiles;
landvex/node_modules/ioredis/built/errors/ClusterAllFailedError.d.ts
Generated Vendored
+7
View File
@@ -0,0 +1,7 @@
import { RedisError } from "redis-errors";
export default class ClusterAllFailedError extends RedisError {
lastNodeError: RedisError;
static defaultMessage: string;
constructor(message: any, lastNodeError: RedisError);
get name(): string;
}
landvex/node_modules/ioredis/built/errors/ClusterAllFailedError.js
Generated Vendored
+15
View File
@@ -0,0 +1,15 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const redis_errors_1 = require("redis-errors");
class ClusterAllFailedError extends redis_errors_1.RedisError {
constructor(message, lastNodeError) {
super(message);
this.lastNodeError = lastNodeError;
Error.captureStackTrace(this, this.constructor);
}
get name() {
return this.constructor.name;
}
}
exports.default = ClusterAllFailedError;
ClusterAllFailedError.defaultMessage = "Failed to refresh slots cache.";
landvex/node_modules/ioredis/built/errors/MaxRetriesPerRequestError.d.ts
Generated Vendored
+5
View File
@@ -0,0 +1,5 @@
import { AbortError } from "redis-errors";
export default class MaxRetriesPerRequestError extends AbortError {
constructor(maxRetriesPerRequest: number);
get name(): string;
}
landvex/node_modules/ioredis/built/errors/MaxRetriesPerRequestError.js
Generated Vendored
+14
View File
@@ -0,0 +1,14 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const redis_errors_1 = require("redis-errors");
class MaxRetriesPerRequestError extends redis_errors_1.AbortError {
constructor(maxRetriesPerRequest) {
const message = `Reached the max retries per request limit (which is ${maxRetriesPerRequest}). Refer to "maxRetriesPerRequest" option for details.`;
super(message);
Error.captureStackTrace(this, this.constructor);
}
get name() {
return this.constructor.name;
}
}
exports.default = MaxRetriesPerRequestError;
landvex/node_modules/ioredis/built/errors/index.d.ts
Generated Vendored
+2
View File
@@ -0,0 +1,2 @@
import MaxRetriesPerRequestError from "./MaxRetriesPerRequestError";
export { MaxRetriesPerRequestError };
landvex/node_modules/ioredis/built/errors/index.js
Generated Vendored
+5
View File
@@ -0,0 +1,5 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.MaxRetriesPerRequestError = void 0;
const MaxRetriesPerRequestError_1 = require("./MaxRetriesPerRequestError");
exports.MaxRetriesPerRequestError = MaxRetriesPerRequestError_1.default;
landvex/node_modules/ioredis/built/index.d.ts
Generated Vendored
+44
View File
@@ -0,0 +1,44 @@
export { default } from "./Redis";
export { default as Redis } from "./Redis";
export { default as Cluster } from "./cluster";
/**
* @ignore
*/
export { default as Command } from "./Command";
/**
* @ignore
*/
export { default as RedisCommander, Result, ClientContext, } from "./utils/RedisCommander";
/**
* @ignore
*/
export { default as ScanStream } from "./ScanStream";
/**
* @ignore
*/
export { default as Pipeline } from "./Pipeline";
/**
* @ignore
*/
export { default as AbstractConnector } from "./connectors/AbstractConnector";
/**
* @ignore
*/
export { default as SentinelConnector, SentinelIterator, } from "./connectors/SentinelConnector";
/**
* @ignore
*/
export { Callback } from "./types";
export { SentinelAddress, SentinelConnectionOptions, } from "./connectors/SentinelConnector";
export { StandaloneConnectionOptions } from "./connectors/StandaloneConnector";
export { RedisOptions, CommonRedisOptions } from "./redis/RedisOptions";
export { ClusterNode } from "./cluster";
export { ClusterOptions, DNSLookupFunction, DNSResolveSrvFunction, NatMap, } from "./cluster/ClusterOptions";
export { NodeRole } from "./cluster/util";
export type { RedisKey, RedisValue, ChainableCommander, } from "./utils/RedisCommander";
export type { CommandTraceContext, BatchOperationContext, ConnectTraceContext, } from "./tracing";
export declare const ReplyError: any;
/**
* @ignore
*/
export declare function print(err: Error | null, reply?: any): void;
landvex/node_modules/ioredis/built/index.js
Generated Vendored
+62
View File
@@ -0,0 +1,62 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.print = exports.ReplyError = exports.SentinelIterator = exports.SentinelConnector = exports.AbstractConnector = exports.Pipeline = exports.ScanStream = exports.Command = exports.Cluster = exports.Redis = exports.default = void 0;
exports = module.exports = require("./Redis").default;
var Redis_1 = require("./Redis");
Object.defineProperty(exports, "default", { enumerable: true, get: function () { return Redis_1.default; } });
var Redis_2 = require("./Redis");
Object.defineProperty(exports, "Redis", { enumerable: true, get: function () { return Redis_2.default; } });
var cluster_1 = require("./cluster");
Object.defineProperty(exports, "Cluster", { enumerable: true, get: function () { return cluster_1.default; } });
/**
* @ignore
*/
var Command_1 = require("./Command");
Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return Command_1.default; } });
/**
* @ignore
*/
var ScanStream_1 = require("./ScanStream");
Object.defineProperty(exports, "ScanStream", { enumerable: true, get: function () { return ScanStream_1.default; } });
/**
* @ignore
*/
var Pipeline_1 = require("./Pipeline");
Object.defineProperty(exports, "Pipeline", { enumerable: true, get: function () { return Pipeline_1.default; } });
/**
* @ignore
*/
var AbstractConnector_1 = require("./connectors/AbstractConnector");
Object.defineProperty(exports, "AbstractConnector", { enumerable: true, get: function () { return AbstractConnector_1.default; } });
/**
* @ignore
*/
var SentinelConnector_1 = require("./connectors/SentinelConnector");
Object.defineProperty(exports, "SentinelConnector", { enumerable: true, get: function () { return SentinelConnector_1.default; } });
Object.defineProperty(exports, "SentinelIterator", { enumerable: true, get: function () { return SentinelConnector_1.SentinelIterator; } });
// No TS typings
exports.ReplyError = require("redis-errors").ReplyError;
/**
* @ignore
*/
Object.defineProperty(exports, "Promise", {
get() {
console.warn("ioredis v5 does not support plugging third-party Promise library anymore. Native Promise will be used.");
return Promise;
},
set(_lib) {
console.warn("ioredis v5 does not support plugging third-party Promise library anymore. Native Promise will be used.");
},
});
/**
* @ignore
*/
function print(err, reply) {
if (err) {
console.log("Error: " + err);
}
else {
console.log("Reply: " + reply);
}
}
exports.print = print;
landvex/node_modules/ioredis/built/redis/RedisOptions.d.ts
Generated Vendored
+198
View File
@@ -0,0 +1,198 @@
import { CommanderOptions } from "../utils/Commander";
import ConnectorConstructor from "../connectors/ConnectorConstructor";
import { SentinelConnectionOptions } from "../connectors/SentinelConnector";
import { StandaloneConnectionOptions } from "../connectors/StandaloneConnector";
export declare type ReconnectOnError = (err: Error) => boolean | 1 | 2;
export declare type RetryStrategy = ((times: number) => number | void | null) | null | undefined;
export interface CommonRedisOptions extends CommanderOptions {
Connector?: ConnectorConstructor | undefined;
retryStrategy?: RetryStrategy;
/**
* If a command does not return a reply within a set number of milliseconds,
* a "Command timed out" error will be thrown.
*/
commandTimeout?: number | undefined;
/**
* Enables client-side timeout protection for blocking commands when set
* to a positive number. If `blockingTimeout` is undefined, `0`, or
* negative (e.g. `-1`), the protection is disabled and no client-side
* timers are installed for blocking commands.
*/
blockingTimeout?: number | undefined;
/**
* Grace period (ms) added to blocking command timeouts. Only used when
* `blockingTimeout` is a positive number. Defaults to 100ms.
*/
blockingTimeoutGrace?: number | undefined;
/**
* If the socket does not receive data within a set number of milliseconds:
* 1. the socket is considered "dead" and will be destroyed
* 2. the client will reject any running commands (altought they might have been processed by the server)
* 3. the reconnect strategy will kick in (depending on the configuration)
*/
socketTimeout?: number | undefined;
/**
* Enable/disable keep-alive functionality.
* @link https://nodejs.org/api/net.html#socketsetkeepaliveenable-initialdelay
* @default 0
*/
keepAlive?: number | undefined;
/**
* Enable/disable the use of Nagle's algorithm.
* @link https://nodejs.org/api/net.html#socketsetnodelaynodelay
* @default true
*/
noDelay?: boolean | undefined;
/**
* Set the name of the connection to make it easier to identity the connection
* in client list.
* @link https://redis.io/commands/client-setname
*/
connectionName?: string | undefined;
/**
* If true, skips setting library info via CLIENT SETINFO.
* @link https://redis.io/docs/latest/commands/client-setinfo/
* @default false
*/
disableClientInfo?: boolean | undefined;
/**
* Tag to append to the library name in CLIENT SETINFO (ioredis(tag)).
* @link https://redis.io/docs/latest/commands/client-setinfo/
* @default undefined
*/
clientInfoTag?: string | undefined;
/**
* If set, client will send AUTH command with the value of this option as the first argument when connected.
* This is supported since Redis 6.
*/
username?: string | undefined;
/**
* If set, client will send AUTH command with the value of this option when connected.
*/
password?: string | undefined;
/**
* Database index to use.
*
* @default 0
*/
db?: number | undefined;
/**
* When the client reconnects, channels subscribed in the previous connection will be
* resubscribed automatically if `autoResubscribe` is `true`.
* @default true
*/
autoResubscribe?: boolean | undefined;
/**
* Whether or not to resend unfulfilled commands on reconnect.
* Unfulfilled commands are most likely to be blocking commands such as `brpop` or `blpop`.
* @default true
*/
autoResendUnfulfilledCommands?: boolean | undefined;
/**
* Whether or not to reconnect on certain Redis errors.
* This options by default is `null`, which means it should never reconnect on Redis errors.
* You can pass a function that accepts an Redis error, and returns:
* - `true` or `1` to trigger a reconnection.
* - `false` or `0` to not reconnect.
* - `2` to reconnect and resend the failed command (who triggered the error) after reconnection.
* @example
* ```js
* const redis = new Redis({
* reconnectOnError(err) {
* const targetError = "READONLY";
* if (err.message.includes(targetError)) {
* // Only reconnect when the error contains "READONLY"
* return true; // or `return 1;`
* }
* },
* });
* ```
* @default null
*/
reconnectOnError?: ReconnectOnError | null | undefined;
/**
* @default false
*/
readOnly?: boolean | undefined;
/**
* When enabled, numbers returned by Redis will be converted to JavaScript strings instead of numbers.
* This is necessary if you want to handle big numbers (above `Number.MAX_SAFE_INTEGER` === 2^53).
* @default false
*/
stringNumbers?: boolean | undefined;
/**
* How long the client will wait before killing a socket due to inactivity during initial connection.
* @default 10000
*/
connectTimeout?: number | undefined;
/**
* This option is used internally when you call `redis.monitor()` to tell Redis
* to enter the monitor mode when the connection is established.
*
* @default false
*/
monitor?: boolean | undefined;
/**
* The commands that don't get a reply due to the connection to the server is lost are
* put into a queue and will be resent on reconnect (if allowed by the `retryStrategy` option).
* This option is used to configure how many reconnection attempts should be allowed before
* the queue is flushed with a `MaxRetriesPerRequestError` error.
* Set this options to `null` instead of a number to let commands wait forever
* until the connection is alive again.
*
* @default 20
*/
maxRetriesPerRequest?: number | null | undefined;
/**
* @default 10000
*/
maxLoadingRetryTime?: number | undefined;
/**
* @default false
*/
enableAutoPipelining?: boolean | undefined;
/**
* @default []
*/
autoPipeliningIgnoredCommands?: string[] | undefined;
offlineQueue?: boolean | undefined;
commandQueue?: boolean | undefined;
/**
*
* By default, if the connection to Redis server has not been established, commands are added to a queue
* and are executed once the connection is "ready" (when `enableReadyCheck` is true, "ready" means
* the Redis server has loaded the database from disk, otherwise means the connection to the Redis
* server has been established). If this option is false, when execute the command when the connection
* isn't ready, an error will be returned.
*
* @default true
*/
enableOfflineQueue?: boolean | undefined;
/**
* The client will sent an INFO command to check whether the server is still loading data from the disk (
* which happens when the server is just launched) when the connection is established, and only wait until
* the loading process is finished before emitting the `ready` event.
*
* @default true
*/
enableReadyCheck?: boolean | undefined;
/**
* When a Redis instance is initialized, a connection to the server is immediately established. Set this to
* true will delay the connection to the server until the first command is sent or `redis.connect()` is called
* explicitly. When `redis.connect()` is called explicitly, a Promise is returned, which will be resolved
* when the connection is ready or rejected when it fails. The rejection should be handled by the user.
*
* @default false
*/
lazyConnect?: boolean | undefined;
/**
* @default undefined
*/
scripts?: Record<string, {
lua: string;
numberOfKeys?: number | undefined;
readOnly?: boolean | undefined;
}> | undefined;
}
export declare type RedisOptions = CommonRedisOptions & SentinelConnectionOptions & StandaloneConnectionOptions;
export declare const DEFAULT_REDIS_OPTIONS: RedisOptions;
landvex/node_modules/ioredis/built/redis/RedisOptions.js
Generated Vendored
+58
View File
@@ -0,0 +1,58 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.DEFAULT_REDIS_OPTIONS = void 0;
exports.DEFAULT_REDIS_OPTIONS = {
// Connection
port: 6379,
host: "localhost",
family: 0,
connectTimeout: 10000,
disconnectTimeout: 2000,
retryStrategy: function (times) {
return Math.min(times * 50, 2000);
},
keepAlive: 0,
noDelay: true,
connectionName: null,
disableClientInfo: false,
clientInfoTag: undefined,
// Sentinel
sentinels: null,
name: null,
role: "master",
sentinelRetryStrategy: function (times) {
return Math.min(times * 10, 1000);
},
sentinelReconnectStrategy: function () {
// This strategy only applies when sentinels are used for detecting
// a failover, not during initial master resolution.
// The deployment can still function when some of the sentinels are down
// for a long period of time, so we may not want to attempt reconnection
// very often. Therefore the default interval is fairly long (1 minute).
return 60000;
},
natMap: null,
enableTLSForSentinelMode: false,
updateSentinels: true,
failoverDetector: false,
// Status
username: null,
password: null,
db: 0,
// Others
enableOfflineQueue: true,
enableReadyCheck: true,
autoResubscribe: true,
autoResendUnfulfilledCommands: true,
lazyConnect: false,
keyPrefix: "",
reconnectOnError: null,
readOnly: false,
stringNumbers: false,
maxRetriesPerRequest: 20,
maxLoadingRetryTime: 10000,
enableAutoPipelining: false,
autoPipeliningIgnoredCommands: [],
sentinelMaxConnections: 10,
blockingTimeoutGrace: 100,
};
landvex/node_modules/ioredis/built/redis/event_handler.d.ts
Generated Vendored
+4
View File
@@ -0,0 +1,4 @@
export declare function connectHandler(self: any): () => void;
export declare function closeHandler(self: any): () => void;
export declare function errorHandler(self: any): (error: any) => void;
export declare function readyHandler(self: any): () => void;
landvex/node_modules/ioredis/built/redis/event_handler.js
Generated Vendored
+315
View File
@@ -0,0 +1,315 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.readyHandler = exports.errorHandler = exports.closeHandler = exports.connectHandler = void 0;
const redis_errors_1 = require("redis-errors");
const Command_1 = require("../Command");
const errors_1 = require("../errors");
const utils_1 = require("../utils");
const DataHandler_1 = require("../DataHandler");
const debug = (0, utils_1.Debug)("connection");
function connectHandler(self) {
return function () {
var _a;
self.setStatus("connect");
self.resetCommandQueue();
// AUTH command should be processed before any other commands
let flushed = false;
const { connectionEpoch } = self;
if (self.condition.auth) {
self.auth(self.condition.auth, function (err) {
if (connectionEpoch !== self.connectionEpoch) {
return;
}
if (err) {
if (err.message.indexOf("no password is set") !== -1) {
console.warn("[WARN] Redis server does not require a password, but a password was supplied.");
}
else if (err.message.indexOf("without any password configured for the default user") !== -1) {
console.warn("[WARN] This Redis server's `default` user does not require a password, but a password was supplied");
}
else if (err.message.indexOf("wrong number of arguments for 'auth' command") !== -1) {
console.warn(`[ERROR] The server returned "wrong number of arguments for 'auth' command". You are probably passing both username and password to Redis version 5 or below. You should only pass the 'password' option for Redis version 5 and under.`);
}
else {
flushed = true;
self.recoverFromFatalError(err, err);
}
}
});
}
if (self.condition.select) {
self.select(self.condition.select).catch((err) => {
// If the node is in cluster mode, select is disallowed.
// In this case, reconnect won't help.
self.silentEmit("error", err);
});
}
/*
No need to keep the reference of DataHandler here
because we don't need to do the cleanup.
`Stream#end()` will remove all listeners for us.
*/
new DataHandler_1.default(self, {
stringNumbers: self.options.stringNumbers,
});
const clientCommandPromises = [];
if (self.options.connectionName) {
debug("set the connection name [%s]", self.options.connectionName);
clientCommandPromises.push(self.client("setname", self.options.connectionName).catch(utils_1.noop));
}
if (!self.options.disableClientInfo) {
debug("set the client info");
clientCommandPromises.push((0, utils_1.getPackageMeta)()
.then((packageMeta) => {
return self
.client("SETINFO", "LIB-VER", packageMeta.version)
.catch(utils_1.noop);
})
.catch(utils_1.noop));
clientCommandPromises.push(self
.client("SETINFO", "LIB-NAME", ((_a = self.options) === null || _a === void 0 ? void 0 : _a.clientInfoTag)
? `ioredis(${self.options.clientInfoTag})`
: "ioredis")
.catch(utils_1.noop));
}
Promise.all(clientCommandPromises)
.catch(utils_1.noop)
.finally(() => {
if (!self.options.enableReadyCheck) {
exports.readyHandler(self)();
}
if (self.options.enableReadyCheck) {
self._readyCheck(function (err, info) {
if (connectionEpoch !== self.connectionEpoch) {
return;
}
if (err) {
if (!flushed) {
self.recoverFromFatalError(new Error("Ready check failed: " + err.message), err);
}
}
else {
if (self.connector.check(info)) {
exports.readyHandler(self)();
}
else {
self.disconnect(true);
}
}
});
}
});
};
}
exports.connectHandler = connectHandler;
function abortError(command) {
const err = new redis_errors_1.AbortError("Command aborted due to connection close");
err.command = {
name: command.name,
args: command.args,
};
return err;
}
// If a contiguous set of pipeline commands starts from index zero then they
// can be safely reattempted. If however we have a chain of pipelined commands
// starting at index 1 or more it means we received a partial response before
// the connection close and those pipelined commands must be aborted. For
// example, if the queue looks like this: [2, 3, 4, 0, 1, 2] then after
// aborting and purging we'll have a queue that looks like this: [0, 1, 2]
function abortIncompletePipelines(commandQueue) {
var _a;
let expectedIndex = 0;
for (let i = 0; i < commandQueue.length;) {
const command = (_a = commandQueue.peekAt(i)) === null || _a === void 0 ? void 0 : _a.command;
const pipelineIndex = command.pipelineIndex;
if (pipelineIndex === undefined || pipelineIndex === 0) {
expectedIndex = 0;
}
if (pipelineIndex !== undefined && pipelineIndex !== expectedIndex++) {
commandQueue.remove(i, 1);
command.reject(abortError(command));
continue;
}
i++;
}
}
// If only a partial transaction result was received before connection close,
// we have to abort any transaction fragments that may have ended up in the
// offline queue
function abortTransactionFragments(commandQueue) {
var _a;
for (let i = 0; i < commandQueue.length;) {
const command = (_a = commandQueue.peekAt(i)) === null || _a === void 0 ? void 0 : _a.command;
if (command.name === "multi") {
break;
}
if (command.name === "exec") {
commandQueue.remove(i, 1);
command.reject(abortError(command));
break;
}
if (command.inTransaction) {
commandQueue.remove(i, 1);
command.reject(abortError(command));
}
else {
i++;
}
}
}
function closeHandler(self) {
return function () {
const prevStatus = self.status;
self.setStatus("close");
if (self.commandQueue.length) {
abortIncompletePipelines(self.commandQueue);
}
if (self.offlineQueue.length) {
abortTransactionFragments(self.offlineQueue);
}
if (prevStatus === "ready") {
if (!self.prevCondition) {
self.prevCondition = self.condition;
}
if (self.commandQueue.length) {
self.prevCommandQueue = self.commandQueue;
}
}
if (self.manuallyClosing) {
self.manuallyClosing = false;
debug("skip reconnecting since the connection is manually closed.");
return close();
}
if (typeof self.options.retryStrategy !== "function") {
debug("skip reconnecting because `retryStrategy` is not a function");
return close();
}
const retryDelay = self.options.retryStrategy(++self.retryAttempts);
if (typeof retryDelay !== "number") {
debug("skip reconnecting because `retryStrategy` doesn't return a number");
return close();
}
debug("reconnect in %sms", retryDelay);
self.setStatus("reconnecting", retryDelay);
self.reconnectTimeout = setTimeout(function () {
self.reconnectTimeout = null;
self.connect().catch(utils_1.noop);
}, retryDelay);
const { maxRetriesPerRequest } = self.options;
if (typeof maxRetriesPerRequest === "number") {
if (maxRetriesPerRequest < 0) {
debug("maxRetriesPerRequest is negative, ignoring...");
}
else {
const remainder = self.retryAttempts % (maxRetriesPerRequest + 1);
if (remainder === 0) {
debug("reach maxRetriesPerRequest limitation, flushing command queue...");
self.flushQueue(new errors_1.MaxRetriesPerRequestError(maxRetriesPerRequest));
}
}
}
};
function close() {
self.setStatus("end");
self.flushQueue(new Error(utils_1.CONNECTION_CLOSED_ERROR_MSG));
}
}
exports.closeHandler = closeHandler;
function errorHandler(self) {
return function (error) {
debug("error: %s", error);
self.silentEmit("error", error);
};
}
exports.errorHandler = errorHandler;
function readyHandler(self) {
return function () {
self.setStatus("ready");
self.retryAttempts = 0;
if (self.options.monitor) {
self.call("monitor").then(() => self.setStatus("monitoring"), (error) => self.emit("error", error));
const { sendCommand } = self;
self.sendCommand = function (command) {
if (Command_1.default.checkFlag("VALID_IN_MONITOR_MODE", command.name)) {
return sendCommand.call(self, command);
}
command.reject(new Error("Connection is in monitoring mode, can't process commands."));
return command.promise;
};
self.once("close", function () {
delete self.sendCommand;
});
return;
}
const finalSelect = self.prevCondition
? self.prevCondition.select
: self.condition.select;
if (self.options.readOnly) {
debug("set the connection to readonly mode");
self.readonly().catch(utils_1.noop);
}
if (self.prevCondition) {
const condition = self.prevCondition;
self.prevCondition = null;
if (condition.subscriber && self.options.autoResubscribe) {
// We re-select the previous db first since
// `SELECT` command is not valid in sub mode.
if (self.condition.select !== finalSelect) {
debug("connect to db [%d]", finalSelect);
self.select(finalSelect);
}
const subscribeChannels = condition.subscriber.channels("subscribe");
if (subscribeChannels.length) {
debug("subscribe %d channels", subscribeChannels.length);
self.subscribe(subscribeChannels);
}
const psubscribeChannels = condition.subscriber.channels("psubscribe");
if (psubscribeChannels.length) {
debug("psubscribe %d channels", psubscribeChannels.length);
self.psubscribe(psubscribeChannels);
}
const ssubscribeChannels = condition.subscriber.channels("ssubscribe");
if (ssubscribeChannels.length) {
debug("ssubscribe %s", ssubscribeChannels.length);
for (const channel of ssubscribeChannels) {
self.ssubscribe(channel);
}
}
}
}
if (self.prevCommandQueue) {
if (self.options.autoResendUnfulfilledCommands) {
debug("resend %d unfulfilled commands", self.prevCommandQueue.length);
while (self.prevCommandQueue.length > 0) {
const item = self.prevCommandQueue.shift();
if (item.select !== self.condition.select &&
item.command.name !== "select") {
self.select(item.select);
}
self.sendCommand(item.command, item.stream);
}
}
else {
self.prevCommandQueue = null;
}
}
if (self.offlineQueue.length) {
debug("send %d commands in offline queue", self.offlineQueue.length);
const offlineQueue = self.offlineQueue;
self.resetOfflineQueue();
while (offlineQueue.length > 0) {
const item = offlineQueue.shift();
if (item.select !== self.condition.select &&
item.command.name !== "select") {
self.select(item.select);
}
self.sendCommand(item.command, item.stream);
}
}
if (self.condition.select !== finalSelect) {
debug("connect to db [%d]", finalSelect);
self.select(finalSelect);
}
};
}
exports.readyHandler = readyHandler;
landvex/node_modules/ioredis/built/tracing.d.ts
Generated Vendored
+26
View File
@@ -0,0 +1,26 @@
import type { CommandParameter } from "./types";
export declare function sanitizeArgs(commandName: string, args: CommandParameter[]): string[];
export interface CommandTraceContext {
command: string;
args: string[];
database: number;
serverAddress: string;
serverPort: number | undefined;
}
export interface BatchOperationContext {
batchMode: "MULTI";
batchSize: number;
database: number;
serverAddress: string;
serverPort: number | undefined;
}
export interface ConnectTraceContext {
serverAddress: string;
serverPort: number | undefined;
connectionEpoch: number;
}
declare type CommandContext = CommandTraceContext;
export declare function traceCommand<T>(fn: () => Promise<T>, contextFactory: () => CommandContext): Promise<T>;
export declare function traceBatch<T>(fn: () => Promise<T>, contextFactory: () => BatchOperationContext): Promise<T>;
export declare function traceConnect<T>(fn: () => Promise<T>, contextFactory: () => ConnectTraceContext): Promise<T>;
export {};
landvex/node_modules/ioredis/built/tracing.js
Generated Vendored
+96
View File
@@ -0,0 +1,96 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.traceConnect = exports.traceBatch = exports.traceCommand = exports.sanitizeArgs = void 0;
// Argument sanitization rules adapted from @opentelemetry/redis-common (Apache 2.0).
// https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/packages/redis-common/src/index.ts
//
// Each entry specifies how many positional args (after the command name) are safe
// to emit. -1 means all args are safe (read-only/structural commands).
// Unlisted commands default to 0 (all args redacted) for safe-by-default behavior,
// which covers AUTH, HELLO, and unknown/custom commands.
const SERIALIZATION_SUBSETS = [
{ regex: /^ECHO/i, args: 0 },
{
regex: /^(LPUSH|MSET|PFA|PUBLISH|RPUSH|SADD|SET|SPUBLISH|XADD|ZADD)/i,
args: 1,
},
{ regex: /^(HSET|HMSET|LSET|LINSERT)/i, args: 2 },
{
regex: /^(ACL|BIT|B[LRZ]|CLIENT|CLUSTER|CONFIG|COMMAND|DECR|DEL|EVAL|EX|FUNCTION|GEO|GET|HINCR|HMGET|HSCAN|INCR|L[TRLM]|MEMORY|P[EFISTU]|RPOP|S[CDIMORSU]|XACK|X[CDGILPRT]|Z[CDILMPRS])/i,
args: -1,
},
];
function sanitizeArgs(commandName, args) {
let allowedArgCount = 0;
for (const subset of SERIALIZATION_SUBSETS) {
if (subset.regex.test(commandName)) {
allowedArgCount = subset.args;
break;
}
}
if (allowedArgCount === -1) {
return args.map((a) => String(a));
}
const result = [];
for (let i = 0; i < args.length; i++) {
if (i < allowedArgCount) {
result.push(String(args[i]));
}
else {
result.push("?");
}
}
return result;
}
exports.sanitizeArgs = sanitizeArgs;
// Load diagnostics_channel with Node 18 compatibility
const dc = (() => {
try {
return "getBuiltinModule" in process
? process.getBuiltinModule("node:diagnostics_channel")
: require("node:diagnostics_channel");
}
catch {
return undefined;
}
})();
const hasTracingChannel = dc && typeof dc.tracingChannel === "function";
const commandChannel = hasTracingChannel
? dc.tracingChannel("ioredis:command")
: undefined;
const batchChannel = hasTracingChannel
? dc.tracingChannel("ioredis:batch")
: undefined;
const connectChannel = hasTracingChannel
? dc.tracingChannel("ioredis:connect")
: undefined;
function shouldTrace(channel) {
return !!channel && channel.hasSubscribers !== false;
}
const noop = () => { };
function traceCommand(fn, contextFactory) {
if (!shouldTrace(commandChannel))
return fn();
// tracePromise returns a wrapper promise that re-rejects on error.
// Silence the wrapper to prevent unhandled rejections when callers
// (e.g. Pipeline) discard the return value. Callers that await this
// promise still see the rejection through their own .then() chain.
const traced = commandChannel.tracePromise(fn, contextFactory());
traced.catch(noop);
return traced;
}
exports.traceCommand = traceCommand;
function traceBatch(fn, contextFactory) {
if (!shouldTrace(batchChannel))
return fn();
const traced = batchChannel.tracePromise(fn, contextFactory());
traced.catch(noop);
return traced;
}
exports.traceBatch = traceBatch;
function traceConnect(fn, contextFactory) {
if (!shouldTrace(connectChannel))
return fn();
return connectChannel.tracePromise(fn, contextFactory());
}
exports.traceConnect = traceConnect;
landvex/node_modules/ioredis/built/transaction.d.ts
Generated Vendored
+13
View File
@@ -0,0 +1,13 @@
import { ChainableCommander } from "./utils/RedisCommander";
export interface Transaction {
pipeline(commands?: unknown[][]): ChainableCommander;
multi(options: {
pipeline: false;
}): Promise<"OK">;
multi(): ChainableCommander;
multi(options: {
pipeline: true;
}): ChainableCommander;
multi(commands?: unknown[][]): ChainableCommander;
}
export declare function addTransactionSupport(redis: any): void;
landvex/node_modules/ioredis/built/transaction.js
Generated Vendored
+100
View File
@@ -0,0 +1,100 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.addTransactionSupport = void 0;
const utils_1 = require("./utils");
const standard_as_callback_1 = require("standard-as-callback");
const Pipeline_1 = require("./Pipeline");
const tracing_1 = require("./tracing");
function addTransactionSupport(redis) {
redis.pipeline = function (commands) {
const pipeline = new Pipeline_1.default(this);
if (Array.isArray(commands)) {
pipeline.addBatch(commands);
}
return pipeline;
};
const { multi } = redis;
redis.multi = function (commands, options) {
if (typeof options === "undefined" && !Array.isArray(commands)) {
options = commands;
commands = null;
}
if (options && options.pipeline === false) {
return multi.call(this);
}
const pipeline = new Pipeline_1.default(this);
// @ts-expect-error
pipeline.multi();
if (Array.isArray(commands)) {
pipeline.addBatch(commands);
}
const exec = pipeline.exec;
pipeline.exec = function (callback) {
// Wait for the cluster to be connected, since we need nodes information before continuing
if (this.isCluster && !this.redis.slots.length) {
if (this.redis.status === "wait")
this.redis.connect().catch(utils_1.noop);
return (0, standard_as_callback_1.default)(new Promise((resolve, reject) => {
this.redis.delayUntilReady((err) => {
if (err) {
reject(err);
return;
}
this.exec(pipeline).then(resolve, reject);
});
}), callback);
}
if (this._transactions > 0) {
exec.call(pipeline);
}
// Returns directly when the pipeline
// has been called multiple times (retries).
if (this.nodeifiedPromise) {
return exec.call(pipeline);
}
// Count only user commands (exclude MULTI/EXEC wrappers).
const batchSize = Math.max(pipeline.length - 2, 0);
const execAndUnwrap = () => exec.call(pipeline).then(function (result) {
const execResult = result[result.length - 1];
if (typeof execResult === "undefined") {
throw new Error("Pipeline cannot be used to send any commands when the `exec()` has been called on it.");
}
if (execResult[0]) {
execResult[0].previousErrors = [];
for (let i = 0; i < result.length - 1; ++i) {
if (result[i][0]) {
execResult[0].previousErrors.push(result[i][0]);
}
}
throw execResult[0];
}
return (0, utils_1.wrapMultiResult)(execResult[1]);
});
// Trace MULTI as a single batch operation on ioredis:batch.
const promise = "_buildBatchContext" in this.redis
? (0, tracing_1.traceBatch)(execAndUnwrap, () => this.redis._buildBatchContext(batchSize))
: execAndUnwrap();
return (0, standard_as_callback_1.default)(promise, callback);
};
// @ts-expect-error
const { execBuffer } = pipeline;
// @ts-expect-error
pipeline.execBuffer = function (callback) {
if (this._transactions > 0) {
execBuffer.call(pipeline);
}
return pipeline.exec(callback);
};
return pipeline;
};
const { exec } = redis;
redis.exec = function (callback) {
return (0, standard_as_callback_1.default)(exec.call(this).then(function (results) {
if (Array.isArray(results)) {
results = (0, utils_1.wrapMultiResult)(results);
}
return results;
}), callback);
};
}
exports.addTransactionSupport = addTransactionSupport;
landvex/node_modules/ioredis/built/types.d.ts
Generated Vendored
+33
View File
@@ -0,0 +1,33 @@
/// <reference types="node" />
import { Socket } from "net";
import { TLSSocket } from "tls";
export declare type Callback<T = any> = (err?: Error | null, result?: T) => void;
export declare type NetStream = Socket | TLSSocket;
export declare type CommandParameter = string | Buffer | number | any[];
export interface Respondable {
name: string;
args: CommandParameter[];
resolve(result: any): void;
reject(error: Error): void;
}
export interface PipelineWriteableStream {
isPipeline: true;
write(data: string | Buffer): unknown;
destination: {
redis: {
stream: NetStream;
};
};
}
export declare type WriteableStream = NetStream | PipelineWriteableStream;
export interface CommandItem {
command: Respondable;
stream: WriteableStream;
select: number;
}
export interface ScanStreamOptions {
match?: string;
type?: string;
count?: number;
noValues?: boolean;
}
landvex/node_modules/ioredis/built/types.js
Generated Vendored
+2
View File
@@ -0,0 +1,2 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
landvex/node_modules/ioredis/built/utils/Commander.d.ts
Generated Vendored
+50
View File
@@ -0,0 +1,50 @@
import Command from "../Command";
import { WriteableStream } from "../types";
import RedisCommander, { ClientContext } from "./RedisCommander";
export interface CommanderOptions {
keyPrefix?: string | undefined;
showFriendlyErrorStack?: boolean | undefined;
}
declare class Commander<Context extends ClientContext = {
type: "default";
}> {
options: CommanderOptions;
/**
* @ignore
*/
scriptsSet: {};
/**
* @ignore
*/
addedBuiltinSet: Set<string>;
/**
* Return supported builtin commands
*/
getBuiltinCommands(): string[];
/**
* Create a builtin command
*/
createBuiltinCommand(commandName: string): {
string: any;
buffer: any;
};
/**
* Create add builtin command
*/
addBuiltinCommand(commandName: string): void;
/**
* Define a custom command using lua script
*/
defineCommand(name: string, definition: {
lua: string;
numberOfKeys?: number;
readOnly?: boolean;
}): void;
/**
* @ignore
*/
sendCommand(command: Command, stream?: WriteableStream, node?: unknown): unknown;
}
interface Commander<Context> extends RedisCommander<Context> {
}
export default Commander;
landvex/node_modules/ioredis/built/utils/Commander.js
Generated Vendored
+117
View File
@@ -0,0 +1,117 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const commands_1 = require("@ioredis/commands");
const autoPipelining_1 = require("../autoPipelining");
const Command_1 = require("../Command");
const Script_1 = require("../Script");
// eslint-disable-next-line @typescript-eslint/no-unused-vars
class Commander {
constructor() {
this.options = {};
/**
* @ignore
*/
this.scriptsSet = {};
/**
* @ignore
*/
this.addedBuiltinSet = new Set();
}
/**
* Return supported builtin commands
*/
getBuiltinCommands() {
return commands.slice(0);
}
/**
* Create a builtin command
*/
createBuiltinCommand(commandName) {
return {
string: generateFunction(null, commandName, "utf8"),
buffer: generateFunction(null, commandName, null),
};
}
/**
* Create add builtin command
*/
addBuiltinCommand(commandName) {
this.addedBuiltinSet.add(commandName);
this[commandName] = generateFunction(commandName, commandName, "utf8");
this[commandName + "Buffer"] = generateFunction(commandName + "Buffer", commandName, null);
}
/**
* Define a custom command using lua script
*/
defineCommand(name, definition) {
const script = new Script_1.default(definition.lua, definition.numberOfKeys, this.options.keyPrefix, definition.readOnly);
this.scriptsSet[name] = script;
this[name] = generateScriptingFunction(name, name, script, "utf8");
this[name + "Buffer"] = generateScriptingFunction(name + "Buffer", name, script, null);
}
/**
* @ignore
*/
sendCommand(command, stream, node) {
throw new Error('"sendCommand" is not implemented');
}
}
const commands = commands_1.list.filter((command) => command !== "monitor");
commands.push("sentinel");
commands.forEach(function (commandName) {
Commander.prototype[commandName] = generateFunction(commandName, commandName, "utf8");
Commander.prototype[commandName + "Buffer"] = generateFunction(commandName + "Buffer", commandName, null);
});
Commander.prototype.call = generateFunction("call", "utf8");
Commander.prototype.callBuffer = generateFunction("callBuffer", null);
// @ts-expect-error
Commander.prototype.send_command = Commander.prototype.call;
function generateFunction(functionName, _commandName, _encoding) {
if (typeof _encoding === "undefined") {
_encoding = _commandName;
_commandName = null;
}
return function (...args) {
const commandName = (_commandName || args.shift());
let callback = args[args.length - 1];
if (typeof callback === "function") {
args.pop();
}
else {
callback = undefined;
}
const options = {
errorStack: this.options.showFriendlyErrorStack ? new Error() : undefined,
keyPrefix: this.options.keyPrefix,
replyEncoding: _encoding,
};
// No auto pipeline, use regular command sending
if (!(0, autoPipelining_1.shouldUseAutoPipelining)(this, functionName, commandName)) {
return this.sendCommand(
// @ts-expect-error
new Command_1.default(commandName, args, options, callback));
}
// Create a new pipeline and make sure it's scheduled
return (0, autoPipelining_1.executeWithAutoPipelining)(this, functionName, commandName,
// @ts-expect-error
args, callback);
};
}
function generateScriptingFunction(functionName, commandName, script, encoding) {
return function (...args) {
const callback = typeof args[args.length - 1] === "function" ? args.pop() : undefined;
const options = {
replyEncoding: encoding,
};
if (this.options.showFriendlyErrorStack) {
options.errorStack = new Error();
}
// No auto pipeline, use regular command sending
if (!(0, autoPipelining_1.shouldUseAutoPipelining)(this, functionName, commandName)) {
return script.execute(this, args, options, callback);
}
// Create a new pipeline and make sure it's scheduled
return (0, autoPipelining_1.executeWithAutoPipelining)(this, functionName, commandName, args, callback);
};
}
exports.default = Commander;
landvex/node_modules/ioredis/built/utils/RedisCommander.d.ts
Generated Vendored
+9728
View File
@@ -0,0 +1,9728 @@
/**
* This file is generated by @ioredis/interface-generator.
* Don't edit it manually. Instead, run `npm run generate` to update
* this file.
*/
/// <reference types="node" />
import { Callback } from "../types";
export declare type RedisKey = string | Buffer;
export declare type RedisValue = string | Buffer | number;
export interface ResultTypes<Result, Context> {
default: Promise<Result>;
pipeline: ChainableCommander;
}
export interface ChainableCommander extends RedisCommander<{
type: "pipeline";
}> {
length: number;
}
export declare type ClientContext = {
type: keyof ResultTypes<unknown, unknown>;
};
export declare type Result<T, Context extends ClientContext> = ResultTypes<T, Context>[Context["type"]];
interface RedisCommander<Context extends ClientContext = {
type: "default";
}> {
/**
* Call arbitrary commands.
*
* `redis.call('set', 'foo', 'bar')` is the same as `redis.set('foo', 'bar')`,
* so the only case you need to use this method is when the command is not
* supported by ioredis.
*
* ```ts
* redis.call('set', 'foo', 'bar');
* redis.call('get', 'foo', (err, value) => {
* // value === 'bar'
* });
* ```
*/
call(command: string, callback?: Callback<unknown>): Result<unknown, Context>;
call(command: string, args: (string | Buffer | number)[], callback?: Callback<unknown>): Result<unknown, Context>;
call(...args: [
command: string,
...args: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
call(...args: [command: string, ...args: (string | Buffer | number)[]]): Result<unknown, Context>;
callBuffer(command: string, callback?: Callback<unknown>): Result<unknown, Context>;
callBuffer(command: string, args: (string | Buffer | number)[], callback?: Callback<unknown>): Result<unknown, Context>;
callBuffer(...args: [
command: string,
...args: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
callBuffer(...args: [command: string, ...args: (string | Buffer | number)[]]): Result<unknown, Context>;
/**
* List the ACL categories or the commands inside a category
* - _group_: server
* - _complexity_: O(1) since the categories and commands are a fixed set.
* - _since_: 6.0.0
*/
acl(subcommand: "CAT", callback?: Callback<unknown>): Result<unknown, Context>;
acl(subcommand: "CAT", categoryname: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Remove the specified ACL users and the associated rules
* - _group_: server
* - _complexity_: O(1) amortized time considering the typical user.
* - _since_: 6.0.0
*/
acl(...args: [
subcommand: "DELUSER",
...usernames: (string | Buffer)[],
callback: Callback<number>
]): Result<number, Context>;
acl(...args: [subcommand: "DELUSER", ...usernames: (string | Buffer)[]]): Result<number, Context>;
/**
* Returns whether the user can execute the given command without executing the command.
* - _group_: server
* - _complexity_: O(1).
* - _since_: 7.0.0
*/
acl(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<string>): Result<string, Context>;
aclBuffer(subcommand: "DRYRUN", username: string | Buffer, command: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
acl(...args: [
subcommand: "DRYRUN",
username: string | Buffer,
command: string | Buffer,
...args: (string | Buffer | number)[],
callback: Callback<string>
]): Result<string, Context>;
aclBuffer(...args: [
subcommand: "DRYRUN",
username: string | Buffer,
command: string | Buffer,
...args: (string | Buffer | number)[],
callback: Callback<Buffer>
]): Result<Buffer, Context>;
acl(...args: [
subcommand: "DRYRUN",
username: string | Buffer,
command: string | Buffer,
...args: (string | Buffer | number)[]
]): Result<string, Context>;
aclBuffer(...args: [
subcommand: "DRYRUN",
username: string | Buffer,
command: string | Buffer,
...args: (string | Buffer | number)[]
]): Result<Buffer, Context>;
/**
* Generate a pseudorandom secure password to use for ACL users
* - _group_: server
* - _complexity_: O(1)
* - _since_: 6.0.0
*/
acl(subcommand: "GENPASS", callback?: Callback<string>): Result<string, Context>;
aclBuffer(subcommand: "GENPASS", callback?: Callback<Buffer>): Result<Buffer, Context>;
acl(subcommand: "GENPASS", bits: number | string, callback?: Callback<string>): Result<string, Context>;
aclBuffer(subcommand: "GENPASS", bits: number | string, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Get the rules for a specific ACL user
* - _group_: server
* - _complexity_: O(N). Where N is the number of password, command and pattern rules that the user has.
* - _since_: 6.0.0
*/
acl(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<string[] | null>): Result<string[] | null, Context>;
aclBuffer(subcommand: "GETUSER", username: string | Buffer, callback?: Callback<Buffer[] | null>): Result<Buffer[] | null, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: server
* - _complexity_: O(1)
* - _since_: 6.0.0
*/
acl(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* List the current ACL rules in ACL config file format
* - _group_: server
* - _complexity_: O(N). Where N is the number of configured users.
* - _since_: 6.0.0
*/
acl(subcommand: "LIST", callback?: Callback<string[]>): Result<string[], Context>;
aclBuffer(subcommand: "LIST", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Reload the ACLs from the configured ACL file
* - _group_: server
* - _complexity_: O(N). Where N is the number of configured users.
* - _since_: 6.0.0
*/
acl(subcommand: "LOAD", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* List latest events denied because of ACLs in place
* - _group_: server
* - _complexity_: O(N) with N being the number of entries shown.
* - _since_: 6.0.0
*/
acl(subcommand: "LOG", callback?: Callback<unknown>): Result<unknown, Context>;
acl(subcommand: "LOG", count: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
acl(subcommand: "LOG", reset: "RESET", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Save the current ACL rules in the configured ACL file
* - _group_: server
* - _complexity_: O(N). Where N is the number of configured users.
* - _since_: 6.0.0
*/
acl(subcommand: "SAVE", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Modify or create the rules for a specific ACL user
* - _group_: server
* - _complexity_: O(N). Where N is the number of rules provided.
* - _since_: 6.0.0
*/
acl(subcommand: "SETUSER", username: string | Buffer, callback?: Callback<"OK">): Result<"OK", Context>;
acl(...args: [
subcommand: "SETUSER",
username: string | Buffer,
...rules: (string | Buffer)[],
callback: Callback<"OK">
]): Result<"OK", Context>;
acl(...args: [
subcommand: "SETUSER",
username: string | Buffer,
...rules: (string | Buffer)[]
]): Result<"OK", Context>;
/**
* List the username of all the configured ACL rules
* - _group_: server
* - _complexity_: O(N). Where N is the number of configured users.
* - _since_: 6.0.0
*/
acl(subcommand: "USERS", callback?: Callback<string[]>): Result<string[], Context>;
aclBuffer(subcommand: "USERS", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Return the name of the user associated to the current connection
* - _group_: server
* - _complexity_: O(1)
* - _since_: 6.0.0
*/
acl(subcommand: "WHOAMI", callback?: Callback<string>): Result<string, Context>;
aclBuffer(subcommand: "WHOAMI", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Append a value to a key
* - _group_: string
* - _complexity_: O(1). The amortized time complexity is O(1) assuming the appended value is small and the already present value is of any size, since the dynamic string library used by Redis will double the free space available on every reallocation.
* - _since_: 2.0.0
*/
append(key: RedisKey, value: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Returns the number of non-empty elements in an array.
* - _group_: array
* - _complexity_: O(1)
* - _since_: 8.8.0
*/
arcount(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Deletes elements at the specified indices in an array.
* - _group_: array
* - _complexity_: O(N) where N is the number of indices to delete
* - _since_: 8.8.0
*/
ardel(...args: [key: RedisKey, ...indices: (number | string)[], callback: Callback<number>]): Result<number, Context>;
ardel(...args: [key: RedisKey, ...indices: (number | string)[]]): Result<number, Context>;
/**
* Deletes elements in one or more ranges.
* - _group_: array
* - _complexity_: Proportional to the number of existing elements / slices touched, not to the numeric span of the requested ranges
* - _since_: 8.8.0
*/
ardelrange(...args: [key: RedisKey, ...ranges: (string | number)[], callback: Callback<number>]): Result<number, Context>;
ardelrange(...args: [key: RedisKey, ...ranges: (string | number)[]]): Result<number, Context>;
/**
* Gets the value at an index in an array.
* - _group_: array
* - _complexity_: O(1)
* - _since_: 8.8.0
*/
arget(key: RedisKey, index: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
argetBuffer(key: RedisKey, index: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Gets values in a range of indices.
* - _group_: array
* - _complexity_: O(N) where N is the range length
* - _since_: 8.8.0
*/
argetrange(key: RedisKey, start: number | string, end: number | string, callback?: Callback<(string | null)[]>): Result<(string | null)[], Context>;
argetrangeBuffer(key: RedisKey, start: number | string, end: number | string, callback?: Callback<(Buffer | null)[]>): Result<(Buffer | null)[], Context>;
/**
* Searches array elements in a range using textual predicates.
* - _group_: array
* - _complexity_: O(P * C) where P is the number of visited positions in touched slices and C is the cost of evaluating the predicates on one existing element.
* - _since_: 8.8.0
*/
argrep(key: RedisKey, start: number | string, end: number | string, predicate: 'EXACT' | 'MATCH' | 'GLOB' | 'RE', value: RedisValue, callback: Callback<number[]>): Result<number[], Context>;
argrep(...args: [key: RedisKey, start: number | string, end: number | string, predicate: 'EXACT' | 'MATCH' | 'GLOB' | 'RE', value: RedisValue, ...args: RedisValue[], callback: Callback<number[] | Array<[index: number, value: string]>>]): Result<number[] | Array<[index: number, value: string]>, Context>;
argrep<T extends RedisValue[]>(...args: [key: RedisKey, start: number | string, end: number | string, predicate: 'EXACT' | 'MATCH' | 'GLOB' | 'RE', value: RedisValue, ...args: T]): Result<'WITHVALUES' extends T[number] ? Array<[index: number, value: string]> : number[], Context>;
argrepBuffer(key: RedisKey, start: number | string, end: number | string, predicate: 'EXACT' | 'MATCH' | 'GLOB' | 'RE', value: RedisValue, callback: Callback<number[]>): Result<number[], Context>;
argrepBuffer(...args: [key: RedisKey, start: number | string, end: number | string, predicate: 'EXACT' | 'MATCH' | 'GLOB' | 'RE', value: RedisValue, ...args: RedisValue[], callback: Callback<number[] | Array<[index: number, value: Buffer]>>]): Result<number[] | Array<[index: number, value: Buffer]>, Context>;
argrepBuffer<T extends RedisValue[]>(...args: [key: RedisKey, start: number | string, end: number | string, predicate: 'EXACT' | 'MATCH' | 'GLOB' | 'RE', value: RedisValue, ...args: T]): Result<'WITHVALUES' extends T[number] ? Array<[index: number, value: Buffer]> : number[], Context>;
/**
* Returns metadata about an array.
* - _group_: array
* - _complexity_: O(1), or O(N) with FULL option where N is the number of slices.
* - _since_: 8.8.0
*/
arinfo(key: RedisKey, callback?: Callback<(string | number)[]>): Result<(string | number)[], Context>;
arinfoBuffer(key: RedisKey, callback?: Callback<(Buffer | number)[]>): Result<(Buffer | number)[], Context>;
arinfo(key: RedisKey, full: 'FULL', callback?: Callback<(string | number)[]>): Result<(string | number)[], Context>;
arinfoBuffer(key: RedisKey, full: 'FULL', callback?: Callback<(Buffer | number)[]>): Result<(Buffer | number)[], Context>;
/**
* Inserts one or more values at consecutive indices.
* - _group_: array
* - _complexity_: O(N) where N is the number of values
* - _since_: 8.8.0
*/
arinsert(...args: [key: RedisKey, ...values: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
arinsert(...args: [key: RedisKey, ...values: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Returns the most recently inserted elements.
* - _group_: array
* - _complexity_: O(N) where N is the count
* - _since_: 8.8.0
*/
arlastitems(key: RedisKey, count: number | string, callback?: Callback<(string | null)[]>): Result<(string | null)[], Context>;
arlastitemsBuffer(key: RedisKey, count: number | string, callback?: Callback<(Buffer | null)[]>): Result<(Buffer | null)[], Context>;
arlastitems(key: RedisKey, count: number | string, rev: 'REV', callback?: Callback<(string | null)[]>): Result<(string | null)[], Context>;
arlastitemsBuffer(key: RedisKey, count: number | string, rev: 'REV', callback?: Callback<(Buffer | null)[]>): Result<(Buffer | null)[], Context>;
/**
* Returns the length of an array (max index + 1).
* - _group_: array
* - _complexity_: O(1)
* - _since_: 8.8.0
*/
arlen(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Gets values at multiple indices in an array.
* - _group_: array
* - _complexity_: O(N) where N is the number of indices
* - _since_: 8.8.0
*/
armget(...args: [key: RedisKey, ...indices: (number | string)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
armgetBuffer(...args: [key: RedisKey, ...indices: (number | string)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
armget(...args: [key: RedisKey, ...indices: (number | string)[]]): Result<(string | null)[], Context>;
armgetBuffer(...args: [key: RedisKey, ...indices: (number | string)[]]): Result<(Buffer | null)[], Context>;
/**
* Sets multiple index-value pairs in an array.
* - _group_: array
* - _complexity_: O(N) where N is the number of pairs
* - _since_: 8.8.0
*/
armset(...args: [key: RedisKey, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
armset(...args: [key: RedisKey, ...data: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Returns the next index ARINSERT would use.
* - _group_: array
* - _complexity_: O(1)
* - _since_: 8.8.0
*/
arnext(key: RedisKey, callback?: Callback<number | null>): Result<number | null, Context>;
/**
* Performs aggregate operations on array elements in a range.
* - _group_: array
* - _complexity_: O(P) where P is visited positions in touched slices (dense scanned slots + sparse entries), with worst-case O(|end-start|+1) and typical case close to O(N), where N is the number of existing elements in range.
* - _since_: 8.8.0
*/
arop(key: RedisKey, start: number | string, end: number | string, sum: 'SUM', callback?: Callback<string | null>): Result<string | null, Context>;
aropBuffer(key: RedisKey, start: number | string, end: number | string, sum: 'SUM', callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
arop(key: RedisKey, start: number | string, end: number | string, min: 'MIN', callback?: Callback<string | null>): Result<string | null, Context>;
aropBuffer(key: RedisKey, start: number | string, end: number | string, min: 'MIN', callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
arop(key: RedisKey, start: number | string, end: number | string, max: 'MAX', callback?: Callback<string | null>): Result<string | null, Context>;
aropBuffer(key: RedisKey, start: number | string, end: number | string, max: 'MAX', callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
arop(key: RedisKey, start: number | string, end: number | string, and: 'AND', callback?: Callback<number | null>): Result<number | null, Context>;
arop(key: RedisKey, start: number | string, end: number | string, or: 'OR', callback?: Callback<number | null>): Result<number | null, Context>;
arop(key: RedisKey, start: number | string, end: number | string, xor: 'XOR', callback?: Callback<number | null>): Result<number | null, Context>;
arop(key: RedisKey, start: number | string, end: number | string, match: 'MATCH', value: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
arop(key: RedisKey, start: number | string, end: number | string, used: 'USED', callback?: Callback<number>): Result<number, Context>;
/**
* Inserts values into a ring buffer of specified size, wrapping and truncating as needed.
* - _group_: array
* - _complexity_: O(M) normally, O(N+M) on ring resize, where N is the maximum of the old and new ring size and M is the number of inserted values
* - _since_: 8.8.0
*/
arring(...args: [key: RedisKey, size: number | string, ...values: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
arring(...args: [key: RedisKey, size: number | string, ...values: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Iterates existing elements in a range, returning index-value pairs.
* - _group_: array
* - _complexity_: O(P) where P is visited positions in touched slices (dense scanned slots + sparse entries), with worst-case O(|end-start|+1) and typical case close to O(N), where N is the number of existing elements in range.
* - _since_: 8.8.0
*/
arscan(key: RedisKey, start: number | string, end: number | string, callback?: Callback<Array<[index: number, value: string]>>): Result<Array<[index: number, value: string]>, Context>;
arscanBuffer(key: RedisKey, start: number | string, end: number | string, callback?: Callback<Array<[index: number, value: Buffer]>>): Result<Array<[index: number, value: Buffer]>, Context>;
arscan(key: RedisKey, start: number | string, end: number | string, limitToken: 'LIMIT', limit: number | string, callback?: Callback<Array<[index: number, value: string]>>): Result<Array<[index: number, value: string]>, Context>;
arscanBuffer(key: RedisKey, start: number | string, end: number | string, limitToken: 'LIMIT', limit: number | string, callback?: Callback<Array<[index: number, value: Buffer]>>): Result<Array<[index: number, value: Buffer]>, Context>;
/**
* Sets the ARINSERT / ARRING cursor to a specific index.
* - _group_: array
* - _complexity_: O(1)
* - _since_: 8.8.0
*/
arseek(key: RedisKey, index: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Sets one or more contiguous values starting at an index in an array.
* - _group_: array
* - _complexity_: O(N) where N is the number of values
* - _since_: 8.8.0
*/
arset(...args: [key: RedisKey, index: number | string, ...values: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
arset(...args: [key: RedisKey, index: number | string, ...values: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Signals that a cluster client is following an -ASK redirect.
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
asking(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Authenticate to the server
* - _group_: connection
* - _complexity_: O(N) where N is the number of passwords defined for the user
* - _since_: 1.0.0
*/
auth(password: string | Buffer, callback?: Callback<"OK">): Result<"OK", Context>;
auth(username: string | Buffer, password: string | Buffer, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Asynchronously rewrite the append-only file
* - _group_: server
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
bgrewriteaof(callback?: Callback<string>): Result<string, Context>;
bgrewriteaofBuffer(callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Asynchronously save the dataset to disk
* - _group_: server
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
bgsave(callback?: Callback<"OK">): Result<"OK", Context>;
bgsave(schedule: "SCHEDULE", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Count set bits in a string
* - _group_: bitmap
* - _complexity_: O(N)
* - _since_: 2.6.0
*/
bitcount(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
bitcount(key: RedisKey, start: number | string, end: number | string, callback?: Callback<number>): Result<number, Context>;
bitcount(key: RedisKey, start: number | string, end: number | string, byte: "BYTE", callback?: Callback<number>): Result<number, Context>;
bitcount(key: RedisKey, start: number | string, end: number | string, bit: "BIT", callback?: Callback<number>): Result<number, Context>;
/**
* Perform arbitrary bitfield integer operations on strings
* - _group_: bitmap
* - _complexity_: O(1) for each subcommand specified
* - _since_: 3.2.0
*/
bitfield(key: RedisKey, encodingOffsetToken: "GET", encoding: string | Buffer, offset: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, overflow: "OVERFLOW", wrap: "WRAP", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, overflow: "OVERFLOW", sat: "SAT", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetValueToken: "SET", encoding: string | Buffer, offset: number | string, value: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
bitfield(key: RedisKey, overflow: "OVERFLOW", fail: "FAIL", encodingOffsetIncrementToken: "INCRBY", encoding: string | Buffer, offset: number | string, increment: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Perform arbitrary bitfield integer operations on strings. Read-only variant of BITFIELD
* - _group_: bitmap
* - _complexity_: O(1) for each subcommand specified
* - _since_: 6.0.0
*/
bitfield_ro(...args: [
key: RedisKey,
encodingOffsetToken: "GET",
...encodingOffsets: (string | Buffer | number)[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
bitfield_ro(...args: [
key: RedisKey,
encodingOffsetToken: "GET",
...encodingOffsets: (string | Buffer | number)[]
]): Result<unknown[], Context>;
/**
* Perform bitwise operations between strings
* - _group_: bitmap
* - _complexity_: O(N)
* - _since_: 2.6.0
*/
bitop(...args: [
operation: string | Buffer,
destkey: RedisKey,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
bitop(...args: [
operation: string | Buffer,
destkey: RedisKey,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
bitop(...args: [
operation: string | Buffer,
destkey: RedisKey,
...keys: RedisKey[]
]): Result<number, Context>;
bitop(...args: [operation: string | Buffer, destkey: RedisKey, keys: RedisKey[]]): Result<number, Context>;
/**
* Find first bit set or clear in a string
* - _group_: bitmap
* - _complexity_: O(N)
* - _since_: 2.8.7
*/
bitpos(key: RedisKey, bit: number | string, callback?: Callback<number>): Result<number, Context>;
bitpos(key: RedisKey, bit: number | string, start: number | string, callback?: Callback<number>): Result<number, Context>;
bitpos(key: RedisKey, bit: number | string, start: number | string, end: number | string, callback?: Callback<number>): Result<number, Context>;
bitpos(key: RedisKey, bit: number | string, start: number | string, end: number | string, byte: "BYTE", callback?: Callback<number>): Result<number, Context>;
bitpos(key: RedisKey, bit: number | string, start: number | string, end: number | string, bit1: "BIT", callback?: Callback<number>): Result<number, Context>;
/**
* Pop an element from a list, push it to another list and return it; or block until one is available
* - _group_: list
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
blmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
blmoveBuffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", timeout: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
blmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
blmoveBuffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", timeout: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
blmoveBuffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", timeout: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
blmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
blmoveBuffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", timeout: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Pop elements from a list, or block until one is available
* - _group_: list
* - _complexity_: O(N+M) where N is the number of provided keys and M is the number of elements returned.
* - _since_: 7.0.0
*/
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT"
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT"
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT"
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT"
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT"
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT"
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT"
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT"
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
blmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
blmpopBuffer(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
/**
* Remove and get the first element in a list, or block until one is available
* - _group_: list
* - _complexity_: O(N) where N is the number of provided keys.
* - _since_: 2.0.0
*/
blpop(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[string, string] | null>
]): Result<[string, string] | null, Context>;
blpopBuffer(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[Buffer, Buffer] | null>
]): Result<[Buffer, Buffer] | null, Context>;
blpop(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[string, string] | null>
]): Result<[string, string] | null, Context>;
blpopBuffer(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[Buffer, Buffer] | null>
]): Result<[Buffer, Buffer] | null, Context>;
blpop(...args: [...keys: RedisKey[], timeout: number | string]): Result<[string, string] | null, Context>;
blpopBuffer(...args: [...keys: RedisKey[], timeout: number | string]): Result<[Buffer, Buffer] | null, Context>;
blpop(...args: [keys: RedisKey[], timeout: number | string]): Result<[string, string] | null, Context>;
blpopBuffer(...args: [keys: RedisKey[], timeout: number | string]): Result<[Buffer, Buffer] | null, Context>;
/**
* Remove and get the last element in a list, or block until one is available
* - _group_: list
* - _complexity_: O(N) where N is the number of provided keys.
* - _since_: 2.0.0
*/
brpop(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[string, string] | null>
]): Result<[string, string] | null, Context>;
brpopBuffer(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[Buffer, Buffer] | null>
]): Result<[Buffer, Buffer] | null, Context>;
brpop(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[string, string] | null>
]): Result<[string, string] | null, Context>;
brpopBuffer(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[Buffer, Buffer] | null>
]): Result<[Buffer, Buffer] | null, Context>;
brpop(...args: [...keys: RedisKey[], timeout: number | string]): Result<[string, string] | null, Context>;
brpopBuffer(...args: [...keys: RedisKey[], timeout: number | string]): Result<[Buffer, Buffer] | null, Context>;
brpop(...args: [keys: RedisKey[], timeout: number | string]): Result<[string, string] | null, Context>;
brpopBuffer(...args: [keys: RedisKey[], timeout: number | string]): Result<[Buffer, Buffer] | null, Context>;
/**
* Pop an element from a list, push it to another list and return it; or block until one is available
* - _group_: list
* - _complexity_: O(1)
* - _since_: 2.2.0
*/
brpoplpush(source: RedisKey, destination: RedisKey, timeout: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
brpoplpushBuffer(source: RedisKey, destination: RedisKey, timeout: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Remove and return members with scores in a sorted set or block until one is available
* - _group_: sorted-set
* - _complexity_: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.
* - _since_: 7.0.0
*/
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
min: "MIN",
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
min: "MIN",
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
min: "MIN"
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
min: "MIN"
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
max: "MAX",
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
max: "MAX",
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
max: "MAX"
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
max: "MAX"
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
...keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
bzmpop(...args: [
timeout: number | string,
numkeys: number | string,
keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
/**
* Remove and return the member with the highest score from one or more sorted sets, or block until one is available
* - _group_: sorted-set
* - _complexity_: O(log(N)) with N being the number of elements in the sorted set.
* - _since_: 5.0.0
*/
bzpopmax(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: string, member: string, score: string] | null>
]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopmaxBuffer(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: Buffer, member: Buffer, score: Buffer] | null>
]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
bzpopmax(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: string, member: string, score: string] | null>
]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopmaxBuffer(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: Buffer, member: Buffer, score: Buffer] | null>
]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
bzpopmax(...args: [...keys: RedisKey[], timeout: number | string]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopmaxBuffer(...args: [...keys: RedisKey[], timeout: number | string]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
bzpopmax(...args: [keys: RedisKey[], timeout: number | string]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopmaxBuffer(...args: [keys: RedisKey[], timeout: number | string]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
/**
* Remove and return the member with the lowest score from one or more sorted sets, or block until one is available
* - _group_: sorted-set
* - _complexity_: O(log(N)) with N being the number of elements in the sorted set.
* - _since_: 5.0.0
*/
bzpopmin(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: string, member: string, score: string] | null>
]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopminBuffer(...args: [
...keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: Buffer, member: Buffer, score: Buffer] | null>
]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
bzpopmin(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: string, member: string, score: string] | null>
]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopminBuffer(...args: [
keys: RedisKey[],
timeout: number | string,
callback: Callback<[key: Buffer, member: Buffer, score: Buffer] | null>
]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
bzpopmin(...args: [...keys: RedisKey[], timeout: number | string]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopminBuffer(...args: [...keys: RedisKey[], timeout: number | string]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
bzpopmin(...args: [keys: RedisKey[], timeout: number | string]): Result<[key: string, member: string, score: string] | null, Context>;
bzpopminBuffer(...args: [keys: RedisKey[], timeout: number | string]): Result<[key: Buffer, member: Buffer, score: Buffer] | null, Context>;
/**
* Instruct the server about tracking or not keys in the next request
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 6.0.0
*/
client(subcommand: "CACHING", yes: "YES", callback?: Callback<"OK">): Result<"OK", Context>;
client(subcommand: "CACHING", no: "NO", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Get the current connection name
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 2.6.9
*/
client(subcommand: "GETNAME", callback?: Callback<string | null>): Result<string | null, Context>;
clientBuffer(subcommand: "GETNAME", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Get tracking notifications redirection client ID if any
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 6.0.0
*/
client(subcommand: "GETREDIR", callback?: Callback<number>): Result<number, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
client(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Returns the client ID for the current connection
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
client(subcommand: "ID", callback?: Callback<number>): Result<number, Context>;
/**
* Returns information about the current client connection.
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
client(subcommand: "INFO", callback?: Callback<string>): Result<string, Context>;
clientBuffer(subcommand: "INFO", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Kill the connection of a client
* - _group_: connection
* - _complexity_: O(N) where N is the number of client connections
* - _since_: 2.4.0
*/
client(...args: [
subcommand: "KILL",
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
client(...args: [subcommand: "KILL", ...args: RedisValue[]]): Result<unknown, Context>;
/**
* Get the list of client connections
* - _group_: connection
* - _complexity_: O(N) where N is the number of client connections
* - _since_: 2.4.0
*/
client(subcommand: "LIST", callback?: Callback<unknown>): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
idToken: "ID",
...clientIds: (number | string)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
idToken: "ID",
...clientIds: (number | string)[]
]): Result<unknown, Context>;
client(subcommand: "LIST", type: "TYPE", normal: "NORMAL", callback?: Callback<unknown>): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
normal: "NORMAL",
idToken: "ID",
...clientIds: (number | string)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
normal: "NORMAL",
idToken: "ID",
...clientIds: (number | string)[]
]): Result<unknown, Context>;
client(subcommand: "LIST", type: "TYPE", master: "MASTER", callback?: Callback<unknown>): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
master: "MASTER",
idToken: "ID",
...clientIds: (number | string)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
master: "MASTER",
idToken: "ID",
...clientIds: (number | string)[]
]): Result<unknown, Context>;
client(subcommand: "LIST", type: "TYPE", replica: "REPLICA", callback?: Callback<unknown>): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
replica: "REPLICA",
idToken: "ID",
...clientIds: (number | string)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
replica: "REPLICA",
idToken: "ID",
...clientIds: (number | string)[]
]): Result<unknown, Context>;
client(subcommand: "LIST", type: "TYPE", pubsub: "PUBSUB", callback?: Callback<unknown>): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
pubsub: "PUBSUB",
idToken: "ID",
...clientIds: (number | string)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
client(...args: [
subcommand: "LIST",
type: "TYPE",
pubsub: "PUBSUB",
idToken: "ID",
...clientIds: (number | string)[]
]): Result<unknown, Context>;
/**
* Set client eviction mode for the current connection
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
client(subcommand: "NO-EVICT", on: "ON", callback?: Callback<unknown>): Result<unknown, Context>;
client(subcommand: "NO-EVICT", off: "OFF", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Stop processing commands from clients for some time
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 2.9.50
*/
client(subcommand: "PAUSE", timeout: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
client(subcommand: "PAUSE", timeout: number | string, write: "WRITE", callback?: Callback<"OK">): Result<"OK", Context>;
client(subcommand: "PAUSE", timeout: number | string, all: "ALL", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Instruct the server whether to reply to commands
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 3.2.0
*/
client(subcommand: "REPLY", on: "ON", callback?: Callback<unknown>): Result<unknown, Context>;
client(subcommand: "REPLY", off: "OFF", callback?: Callback<unknown>): Result<unknown, Context>;
client(subcommand: "REPLY", skip: "SKIP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Set the current connection name
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 2.6.9
*/
client(subcommand: "SETNAME", connectionName: string | Buffer, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Enable or disable server assisted client side caching support
* - _group_: connection
* - _complexity_: O(1). Some options may introduce additional complexity.
* - _since_: 6.0.0
*/
client(...args: [
subcommand: "TRACKING",
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
client(...args: [subcommand: "TRACKING", ...args: RedisValue[]]): Result<unknown, Context>;
/**
* Return information about server assisted client side caching for the current connection
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
client(subcommand: "TRACKINGINFO", callback?: Callback<string>): Result<string, Context>;
clientBuffer(subcommand: "TRACKINGINFO", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Unblock a client blocked in a blocking command from a different connection
* - _group_: connection
* - _complexity_: O(log N) where N is the number of client connections
* - _since_: 5.0.0
*/
client(subcommand: "UNBLOCK", clientId: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
client(subcommand: "UNBLOCK", clientId: number | string, timeout: "TIMEOUT", callback?: Callback<unknown>): Result<unknown, Context>;
client(subcommand: "UNBLOCK", clientId: number | string, error: "ERROR", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Resume processing of clients that were paused
* - _group_: connection
* - _complexity_: O(N) Where N is the number of paused clients
* - _since_: 6.2.0
*/
client(subcommand: "UNPAUSE", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Assign new hash slots to receiving node
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of hash slot arguments
* - _since_: 3.0.0
*/
cluster(...args: [
subcommand: "ADDSLOTS",
...slots: (number | string)[],
callback: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [
subcommand: "ADDSLOTS",
slots: (number | string)[],
callback: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [subcommand: "ADDSLOTS", ...slots: (number | string)[]]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [subcommand: "ADDSLOTS", slots: (number | string)[]]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
/**
* Assign new hash slots to receiving node
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of the slots between the start slot and end slot arguments.
* - _since_: 7.0.0
*/
cluster(...args: [
subcommand: "ADDSLOTSRANGE",
...startSlotEndSlots: (string | number)[],
callback: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [
subcommand: "ADDSLOTSRANGE",
...startSlotEndSlots: (string | number)[]
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
/**
* Advance the cluster config epoch
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "BUMPEPOCH", callback?: Callback<"BUMPED" | "STILL">): Result<"BUMPED" | "STILL", Context>;
/**
* Return the number of failure reports active for a given node
* - _group_: cluster
* - _complexity_: O(N) where N is the number of failure reports
* - _since_: 3.0.0
*/
cluster(subcommand: "COUNT-FAILURE-REPORTS", nodeId: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Return the number of local keys in the specified hash slot
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "COUNTKEYSINSLOT", slot: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Set hash slots as unbound in receiving node
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of hash slot arguments
* - _since_: 3.0.0
*/
cluster(...args: [
subcommand: "DELSLOTS",
...slots: (number | string)[],
callback: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [
subcommand: "DELSLOTS",
slots: (number | string)[],
callback: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [subcommand: "DELSLOTS", ...slots: (number | string)[]]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [subcommand: "DELSLOTS", slots: (number | string)[]]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
/**
* Set hash slots as unbound in receiving node
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of the slots between the start slot and end slot arguments.
* - _since_: 7.0.0
*/
cluster(...args: [
subcommand: "DELSLOTSRANGE",
...startSlotEndSlots: (string | number)[],
callback: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
cluster(...args: [
subcommand: "DELSLOTSRANGE",
...startSlotEndSlots: (string | number)[]
]): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
/**
* Forces a replica to perform a manual failover of its master.
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "FAILOVER", callback?: Callback<"OK">): Result<"OK", Context>;
cluster(subcommand: "FAILOVER", force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
cluster(subcommand: "FAILOVER", takeover: "TAKEOVER", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Delete a node's own slots information
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "FLUSHSLOTS", callback?: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
/**
* Remove a node from the nodes table
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "FORGET", nodeId: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Return local key names in the specified hash slot
* - _group_: cluster
* - _complexity_: O(log(N)) where N is the number of requested keys
* - _since_: 3.0.0
*/
cluster(subcommand: "GETKEYSINSLOT", slot: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
/**
* Show helpful text about the different subcommands
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
cluster(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Provides info about Redis Cluster node state
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "INFO", callback?: Callback<string>): Result<string, Context>;
/**
* Returns the hash slot of the specified key
* - _group_: cluster
* - _complexity_: O(N) where N is the number of bytes in the key
* - _since_: 3.0.0
*/
cluster(subcommand: "KEYSLOT", key: string | Buffer, callback?: Callback<number>): Result<number, Context>;
/**
* Returns a list of all TCP links to and from peer nodes in cluster
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of Cluster nodes
* - _since_: 7.0.0
*/
cluster(subcommand: "LINKS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Force a node cluster to handshake with another node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "MEET", ip: string | Buffer, port: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Return the node id
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "MYID", callback?: Callback<string>): Result<string, Context>;
/**
* Get Cluster config for the node
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of Cluster nodes
* - _since_: 3.0.0
*/
cluster(subcommand: "NODES", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* List replica nodes of the specified master node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
cluster(subcommand: "REPLICAS", nodeId: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Reconfigure a node as a replica of the specified master node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "REPLICATE", nodeId: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Reset a Redis Cluster node
* - _group_: cluster
* - _complexity_: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect.
* - _since_: 3.0.0
*/
cluster(subcommand: "RESET", callback?: Callback<"OK">): Result<"OK", Context>;
cluster(subcommand: "RESET", hard: "HARD", callback?: Callback<"OK">): Result<"OK", Context>;
cluster(subcommand: "RESET", soft: "SOFT", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Forces the node to save cluster state on disk
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "SAVECONFIG", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Set the configuration epoch in a new node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "SET-CONFIG-EPOCH", configEpoch: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Bind a hash slot to a specific node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "SETSLOT", slot: number | string, nodeIdToken: "IMPORTING", nodeId: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
cluster(subcommand: "SETSLOT", slot: number | string, nodeIdToken: "MIGRATING", nodeId: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
cluster(subcommand: "SETSLOT", slot: number | string, nodeIdToken: "NODE", nodeId: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
cluster(subcommand: "SETSLOT", slot: number | string, stable: "STABLE", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Get array of cluster slots to node mappings
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of cluster nodes
* - _since_: 7.0.0
*/
cluster(subcommand: "SHARDS", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* List replica nodes of the specified master node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
cluster(subcommand: "SLAVES", nodeId: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get array of Cluster slot to node mappings
* - _group_: cluster
* - _complexity_: O(N) where N is the total number of Cluster nodes
* - _since_: 3.0.0
*/
cluster(subcommand: "SLOTS", callback?: Callback<[
startSlotRange: number,
endSlotRange: number,
...nodes: [
host: string,
port: number,
nodeId: string,
info: unknown[]
][]
][]>): Result<[
startSlotRange: number,
endSlotRange: number,
...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][], Context>;
/**
* Get total number of Redis commands
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.13
*/
command(subcommand: "COUNT", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Get array of specific Redis command documentation
* - _group_: server
* - _complexity_: O(N) where N is the number of commands to look up
* - _since_: 7.0.0
*/
command(subcommand: "DOCS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
command(...args: [
subcommand: "DOCS",
...commandNames: (string | Buffer)[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
command(...args: [subcommand: "DOCS", ...commandNames: (string | Buffer)[]]): Result<unknown[], Context>;
/**
* Extract keys given a full Redis command
* - _group_: server
* - _complexity_: O(N) where N is the number of arguments to the command
* - _since_: 2.8.13
*/
command(subcommand: "GETKEYS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Extract keys and access flags given a full Redis command
* - _group_: server
* - _complexity_: O(N) where N is the number of arguments to the command
* - _since_: 7.0.0
*/
command(subcommand: "GETKEYSANDFLAGS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Show helpful text about the different subcommands
* - _group_: server
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
command(subcommand: "HELP", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Get array of specific Redis command details, or all when no argument is given.
* - _group_: server
* - _complexity_: O(N) where N is the number of commands to look up
* - _since_: 2.8.13
*/
command(subcommand: "INFO", callback?: Callback<unknown[]>): Result<unknown[], Context>;
command(...args: [
subcommand: "INFO",
...commandNames: (string | Buffer)[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
command(...args: [subcommand: "INFO", ...commandNames: (string | Buffer)[]]): Result<unknown[], Context>;
/**
* Get an array of Redis command names
* - _group_: server
* - _complexity_: O(N) where N is the total number of Redis commands
* - _since_: 7.0.0
*/
command(subcommand: "LIST", callback?: Callback<unknown[]>): Result<unknown[], Context>;
command(subcommand: "LIST", filterby: "FILTERBY", moduleNameToken: "MODULE", moduleName: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
command(subcommand: "LIST", filterby: "FILTERBY", categoryToken: "ACLCAT", category: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
command(subcommand: "LIST", filterby: "FILTERBY", patternToken: "PATTERN", pattern: string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Get the values of configuration parameters
* - _group_: server
* - _complexity_: O(N) when N is the number of configuration parameters provided
* - _since_: 2.0.0
*/
config(...args: [
subcommand: "GET",
...parameters: (string | Buffer)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
config(...args: [subcommand: "GET", ...parameters: (string | Buffer)[]]): Result<unknown, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: server
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
config(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Reset the stats returned by INFO
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.0.0
*/
config(subcommand: "RESETSTAT", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Rewrite the configuration file with the in memory configuration
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.0
*/
config(subcommand: "REWRITE", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Set configuration parameters to the given values
* - _group_: server
* - _complexity_: O(N) when N is the number of configuration parameters provided
* - _since_: 2.0.0
*/
config(...args: [
subcommand: "SET",
...parameterValues: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
config(...args: [
subcommand: "SET",
...parameterValues: (string | Buffer | number)[]
]): Result<unknown, Context>;
/**
* Copy a key
* - _group_: generic
* - _complexity_: O(N) worst case for collections, where N is the number of nested items. O(1) for string values.
* - _since_: 6.2.0
*/
copy(source: RedisKey, destination: RedisKey, callback?: Callback<number>): Result<number, Context>;
copy(source: RedisKey, destination: RedisKey, replace: "REPLACE", callback?: Callback<number>): Result<number, Context>;
copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: number | string, callback?: Callback<number>): Result<number, Context>;
copy(source: RedisKey, destination: RedisKey, destinationDbToken: "DB", destinationDb: number | string, replace: "REPLACE", callback?: Callback<number>): Result<number, Context>;
/**
* Return the number of keys in the selected database
* - _group_: server
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
dbsize(callback?: Callback<number>): Result<number, Context>;
/**
* A container for debugging commands
* - _group_: server
* - _complexity_: Depends on subcommand.
* - _since_: 1.0.0
*/
debug(subcommand: string, callback?: Callback<unknown>): Result<unknown, Context>;
debug(...args: [
subcommand: string,
...args: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
debug(...args: [subcommand: string, ...args: (string | Buffer | number)[]]): Result<unknown, Context>;
/**
* Decrement the integer value of a key by one
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
decr(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Decrement the integer value of a key by the given number
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
decrby(key: RedisKey, decrement: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Delete a key
* - _group_: generic
* - _complexity_: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1).
* - _since_: 1.0.0
*/
del(...args: [...keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
del(...args: [keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
del(...args: [...keys: RedisKey[]]): Result<number, Context>;
del(...args: [keys: RedisKey[]]): Result<number, Context>;
/**
* Discard all commands issued after MULTI
* - _group_: transactions
* - _complexity_: O(N), when N is the number of queued commands
* - _since_: 2.0.0
*/
discard(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Return a serialized version of the value stored at the specified key.
* - _group_: generic
* - _complexity_: O(1) to access the key and additional O(N*M) to serialize it, 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).
* - _since_: 2.6.0
*/
dump(key: RedisKey, callback?: Callback<string>): Result<string, Context>;
dumpBuffer(key: RedisKey, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Echo the given string
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
echo(message: string | Buffer, callback?: Callback<string>): Result<string, Context>;
echoBuffer(message: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Execute a Lua script server side
* - _group_: scripting
* - _complexity_: Depends on the script that is executed.
* - _since_: 2.6.0
*/
eval(script: string | Buffer, numkeys: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
...args: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
...args: (string | Buffer | number)[]
]): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<unknown>
]): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
keys: RedisKey[],
callback: Callback<unknown>
]): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
...keys: RedisKey[]
]): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
keys: RedisKey[]
]): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
eval(...args: [
script: string | Buffer,
numkeys: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Execute a read-only Lua script server side
* - _group_: scripting
* - _complexity_: Depends on the script that is executed.
* - _since_: 7.0.0
*/
eval_ro(...args: [
script: string | Buffer,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
eval_ro(...args: [
script: string | Buffer,
numkeys: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Execute a Lua script server side
* - _group_: scripting
* - _complexity_: Depends on the script that is executed.
* - _since_: 2.6.0
*/
evalsha(sha1: string | Buffer, numkeys: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
evalsha(...args: [
sha1: string | Buffer,
numkeys: number | string,
...args: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
evalsha(...args: [
sha1: string | Buffer,
numkeys: number | string,
...args: (string | Buffer | number)[]
]): Result<unknown, Context>;
evalsha(...args: [
sha1: string | Buffer,
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<unknown>
]): Result<unknown, Context>;
evalsha(...args: [
sha1: string | Buffer,
numkeys: number | string,
keys: RedisKey[],
callback: Callback<unknown>
]): Result<unknown, Context>;
evalsha(...args: [
sha1: string | Buffer,
numkeys: number | string,
...keys: RedisKey[]
]): Result<unknown, Context>;
evalsha(...args: [sha1: string | Buffer, numkeys: number | string, keys: RedisKey[]]): Result<unknown, Context>;
evalsha(...args: [
sha1: string | Buffer,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
evalsha(...args: [
sha1: string | Buffer,
numkeys: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Execute a read-only Lua script server side
* - _group_: scripting
* - _complexity_: Depends on the script that is executed.
* - _since_: 7.0.0
*/
evalsha_ro(...args: [
sha1: string | Buffer,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
evalsha_ro(...args: [
sha1: string | Buffer,
numkeys: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Execute all commands issued after MULTI
* - _group_: transactions
* - _complexity_: Depends on commands in the transaction
* - _since_: 1.2.0
*/
exec(callback?: Callback<[error: Error | null, result: unknown][] | null>): Promise<[error: Error | null, result: unknown][] | null>;
/**
* Determine if a key exists
* - _group_: generic
* - _complexity_: O(N) where N is the number of keys to check.
* - _since_: 1.0.0
*/
exists(...args: [...keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
exists(...args: [keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
exists(...args: [...keys: RedisKey[]]): Result<number, Context>;
exists(...args: [keys: RedisKey[]]): Result<number, Context>;
/**
* Set a key's time to live in seconds
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
expire(key: RedisKey, seconds: number | string, callback?: Callback<number>): Result<number, Context>;
expire(key: RedisKey, seconds: number | string, nx: "NX", callback?: Callback<number>): Result<number, Context>;
expire(key: RedisKey, seconds: number | string, xx: "XX", callback?: Callback<number>): Result<number, Context>;
expire(key: RedisKey, seconds: number | string, gt: "GT", callback?: Callback<number>): Result<number, Context>;
expire(key: RedisKey, seconds: number | string, lt: "LT", callback?: Callback<number>): Result<number, Context>;
/**
* Set the expiration for a key as a UNIX timestamp
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.2.0
*/
expireat(key: RedisKey, unixTimeSeconds: number | string, callback?: Callback<number>): Result<number, Context>;
expireat(key: RedisKey, unixTimeSeconds: number | string, nx: "NX", callback?: Callback<number>): Result<number, Context>;
expireat(key: RedisKey, unixTimeSeconds: number | string, xx: "XX", callback?: Callback<number>): Result<number, Context>;
expireat(key: RedisKey, unixTimeSeconds: number | string, gt: "GT", callback?: Callback<number>): Result<number, Context>;
expireat(key: RedisKey, unixTimeSeconds: number | string, lt: "LT", callback?: Callback<number>): Result<number, Context>;
/**
* Get the expiration Unix timestamp for a key
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
expiretime(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Start a coordinated failover between this server and one of its replicas.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
failover(callback?: Callback<"OK">): Result<"OK", Context>;
failover(millisecondsToken: "TIMEOUT", milliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
failover(abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
failover(abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, millisecondsToken: "TIMEOUT", milliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, force: "FORCE", millisecondsToken: "TIMEOUT", milliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
failover(targetToken: "TO", host: string | Buffer, port: number | string, force: "FORCE", abort: "ABORT", millisecondsToken: "TIMEOUT", milliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Invoke a function
* - _group_: scripting
* - _complexity_: Depends on the function that is executed.
* - _since_: 7.0.0
*/
fcall(...args: [
function: string | Buffer,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
fcall(...args: [
function: string | Buffer,
numkeys: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Invoke a read-only function
* - _group_: scripting
* - _complexity_: Depends on the function that is executed.
* - _since_: 7.0.0
*/
fcall_ro(...args: [
function: string | Buffer,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
fcall_ro(...args: [
function: string | Buffer,
numkeys: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Remove all keys from all databases
* - _group_: server
* - _complexity_: O(N) where N is the total number of keys in all databases
* - _since_: 1.0.0
*/
flushall(callback?: Callback<"OK">): Result<"OK", Context>;
flushall(async: "ASYNC", callback?: Callback<"OK">): Result<"OK", Context>;
flushall(sync: "SYNC", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Remove all keys from the current database
* - _group_: server
* - _complexity_: O(N) where N is the number of keys in the selected database
* - _since_: 1.0.0
*/
flushdb(callback?: Callback<"OK">): Result<"OK", Context>;
flushdb(async: "ASYNC", callback?: Callback<"OK">): Result<"OK", Context>;
flushdb(sync: "SYNC", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Delete a function by name
* - _group_: scripting
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
function(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "DELETE", libraryName: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Dump all functions into a serialized binary payload
* - _group_: scripting
* - _complexity_: O(N) where N is the number of functions
* - _since_: 7.0.0
*/
function(subcommand: "DUMP", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "DUMP", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Deleting all functions
* - _group_: scripting
* - _complexity_: O(N) where N is the number of functions deleted
* - _since_: 7.0.0
*/
function(subcommand: "FLUSH", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "FLUSH", callback?: Callback<Buffer>): Result<Buffer, Context>;
function(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<Buffer>): Result<Buffer, Context>;
function(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: scripting
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
function(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Kill the function currently in execution.
* - _group_: scripting
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
function(subcommand: "KILL", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "KILL", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* List information about all the functions
* - _group_: scripting
* - _complexity_: O(N) where N is the number of functions
* - _since_: 7.0.0
*/
function(subcommand: "LIST", callback?: Callback<unknown[]>): Result<unknown[], Context>;
function(subcommand: "LIST", withcode: "WITHCODE", callback?: Callback<unknown[]>): Result<unknown[], Context>;
function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
function(subcommand: "LIST", libraryNamePatternToken: "LIBRARYNAME", libraryNamePattern: string | Buffer, withcode: "WITHCODE", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Create a function with the given arguments (name, code, description)
* - _group_: scripting
* - _complexity_: O(1) (considering compilation time is redundant)
* - _since_: 7.0.0
*/
function(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "LOAD", functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
function(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "LOAD", replace: "REPLACE", functionCode: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Restore all the functions on the given payload
* - _group_: scripting
* - _complexity_: O(N) where N is the number of functions on the payload
* - _since_: 7.0.0
*/
function(subcommand: "RESTORE", serializedValue: string | Buffer | number, callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "RESTORE", serializedValue: string | Buffer | number, callback?: Callback<Buffer>): Result<Buffer, Context>;
function(subcommand: "RESTORE", serializedValue: string | Buffer | number, flush: "FLUSH", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "RESTORE", serializedValue: string | Buffer | number, flush: "FLUSH", callback?: Callback<Buffer>): Result<Buffer, Context>;
function(subcommand: "RESTORE", serializedValue: string | Buffer | number, append: "APPEND", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "RESTORE", serializedValue: string | Buffer | number, append: "APPEND", callback?: Callback<Buffer>): Result<Buffer, Context>;
function(subcommand: "RESTORE", serializedValue: string | Buffer | number, replace: "REPLACE", callback?: Callback<string>): Result<string, Context>;
functionBuffer(subcommand: "RESTORE", serializedValue: string | Buffer | number, replace: "REPLACE", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Return information about the function currently running (name, description, duration)
* - _group_: scripting
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
function(subcommand: "STATS", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Add one or more geospatial items in the geospatial index represented using a sorted set
* - _group_: geo
* - _complexity_: O(log(N)) for each item added, where N is the number of elements in the sorted set.
* - _since_: 3.2.0
*/
geoadd(...args: [
key: RedisKey,
...longitudeLatitudeMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
...longitudeLatitudeMembers: (string | Buffer | number)[]
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
ch: "CH",
...longitudeLatitudeMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
ch: "CH",
...longitudeLatitudeMembers: (string | Buffer | number)[]
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
nx: "NX",
...longitudeLatitudeMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
nx: "NX",
...longitudeLatitudeMembers: (string | Buffer | number)[]
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
...longitudeLatitudeMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
...longitudeLatitudeMembers: (string | Buffer | number)[]
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
xx: "XX",
...longitudeLatitudeMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
xx: "XX",
...longitudeLatitudeMembers: (string | Buffer | number)[]
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
...longitudeLatitudeMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
geoadd(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
...longitudeLatitudeMembers: (string | Buffer | number)[]
]): Result<number, Context>;
/**
* Returns the distance between two members of a geospatial index
* - _group_: geo
* - _complexity_: O(log(N))
* - _since_: 3.2.0
*/
geodist(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, callback?: Callback<string | null>): Result<string | null, Context>;
geodistBuffer(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
geodist(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, m: "M", callback?: Callback<string | null>): Result<string | null, Context>;
geodistBuffer(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, m: "M", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
geodist(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, km: "KM", callback?: Callback<string | null>): Result<string | null, Context>;
geodistBuffer(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, km: "KM", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
geodist(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, ft: "FT", callback?: Callback<string | null>): Result<string | null, Context>;
geodistBuffer(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, ft: "FT", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
geodist(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, mi: "MI", callback?: Callback<string | null>): Result<string | null, Context>;
geodistBuffer(key: RedisKey, member1: string | Buffer | number, member2: string | Buffer | number, mi: "MI", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Returns members of a geospatial index as standard geohash strings
* - _group_: geo
* - _complexity_: O(log(N)) for each member requested, where N is the number of elements in the sorted set.
* - _since_: 3.2.0
*/
geohash(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<string[]>
]): Result<string[], Context>;
geohashBuffer(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
geohash(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<string[]>
]): Result<string[], Context>;
geohashBuffer(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
geohash(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<string[], Context>;
geohashBuffer(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<Buffer[], Context>;
geohash(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<string[], Context>;
geohashBuffer(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<Buffer[], Context>;
/**
* Returns longitude and latitude of members of a geospatial index
* - _group_: geo
* - _complexity_: O(N) where N is the number of members requested.
* - _since_: 3.2.0
*/
geopos(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<([longitude: string, latitude: string] | null)[]>
]): Result<([longitude: string, latitude: string] | null)[], Context>;
geopos(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<([longitude: string, latitude: string] | null)[]>
]): Result<([longitude: string, latitude: string] | null)[], Context>;
geopos(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<([longitude: string, latitude: string] | null)[], Context>;
geopos(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<([longitude: string, latitude: string] | null)[], Context>;
/**
* Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point
* - _group_: geo
* - _complexity_: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
* - _since_: 3.2.0
*/
georadius(...args: [
key: RedisKey,
longitude: number | string,
latitude: number | string,
radius: number | string,
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
georadius(...args: [
key: RedisKey,
longitude: number | string,
latitude: number | string,
radius: number | string,
...args: RedisValue[]
]): Result<unknown[], Context>;
/**
* A read-only variant for GEORADIUS
* - _group_: geo
* - _complexity_: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
* - _since_: 3.2.10
*/
georadius_ro(...args: [
key: RedisKey,
longitude: number | string,
latitude: number | string,
radius: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
georadius_ro(...args: [
key: RedisKey,
longitude: number | string,
latitude: number | string,
radius: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member
* - _group_: geo
* - _complexity_: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
* - _since_: 3.2.0
*/
georadiusbymember(...args: [
key: RedisKey,
member: string | Buffer | number,
radius: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
georadiusbymember(...args: [
key: RedisKey,
member: string | Buffer | number,
radius: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* A read-only variant for GEORADIUSBYMEMBER
* - _group_: geo
* - _complexity_: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
* - _since_: 3.2.10
*/
georadiusbymember_ro(...args: [
key: RedisKey,
member: string | Buffer | number,
radius: number | string,
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
georadiusbymember_ro(...args: [
key: RedisKey,
member: string | Buffer | number,
radius: number | string,
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.
* - _group_: geo
* - _complexity_: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
* - _since_: 6.2.0
*/
geosearch(...args: [
key: RedisKey,
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
geosearch(...args: [key: RedisKey, ...args: RedisValue[]]): Result<unknown[], Context>;
/**
* Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key.
* - _group_: geo
* - _complexity_: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
* - _since_: 6.2.0
*/
geosearchstore(...args: [
destination: RedisKey,
source: RedisKey,
...args: RedisValue[],
callback: Callback<number>
]): Result<number, Context>;
geosearchstore(...args: [destination: RedisKey, source: RedisKey, ...args: RedisValue[]]): Result<number, Context>;
/**
* Get the value of a key
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
get(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
getBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Returns the bit value at offset in the string value stored at key
* - _group_: bitmap
* - _complexity_: O(1)
* - _since_: 2.2.0
*/
getbit(key: RedisKey, offset: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Get the value of a key and delete the key
* - _group_: string
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
getdel(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
getdelBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Get the value of a key and optionally set its expiration
* - _group_: string
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
getex(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
getexBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
getex(key: RedisKey, secondsToken: "EX", seconds: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
getexBuffer(key: RedisKey, secondsToken: "EX", seconds: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
getex(key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
getexBuffer(key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
getex(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
getexBuffer(key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
getex(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
getexBuffer(key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
getex(key: RedisKey, persist: "PERSIST", callback?: Callback<string | null>): Result<string | null, Context>;
getexBuffer(key: RedisKey, persist: "PERSIST", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Get a substring of the string stored at a key
* - _group_: string
* - _complexity_: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
* - _since_: 2.4.0
*/
getrange(key: RedisKey, start: number | string, end: number | string, callback?: Callback<string>): Result<string, Context>;
getrangeBuffer(key: RedisKey, start: number | string, end: number | string, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Set the string value of a key and return its old value
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
getset(key: RedisKey, value: string | Buffer | number, callback?: Callback<string | null>): Result<string | null, Context>;
getsetBuffer(key: RedisKey, value: string | Buffer | number, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Delete one or more hash fields
* - _group_: hash
* - _complexity_: O(N) where N is the number of fields to be removed.
* - _since_: 2.0.0
*/
hdel(...args: [
key: RedisKey,
...fields: (string | Buffer)[],
callback: Callback<number>
]): Result<number, Context>;
hdel(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Result<number, Context>;
/**
* Handshake with Redis
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 6.0.0
*/
hello(callback?: Callback<unknown[]>): Result<unknown[], Context>;
hello(protover: number | string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
hello(protover: number | string, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
hello(protover: number | string, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
hello(protover: number | string, usernamePasswordToken: "AUTH", username: string | Buffer, password: string | Buffer, clientnameToken: "SETNAME", clientname: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Determine if a hash field exists
* - _group_: hash
* - _complexity_: O(1)
* - _since_: 2.0.0
*/
hexists(key: RedisKey, field: string | Buffer, callback?: Callback<number>): Result<number, Context>;
/**
* Set expiry for hash field using relative time to expire (seconds)
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hexpire(...args: [key: RedisKey, seconds: number | string, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, nx: 'NX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, nx: 'NX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, xx: 'XX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, xx: 'XX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, gt: 'GT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, gt: 'GT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, lt: 'LT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpire(...args: [key: RedisKey, seconds: number | string, lt: 'LT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Set expiry for hash field using an absolute Unix timestamp (seconds)
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, nx: 'NX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, nx: 'NX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, xx: 'XX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, xx: 'XX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, gt: 'GT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, gt: 'GT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, lt: 'LT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpireat(...args: [key: RedisKey, unixTimeSeconds: number | string, lt: 'LT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Returns the expiration time of a hash field as a Unix timestamp, in seconds.
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hexpiretime(...args: [key: RedisKey, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hexpiretime(...args: [key: RedisKey, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Get the value of a hash field
* - _group_: hash
* - _complexity_: O(1)
* - _since_: 2.0.0
*/
hget(key: RedisKey, field: string | Buffer, callback?: Callback<string | null>): Result<string | null, Context>;
hgetBuffer(key: RedisKey, field: string | Buffer, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Get all the fields and values in a hash
* - _group_: hash
* - _complexity_: O(N) where N is the size of the hash.
* - _since_: 2.0.0
*/
hgetall(key: RedisKey, callback?: Callback<Record<string, string>>): Result<Record<string, string>, Context>;
hgetallBuffer(key: RedisKey, callback?: Callback<Record<string, Buffer>>): Result<Record<string, Buffer>, Context>;
/**
* Returns the value of a field and deletes it from the hash.
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 8.0.0
*/
hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
hgetdelBuffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
hgetdel(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hgetdelBuffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
/**
* Get the value of one or more fields of a given hash key, and optionally set their expiration.
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 8.0.0
*/
hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
hgetex(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hgetexBuffer(...args: [key: RedisKey, persist: "PERSIST", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
/**
* Increment the integer value of a hash field by the given number
* - _group_: hash
* - _complexity_: O(1)
* - _since_: 2.0.0
*/
hincrby(key: RedisKey, field: string | Buffer, increment: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Increment the float value of a hash field by the given amount
* - _group_: hash
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
hincrbyfloat(key: RedisKey, field: string | Buffer, increment: number | string, callback?: Callback<string>): Result<string, Context>;
hincrbyfloatBuffer(key: RedisKey, field: string | Buffer, increment: number | string, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Get all the fields in a hash
* - _group_: hash
* - _complexity_: O(N) where N is the size of the hash.
* - _since_: 2.0.0
*/
hkeys(key: RedisKey, callback?: Callback<string[]>): Result<string[], Context>;
hkeysBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Get the number of fields in a hash
* - _group_: hash
* - _complexity_: O(1)
* - _since_: 2.0.0
*/
hlen(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Get the values of all the given hash fields
* - _group_: hash
* - _complexity_: O(N) where N is the number of fields being requested.
* - _since_: 2.0.0
*/
hmget(...args: [
key: RedisKey,
...fields: (string | Buffer)[],
callback: Callback<(string | null)[]>
]): Result<(string | null)[], Context>;
hmgetBuffer(...args: [
key: RedisKey,
...fields: (string | Buffer)[],
callback: Callback<(Buffer | null)[]>
]): Result<(Buffer | null)[], Context>;
hmget(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Result<(string | null)[], Context>;
hmgetBuffer(...args: [key: RedisKey, ...fields: (string | Buffer)[]]): Result<(Buffer | null)[], Context>;
/**
* Set multiple hash fields to multiple values
* - _group_: hash
* - _complexity_: O(N) where N is the number of fields being set.
* - _since_: 2.0.0
*/
hmset(key: RedisKey, object: object, callback?: Callback<"OK">): Result<"OK", Context>;
hmset(key: RedisKey, map: Map<string | Buffer | number, string | Buffer | number>, callback?: Callback<"OK">): Result<"OK", Context>;
hmset(...args: [
key: RedisKey,
...fieldValues: (string | Buffer | number)[],
callback: Callback<"OK">
]): Result<"OK", Context>;
hmset(...args: [key: RedisKey, ...fieldValues: (string | Buffer | number)[]]): Result<"OK", Context>;
/**
* Removes the expiration time for each specified field
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpersist(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Set expiry for hash field using relative time to expire (milliseconds)
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hpexpire(...args: [key: RedisKey, milliseconds: number | string, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, nx: 'NX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, nx: 'NX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, xx: 'XX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, xx: 'XX', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, gt: 'GT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, gt: 'GT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, lt: 'LT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpire(...args: [key: RedisKey, milliseconds: number | string, lt: 'LT', fieldsToken: 'FIELDS', numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Set expiry for hash field using an absolute Unix timestamp (milliseconds)
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, nx: "NX", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, nx: "NX", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, xx: "XX", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, xx: "XX", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, gt: "GT", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, gt: "GT", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, lt: "LT", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpireat(...args: [key: RedisKey, unixTimeMilliseconds: number | string, lt: "LT", fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Returns the expiration time of a hash field as a Unix timestamp, in msec.
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpexpiretime(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Returns the TTL in milliseconds of a hash field.
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
hpttl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Get one or multiple random fields from a hash
* - _group_: hash
* - _complexity_: O(N) where N is the number of fields returned
* - _since_: 6.2.0
*/
hrandfield(key: RedisKey, callback?: Callback<string | unknown[] | null>): Result<string | unknown[] | null, Context>;
hrandfieldBuffer(key: RedisKey, callback?: Callback<Buffer | unknown[] | null>): Result<Buffer | unknown[] | null, Context>;
hrandfield(key: RedisKey, count: number | string, callback?: Callback<string | unknown[] | null>): Result<string | unknown[] | null, Context>;
hrandfieldBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer | unknown[] | null>): Result<Buffer | unknown[] | null, Context>;
hrandfield(key: RedisKey, count: number | string, withvalues: "WITHVALUES", callback?: Callback<string | unknown[] | null>): Result<string | unknown[] | null, Context>;
hrandfieldBuffer(key: RedisKey, count: number | string, withvalues: "WITHVALUES", callback?: Callback<Buffer | unknown[] | null>): Result<Buffer | unknown[] | null, Context>;
/**
* Incrementally iterate hash fields and associated values
* - _group_: hash
* - _complexity_: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..
* - _since_: 2.8.0
*/
hscan(key: RedisKey, cursor: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
hscanBuffer(key: RedisKey, cursor: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
hscan(key: RedisKey, cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
hscanBuffer(key: RedisKey, cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
hscan(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
hscanBuffer(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
hscan(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
hscanBuffer(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
/**
* Set the string value of a hash field
* - _group_: hash
* - _complexity_: O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs.
* - _since_: 2.0.0
*/
hset(key: RedisKey, object: object, callback?: Callback<number>): Result<number, Context>;
hset(key: RedisKey, map: Map<string | Buffer | number, string | Buffer | number>, callback?: Callback<number>): Result<number, Context>;
hset(...args: [
key: RedisKey,
...fieldValues: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
hset(...args: [key: RedisKey, ...fieldValues: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Set the value of one or more fields of a given hash key, and optionally set their expiration.
* - _group_: hash
* - _complexity_: O(N) where N is the number of fields being set.
* - _since_: 8.0.0
*/
hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fnx: "FNX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", secondsToken: "EX", seconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", millisecondsToken: "PX", milliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
hsetex(...args: [key: RedisKey, fxx: "FXX", keepttl: "KEEPTTL", fieldsToken: "FIELDS", numfields: number | string, ...data: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Set the value of a hash field, only if the field does not exist
* - _group_: hash
* - _complexity_: O(1)
* - _since_: 2.0.0
*/
hsetnx(key: RedisKey, field: string | Buffer, value: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Get the length of the value of a hash field
* - _group_: hash
* - _complexity_: O(1)
* - _since_: 3.2.0
*/
hstrlen(key: RedisKey, field: string | Buffer, callback?: Callback<number>): Result<number, Context>;
/**
* Returns the TTL in seconds of a hash field.
* - _group_: hash
* - _complexity_: O(N) where N is the number of specified fields
* - _since_: 7.4.0
*/
httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[], callback: Callback<number[]>]): Result<number[], Context>;
httl(...args: [key: RedisKey, fieldsToken: "FIELDS", numfields: number | string, ...fields: (string | Buffer)[]]): Result<number[], Context>;
/**
* Get all the values in a hash
* - _group_: hash
* - _complexity_: O(N) where N is the size of the hash.
* - _since_: 2.0.0
*/
hvals(key: RedisKey, callback?: Callback<string[]>): Result<string[], Context>;
hvalsBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Increment the integer value of a key by one
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
incr(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Increment the integer value of a key by the given amount
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
incrby(key: RedisKey, increment: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Increment the float value of a key by the given amount
* - _group_: string
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
incrbyfloat(key: RedisKey, increment: number | string, callback?: Callback<string>): Result<string, Context>;
/**
* Increments the numeric value of a key by a number and sets its expiration time. Uses 0 as initial value if the key doesn't exist.
* - _group_: string
* - _complexity_: O(1)
* - _since_: 8.8.0
*/
increx(...args: [key: RedisKey, ...args: (RedisValue)[], callback: Callback<[value: number, increment: number] | [value: string, increment: string]>]): Result<[value: number, increment: number] | [value: string, increment: string], Context>;
increxBuffer(...args: [key: RedisKey, ...args: (RedisValue)[], callback: Callback<[value: number, increment: number] | [value: Buffer, increment: Buffer]>]): Result<[value: number, increment: number] | [value: Buffer, increment: Buffer], Context>;
increx(...args: [key: RedisKey, ...args: (RedisValue)[]]): Result<[value: number, increment: number] | [value: string, increment: string], Context>;
increxBuffer(...args: [key: RedisKey, ...args: (RedisValue)[]]): Result<[value: number, increment: number] | [value: Buffer, increment: Buffer], Context>;
/**
* Get information and statistics about the server
* - _group_: server
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
info(callback?: Callback<string>): Result<string, Context>;
info(...args: [...sections: (string | Buffer)[], callback: Callback<string>]): Result<string, Context>;
info(...args: [...sections: (string | Buffer)[]]): Result<string, Context>;
/**
* Find all keys matching the given pattern
* - _group_: generic
* - _complexity_: O(N) with N being the number of keys in the database, under the assumption that the key names in the database and the given pattern have limited length.
* - _since_: 1.0.0
*/
keys(pattern: string, callback?: Callback<string[]>): Result<string[], Context>;
keysBuffer(pattern: string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Get the UNIX time stamp of the last successful save to disk
* - _group_: server
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
lastsave(callback?: Callback<number>): Result<number, Context>;
/**
* Return a human readable latency analysis report.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.13
*/
latency(subcommand: "DOCTOR", callback?: Callback<string>): Result<string, Context>;
/**
* Return a latency graph for the event.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.13
*/
latency(subcommand: "GRAPH", event: string | Buffer, callback?: Callback<string>): Result<string, Context>;
/**
* Show helpful text about the different subcommands.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.13
*/
latency(subcommand: "HELP", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Return the cumulative distribution of latencies of a subset of commands or all.
* - _group_: server
* - _complexity_: O(N) where N is the number of commands with latency information being retrieved.
* - _since_: 7.0.0
*/
latency(subcommand: "HISTOGRAM", callback?: Callback<unknown>): Result<unknown, Context>;
latency(...args: [
subcommand: "HISTOGRAM",
...commands: (string | Buffer)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
latency(...args: [subcommand: "HISTOGRAM", ...commands: (string | Buffer)[]]): Result<unknown, Context>;
/**
* Return timestamp-latency samples for the event.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.13
*/
latency(subcommand: "HISTORY", event: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Return the latest latency samples for all events.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.13
*/
latency(subcommand: "LATEST", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Reset latency data for one or more events.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.13
*/
latency(subcommand: "RESET", callback?: Callback<number>): Result<number, Context>;
latency(...args: [
subcommand: "RESET",
...events: (string | Buffer)[],
callback: Callback<number>
]): Result<number, Context>;
latency(...args: [subcommand: "RESET", ...events: (string | Buffer)[]]): Result<number, Context>;
/**
* Find longest common substring
* - _group_: string
* - _complexity_: O(N*M) where N and M are the lengths of s1 and s2, respectively
* - _since_: 7.0.0
*/
lcs(key1: RedisKey, key2: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, lenToken: "MINMATCHLEN", len: number | string, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, idx: "IDX", lenToken: "MINMATCHLEN", len: number | string, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", lenToken: "MINMATCHLEN", len1: number | string, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
lcs(key1: RedisKey, key2: RedisKey, len: "LEN", idx: "IDX", lenToken: "MINMATCHLEN", len1: number | string, withmatchlen: "WITHMATCHLEN", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get an element from a list by its index
* - _group_: list
* - _complexity_: O(N) where N is the number of elements to traverse to get to the element at index. This makes asking for the first or the last element of the list O(1).
* - _since_: 1.0.0
*/
lindex(key: RedisKey, index: number | string, callback?: Callback<string | null>): Result<string | null, Context>;
lindexBuffer(key: RedisKey, index: number | string, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Insert an element before or after another element in a list
* - _group_: list
* - _complexity_: O(N) where N is the number of elements to traverse before seeing the value pivot. This means that inserting somewhere on the left end on the list (head) can be considered O(1) and inserting somewhere on the right end (tail) is O(N).
* - _since_: 2.2.0
*/
linsert(key: RedisKey, before: "BEFORE", pivot: string | Buffer | number, element: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
linsert(key: RedisKey, after: "AFTER", pivot: string | Buffer | number, element: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Get the length of a list
* - _group_: list
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
llen(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Pop an element from a list, push it to another list and return it
* - _group_: list
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
lmove(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<string>): Result<string, Context>;
lmoveBuffer(source: RedisKey, destination: RedisKey, left: "LEFT", left1: "LEFT", callback?: Callback<Buffer>): Result<Buffer, Context>;
lmove(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<string>): Result<string, Context>;
lmoveBuffer(source: RedisKey, destination: RedisKey, left: "LEFT", right: "RIGHT", callback?: Callback<Buffer>): Result<Buffer, Context>;
lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<string>): Result<string, Context>;
lmoveBuffer(source: RedisKey, destination: RedisKey, right: "RIGHT", left: "LEFT", callback?: Callback<Buffer>): Result<Buffer, Context>;
lmove(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<string>): Result<string, Context>;
lmoveBuffer(source: RedisKey, destination: RedisKey, right: "RIGHT", right1: "RIGHT", callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Pop elements from a list
* - _group_: list
* - _complexity_: O(N+M) where N is the number of provided keys and M is the number of elements returned.
* - _since_: 7.0.0
*/
lmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [numkeys: number | string, ...keys: RedisKey[], left: "LEFT"]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [numkeys: number | string, ...keys: RedisKey[], left: "LEFT"]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [numkeys: number | string, keys: RedisKey[], left: "LEFT"]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [numkeys: number | string, keys: RedisKey[], left: "LEFT"]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
left: "LEFT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [numkeys: number | string, ...keys: RedisKey[], right: "RIGHT"]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [numkeys: number | string, ...keys: RedisKey[], right: "RIGHT"]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [numkeys: number | string, keys: RedisKey[], right: "RIGHT"]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [numkeys: number | string, keys: RedisKey[], right: "RIGHT"]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: string, members: string[]] | null>
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string,
callback: Callback<[key: Buffer, members: Buffer[]] | null>
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
lmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: string, members: string[]] | null, Context>;
lmpopBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
right: "RIGHT",
countToken: "COUNT",
count: number | string
]): Result<[key: Buffer, members: Buffer[]] | null, Context>;
/**
* Display some computer art and the Redis version
* - _group_: server
* - _complexity_: undefined
* - _since_: 5.0.0
*/
lolwut(callback?: Callback<string>): Result<string, Context>;
lolwut(versionToken: "VERSION", version: number | string, callback?: Callback<string>): Result<string, Context>;
/**
* Remove and get the first elements in a list
* - _group_: list
* - _complexity_: O(N) where N is the number of elements returned
* - _since_: 1.0.0
*/
lpop(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
lpopBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
lpop(key: RedisKey, count: number | string, callback?: Callback<string[] | null>): Result<string[] | null, Context>;
lpopBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[] | null>): Result<Buffer[] | null, Context>;
/**
* Return the index of matching elements on a list
* - _group_: list
* - _complexity_: O(N) where N is the number of elements in the list, for the average case. When searching for elements near the head or the tail of the list, or when the MAXLEN option is provided, the command may run in constant time.
* - _since_: 6.0.6
*/
lpos(key: RedisKey, element: string | Buffer | number, callback?: Callback<number | null>): Result<number | null, Context>;
lpos(key: RedisKey, element: string | Buffer | number, lenToken: "MAXLEN", len: number | string, callback?: Callback<number | null>): Result<number | null, Context>;
lpos(key: RedisKey, element: string | Buffer | number, numMatchesToken: "COUNT", numMatches: number | string, callback?: Callback<number[]>): Result<number[], Context>;
lpos(key: RedisKey, element: string | Buffer | number, numMatchesToken: "COUNT", numMatches: number | string, lenToken: "MAXLEN", len: number | string, callback?: Callback<number[]>): Result<number[], Context>;
lpos(key: RedisKey, element: string | Buffer | number, rankToken: "RANK", rank: number | string, callback?: Callback<number | null>): Result<number | null, Context>;
lpos(key: RedisKey, element: string | Buffer | number, rankToken: "RANK", rank: number | string, lenToken: "MAXLEN", len: number | string, callback?: Callback<number | null>): Result<number | null, Context>;
lpos(key: RedisKey, element: string | Buffer | number, rankToken: "RANK", rank: number | string, numMatchesToken: "COUNT", numMatches: number | string, callback?: Callback<number[]>): Result<number[], Context>;
lpos(key: RedisKey, element: string | Buffer | number, rankToken: "RANK", rank: number | string, numMatchesToken: "COUNT", numMatches: number | string, lenToken: "MAXLEN", len: number | string, callback?: Callback<number[]>): Result<number[], Context>;
/**
* Prepend one or multiple elements to a list
* - _group_: list
* - _complexity_: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
* - _since_: 1.0.0
*/
lpush(...args: [
key: RedisKey,
...elements: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
lpush(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Prepend an element to a list, only if the list exists
* - _group_: list
* - _complexity_: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
* - _since_: 2.2.0
*/
lpushx(...args: [
key: RedisKey,
...elements: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
lpushx(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Get a range of elements from a list
* - _group_: list
* - _complexity_: O(S+N) where S is the distance of start offset from HEAD for small lists, from nearest end (HEAD or TAIL) for large lists; and N is the number of elements in the specified range.
* - _since_: 1.0.0
*/
lrange(key: RedisKey, start: number | string, stop: number | string, callback?: Callback<string[]>): Result<string[], Context>;
lrangeBuffer(key: RedisKey, start: number | string, stop: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Remove elements from a list
* - _group_: list
* - _complexity_: O(N+M) where N is the length of the list and M is the number of elements removed.
* - _since_: 1.0.0
*/
lrem(key: RedisKey, count: number | string, element: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Set the value of an element in a list by its index
* - _group_: list
* - _complexity_: O(N) where N is the length of the list. Setting either the first or the last element of the list is O(1).
* - _since_: 1.0.0
*/
lset(key: RedisKey, index: number | string, element: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Trim a list to the specified range
* - _group_: list
* - _complexity_: O(N) where N is the number of elements to be removed by the operation.
* - _since_: 1.0.0
*/
ltrim(key: RedisKey, start: number | string, stop: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Outputs memory problems report
* - _group_: server
* - _complexity_: O(1)
* - _since_: 4.0.0
*/
memory(subcommand: "DOCTOR", callback?: Callback<string>): Result<string, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: server
* - _complexity_: O(1)
* - _since_: 4.0.0
*/
memory(subcommand: "HELP", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Show allocator internal stats
* - _group_: server
* - _complexity_: Depends on how much memory is allocated, could be slow
* - _since_: 4.0.0
*/
memory(subcommand: "MALLOC-STATS", callback?: Callback<string>): Result<string, Context>;
/**
* Ask the allocator to release memory
* - _group_: server
* - _complexity_: Depends on how much memory is allocated, could be slow
* - _since_: 4.0.0
*/
memory(subcommand: "PURGE", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Show memory usage details
* - _group_: server
* - _complexity_: O(1)
* - _since_: 4.0.0
*/
memory(subcommand: "STATS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Estimate the memory usage of a key
* - _group_: server
* - _complexity_: O(N) where N is the number of samples.
* - _since_: 4.0.0
*/
memory(subcommand: "USAGE", key: RedisKey, callback?: Callback<number | null>): Result<number | null, Context>;
memory(subcommand: "USAGE", key: RedisKey, countToken: "SAMPLES", count: number | string, callback?: Callback<number | null>): Result<number | null, Context>;
/**
* Get the values of all the given keys
* - _group_: string
* - _complexity_: O(N) where N is the number of keys to retrieve.
* - _since_: 1.0.0
*/
mget(...args: [...keys: RedisKey[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
mgetBuffer(...args: [...keys: RedisKey[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
mget(...args: [keys: RedisKey[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
mgetBuffer(...args: [keys: RedisKey[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
mget(...args: [...keys: RedisKey[]]): Result<(string | null)[], Context>;
mgetBuffer(...args: [...keys: RedisKey[]]): Result<(Buffer | null)[], Context>;
mget(...args: [keys: RedisKey[]]): Result<(string | null)[], Context>;
mgetBuffer(...args: [keys: RedisKey[]]): Result<(Buffer | null)[], Context>;
/**
* Atomically transfer a key from a Redis instance to another one.
* - _group_: generic
* - _complexity_: This command actually executes a DUMP+DEL in the source instance, and a RESTORE in the target instance. See the pages of these commands for time complexity. Also an O(N) data transfer between the two instances is performed.
* - _since_: 2.6.0
*/
migrate(...args: [
host: string | Buffer,
port: number | string,
...args: RedisValue[],
callback: Callback<"OK">
]): Result<"OK", Context>;
migrate(...args: [
host: string | Buffer,
port: number | string,
...args: RedisValue[]
]): Result<"OK", Context>;
/**
* Show helpful text about the different subcommands
* - _group_: server
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
module(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* List all modules loaded by the server
* - _group_: server
* - _complexity_: O(N) where N is the number of loaded modules.
* - _since_: 4.0.0
*/
module(subcommand: "LIST", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Load a module
* - _group_: server
* - _complexity_: O(1)
* - _since_: 4.0.0
*/
module(subcommand: "LOAD", path: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
module(...args: [
subcommand: "LOAD",
path: string | Buffer,
...args: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
module(...args: [
subcommand: "LOAD",
path: string | Buffer,
...args: (string | Buffer | number)[]
]): Result<unknown, Context>;
/**
* Load a module with extended parameters
* - _group_: server
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
module(subcommand: "LOADEX", path: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
module(...args: [
subcommand: "LOADEX",
path: string | Buffer,
argsToken: "ARGS",
...args: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
module(...args: [
subcommand: "LOADEX",
path: string | Buffer,
argsToken: "ARGS",
...args: (string | Buffer | number)[]
]): Result<unknown, Context>;
module(...args: [
subcommand: "LOADEX",
path: string | Buffer,
configsToken: "CONFIG",
...configs: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
module(...args: [
subcommand: "LOADEX",
path: string | Buffer,
configsToken: "CONFIG",
...configs: (string | Buffer | number)[]
]): Result<unknown, Context>;
module(...args: [
subcommand: "LOADEX",
path: string | Buffer,
configsToken: "CONFIG",
...args: RedisValue[],
callback: Callback<unknown>
]): Result<unknown, Context>;
module(...args: [
subcommand: "LOADEX",
path: string | Buffer,
configsToken: "CONFIG",
...args: RedisValue[]
]): Result<unknown, Context>;
/**
* Unload a module
* - _group_: server
* - _complexity_: O(1)
* - _since_: 4.0.0
*/
module(subcommand: "UNLOAD", name: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Move a key to another database
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
move(key: RedisKey, db: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Set multiple keys to multiple values
* - _group_: string
* - _complexity_: O(N) where N is the number of keys to set.
* - _since_: 1.0.1
*/
mset(object: object, callback?: Callback<"OK">): Result<"OK", Context>;
mset(map: Map<string | Buffer | number, string | Buffer | number>, callback?: Callback<"OK">): Result<"OK", Context>;
mset(...args: [
...keyValues: (RedisKey | string | Buffer | number)[],
callback: Callback<"OK">
]): Result<"OK", Context>;
mset(...args: [...keyValues: (RedisKey | string | Buffer | number)[]]): Result<"OK", Context>;
/**
* Atomically sets multiple string keys with a shared expiration in a single operation. Supports flexible argument parsing where condition and expiration flags can appear in any order.
* - _group_: string
* - _complexity_: O(N) where N is the number of keys to set.
* - _since_: 8.4.0
*/
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[]]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], secondsToken: 'EX', seconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], secondsToken: 'EX', seconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], millisecondsToken: 'PX', milliseconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], millisecondsToken: 'PX', milliseconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], unixTimeSecondsToken: 'EXAT', unixTimeSeconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], unixTimeSecondsToken: 'EXAT', unixTimeSeconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], unixTimeMillisecondsToken: 'PXAT', unixTimeMilliseconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], unixTimeMillisecondsToken: 'PXAT', unixTimeMilliseconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], keepttl: 'KEEPTTL', callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], keepttl: 'KEEPTTL']): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX']): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', secondsToken: 'EX', seconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', secondsToken: 'EX', seconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', millisecondsToken: 'PX', milliseconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', millisecondsToken: 'PX', milliseconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', unixTimeSecondsToken: 'EXAT', unixTimeSeconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', unixTimeSecondsToken: 'EXAT', unixTimeSeconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', unixTimeMillisecondsToken: 'PXAT', unixTimeMilliseconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', unixTimeMillisecondsToken: 'PXAT', unixTimeMilliseconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', keepttl: 'KEEPTTL', callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], nx: 'NX', keepttl: 'KEEPTTL']): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX']): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', secondsToken: 'EX', seconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', secondsToken: 'EX', seconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', millisecondsToken: 'PX', milliseconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', millisecondsToken: 'PX', milliseconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', unixTimeSecondsToken: 'EXAT', unixTimeSeconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', unixTimeSecondsToken: 'EXAT', unixTimeSeconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', unixTimeMillisecondsToken: 'PXAT', unixTimeMilliseconds: number | string, callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', unixTimeMillisecondsToken: 'PXAT', unixTimeMilliseconds: number | string]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', keepttl: 'KEEPTTL', callback: Callback<number>]): Result<number, Context>;
msetex(...args: [numkeys: number | string, ...data: (RedisKey | string | Buffer | number)[], xx: 'XX', keepttl: 'KEEPTTL']): Result<number, Context>;
/**
* Set multiple keys to multiple values, only if none of the keys exist
* - _group_: string
* - _complexity_: O(N) where N is the number of keys to set.
* - _since_: 1.0.1
*/
msetnx(object: object, callback?: Callback<"OK">): Result<"OK", Context>;
msetnx(map: Map<string | Buffer | number, string | Buffer | number>, callback?: Callback<"OK">): Result<"OK", Context>;
msetnx(...args: [
...keyValues: (RedisKey | string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
msetnx(...args: [...keyValues: (RedisKey | string | Buffer | number)[]]): Result<number, Context>;
/**
* Inspect the internal encoding of a Redis object
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 2.2.3
*/
object(subcommand: "ENCODING", key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get the logarithmic access frequency counter of a Redis object
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 4.0.0
*/
object(subcommand: "FREQ", key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
object(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get the time since a Redis object was last accessed
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 2.2.3
*/
object(subcommand: "IDLETIME", key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get the number of references to the value of the key
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 2.2.3
*/
object(subcommand: "REFCOUNT", key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Remove the expiration from a key
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 2.2.0
*/
persist(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Set a key's time to live in milliseconds
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
pexpire(key: RedisKey, milliseconds: number | string, callback?: Callback<number>): Result<number, Context>;
pexpire(key: RedisKey, milliseconds: number | string, nx: "NX", callback?: Callback<number>): Result<number, Context>;
pexpire(key: RedisKey, milliseconds: number | string, xx: "XX", callback?: Callback<number>): Result<number, Context>;
pexpire(key: RedisKey, milliseconds: number | string, gt: "GT", callback?: Callback<number>): Result<number, Context>;
pexpire(key: RedisKey, milliseconds: number | string, lt: "LT", callback?: Callback<number>): Result<number, Context>;
/**
* Set the expiration for a key as a UNIX timestamp specified in milliseconds
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
pexpireat(key: RedisKey, unixTimeMilliseconds: number | string, callback?: Callback<number>): Result<number, Context>;
pexpireat(key: RedisKey, unixTimeMilliseconds: number | string, nx: "NX", callback?: Callback<number>): Result<number, Context>;
pexpireat(key: RedisKey, unixTimeMilliseconds: number | string, xx: "XX", callback?: Callback<number>): Result<number, Context>;
pexpireat(key: RedisKey, unixTimeMilliseconds: number | string, gt: "GT", callback?: Callback<number>): Result<number, Context>;
pexpireat(key: RedisKey, unixTimeMilliseconds: number | string, lt: "LT", callback?: Callback<number>): Result<number, Context>;
/**
* Get the expiration Unix timestamp for a key in milliseconds
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 7.0.0
*/
pexpiretime(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Adds the specified elements to the specified HyperLogLog.
* - _group_: hyperloglog
* - _complexity_: O(1) to add every element.
* - _since_: 2.8.9
*/
pfadd(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
pfadd(...args: [
key: RedisKey,
...elements: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
pfadd(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Return the approximated cardinality of the set(s) observed by the HyperLogLog at key(s).
* - _group_: hyperloglog
* - _complexity_: O(1) with a very small average constant time when called with a single key. O(N) with N being the number of keys, and much bigger constant times, when called with multiple keys.
* - _since_: 2.8.9
*/
pfcount(...args: [...keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
pfcount(...args: [keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
pfcount(...args: [...keys: RedisKey[]]): Result<number, Context>;
pfcount(...args: [keys: RedisKey[]]): Result<number, Context>;
/**
* Internal commands for debugging HyperLogLog values
* - _group_: hyperloglog
* - _complexity_: N/A
* - _since_: 2.8.9
*/
pfdebug(subcommand: string | Buffer, key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Merge N different HyperLogLogs into a single one.
* - _group_: hyperloglog
* - _complexity_: O(N) to merge N HyperLogLogs, but with high constant times.
* - _since_: 2.8.9
*/
pfmerge(...args: [
destkey: RedisKey,
...sourcekeys: RedisKey[],
callback: Callback<"OK">
]): Result<"OK", Context>;
pfmerge(...args: [
destkey: RedisKey,
sourcekeys: RedisKey[],
callback: Callback<"OK">
]): Result<"OK", Context>;
pfmerge(...args: [destkey: RedisKey, ...sourcekeys: RedisKey[]]): Result<"OK", Context>;
pfmerge(...args: [destkey: RedisKey, sourcekeys: RedisKey[]]): Result<"OK", Context>;
/**
* An internal command for testing HyperLogLog values
* - _group_: hyperloglog
* - _complexity_: N/A
* - _since_: 2.8.9
*/
pfselftest(callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Ping the server
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
ping(callback?: Callback<"PONG">): Result<"PONG", Context>;
ping(message: string | Buffer, callback?: Callback<string>): Result<string, Context>;
pingBuffer(message: string | Buffer, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Set the value and expiration in milliseconds of a key
* - _group_: string
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
psetex(key: RedisKey, milliseconds: number | string, value: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Listen for messages published to channels matching the given patterns
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of patterns the client is already subscribed to.
* - _since_: 2.0.0
*/
psubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): Result<unknown, Context>;
psubscribe(...args: [...patterns: string[]]): Result<unknown, Context>;
/**
* Internal command used for replication
* - _group_: server
* - _complexity_: undefined
* - _since_: 2.8.0
*/
psync(replicationid: string | Buffer | number, offset: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get the time to live for a key in milliseconds
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
pttl(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Post a message to a channel
* - _group_: pubsub
* - _complexity_: O(N+M) where N is the number of clients subscribed to the receiving channel and M is the total number of subscribed patterns (by any client).
* - _since_: 2.0.0
*/
publish(channel: string | Buffer, message: string | Buffer, callback?: Callback<number>): Result<number, Context>;
/**
* List active channels
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of active channels, and assuming constant time pattern matching (relatively short channels and patterns)
* - _since_: 2.8.0
*/
pubsub(subcommand: "CHANNELS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
pubsub(subcommand: "CHANNELS", pattern: string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Show helpful text about the different subcommands
* - _group_: pubsub
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
pubsub(subcommand: "HELP", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Get the count of unique patterns pattern subscriptions
* - _group_: pubsub
* - _complexity_: O(1)
* - _since_: 2.8.0
*/
pubsub(subcommand: "NUMPAT", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Get the count of subscribers for channels
* - _group_: pubsub
* - _complexity_: O(N) for the NUMSUB subcommand, where N is the number of requested channels
* - _since_: 2.8.0
*/
pubsub(subcommand: "NUMSUB", callback?: Callback<unknown[]>): Result<unknown[], Context>;
pubsub(...args: [
subcommand: "NUMSUB",
...channels: (string | Buffer)[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
pubsub(...args: [subcommand: "NUMSUB", ...channels: (string | Buffer)[]]): Result<unknown[], Context>;
/**
* List active shard channels
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of active shard channels, and assuming constant time pattern matching (relatively short shard channels).
* - _since_: 7.0.0
*/
pubsub(subcommand: "SHARDCHANNELS", callback?: Callback<unknown[]>): Result<unknown[], Context>;
pubsub(subcommand: "SHARDCHANNELS", pattern: string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Get the count of subscribers for shard channels
* - _group_: pubsub
* - _complexity_: O(N) for the SHARDNUMSUB subcommand, where N is the number of requested shard channels
* - _since_: 7.0.0
*/
pubsub(subcommand: "SHARDNUMSUB", callback?: Callback<unknown[]>): Result<unknown[], Context>;
pubsub(...args: [
subcommand: "SHARDNUMSUB",
...shardchannels: (string | Buffer)[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
pubsub(...args: [subcommand: "SHARDNUMSUB", ...shardchannels: (string | Buffer)[]]): Result<unknown[], Context>;
/**
* Stop listening for messages posted to channels matching the given patterns
* - _group_: pubsub
* - _complexity_: O(N+M) where N is the number of patterns the client is already subscribed and M is the number of total patterns subscribed in the system (by any client).
* - _since_: 2.0.0
*/
punsubscribe(callback?: Callback<unknown>): Result<unknown, Context>;
punsubscribe(...args: [...patterns: string[], callback: Callback<unknown>]): Result<unknown, Context>;
punsubscribe(...args: [...patterns: string[]]): Result<unknown, Context>;
/**
* Close the connection
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
quit(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Return a random key from the keyspace
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
randomkey(callback?: Callback<string | null>): Result<string | null, Context>;
randomkeyBuffer(callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Enables read queries for a connection to a cluster replica node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
readonly(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Disables read queries for a connection to a cluster replica node
* - _group_: cluster
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
readwrite(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Rename a key
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
rename(key: RedisKey, newkey: RedisKey, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Rename a key, only if the new key does not exist
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
renamenx(key: RedisKey, newkey: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* An internal command for configuring the replication stream
* - _group_: server
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
replconf(callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Make the server a replica of another instance, or promote it as master.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
replicaof(host: string | Buffer, port: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Reset the connection
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
reset(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Create a key using the provided serialized value, previously obtained using DUMP.
* - _group_: generic
* - _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)).
* - _since_: 2.6.0
*/
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, secondsToken: "IDLETIME", seconds: number | string, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", secondsToken: "IDLETIME", seconds: number | string, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
restore(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<"OK">): Result<"OK", Context>;
/**
* An internal command for migrating keys in a cluster
* - _group_: server
* - _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)).
* - _since_: 3.0.0
*/
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
["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>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", callback?: Callback<unknown>): Result<unknown, Context>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, absttl: "ABSTTL", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
["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>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", callback?: Callback<unknown>): Result<unknown, Context>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", frequencyToken: "FREQ", frequency: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", secondsToken: "IDLETIME", seconds: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
["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>;
["restore-asking"](key: RedisKey, ttl: number | string, serializedValue: string | Buffer | number, replace: "REPLACE", absttl: "ABSTTL", callback?: Callback<unknown>): Result<unknown, Context>;
["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>;
["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>;
["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>;
/**
* Return the role of the instance in the context of replication
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.8.12
*/
role(callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Remove and get the last elements in a list
* - _group_: list
* - _complexity_: O(N) where N is the number of elements returned
* - _since_: 1.0.0
*/
rpop(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
rpopBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
rpop(key: RedisKey, count: number | string, callback?: Callback<string[] | null>): Result<string[] | null, Context>;
rpopBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[] | null>): Result<Buffer[] | null, Context>;
/**
* Remove the last element in a list, prepend it to another list and return it
* - _group_: list
* - _complexity_: O(1)
* - _since_: 1.2.0
*/
rpoplpush(source: RedisKey, destination: RedisKey, callback?: Callback<string>): Result<string, Context>;
rpoplpushBuffer(source: RedisKey, destination: RedisKey, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Append one or multiple elements to a list
* - _group_: list
* - _complexity_: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
* - _since_: 1.0.0
*/
rpush(...args: [
key: RedisKey,
...elements: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
rpush(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Append an element to a list, only if the list exists
* - _group_: list
* - _complexity_: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
* - _since_: 2.2.0
*/
rpushx(...args: [
key: RedisKey,
...elements: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
rpushx(...args: [key: RedisKey, ...elements: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Add one or more members to a set
* - _group_: set
* - _complexity_: O(1) for each element added, so O(N) to add N elements when the command is called with multiple arguments.
* - _since_: 1.0.0
*/
sadd(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
sadd(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
sadd(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<number, Context>;
sadd(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Synchronously save the dataset to disk
* - _group_: server
* - _complexity_: O(N) where N is the total number of keys in all databases
* - _since_: 1.0.0
*/
save(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Incrementally iterate the keys space
* - _group_: generic
* - _complexity_: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.
* - _since_: 2.8.0
*/
scan(cursor: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
scan(cursor: number | string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
scan(cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
scan(cursor: number | string, countToken: "COUNT", count: number | string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, countToken: "COUNT", count: number | string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
scan(cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
scan(cursor: number | string, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, patternToken: "MATCH", pattern: string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
scan(cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
scan(cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
scanBuffer(cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, typeToken: "TYPE", type: string | Buffer, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
/**
* Get the number of members in a set
* - _group_: set
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
scard(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Set the debug mode for executed scripts.
* - _group_: scripting
* - _complexity_: O(1)
* - _since_: 3.2.0
*/
script(subcommand: "DEBUG", yes: "YES", callback?: Callback<unknown>): Result<unknown, Context>;
script(subcommand: "DEBUG", sync: "SYNC", callback?: Callback<unknown>): Result<unknown, Context>;
script(subcommand: "DEBUG", no: "NO", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Check existence of scripts in the script cache.
* - _group_: scripting
* - _complexity_: O(N) with N being the number of scripts to check (so checking a single script is an O(1) operation).
* - _since_: 2.6.0
*/
script(...args: [
subcommand: "EXISTS",
...sha1s: (string | Buffer)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
script(...args: [subcommand: "EXISTS", ...sha1s: (string | Buffer)[]]): Result<unknown, Context>;
/**
* Remove all the scripts from the script cache.
* - _group_: scripting
* - _complexity_: O(N) with N being the number of scripts in cache
* - _since_: 2.6.0
*/
script(subcommand: "FLUSH", callback?: Callback<unknown>): Result<unknown, Context>;
script(subcommand: "FLUSH", async: "ASYNC", callback?: Callback<unknown>): Result<unknown, Context>;
script(subcommand: "FLUSH", sync: "SYNC", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: scripting
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
script(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Kill the script currently in execution.
* - _group_: scripting
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
script(subcommand: "KILL", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Load the specified Lua script into the script cache.
* - _group_: scripting
* - _complexity_: O(N) with N being the length in bytes of the script body.
* - _since_: 2.6.0
*/
script(subcommand: "LOAD", script: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Subtract multiple sets
* - _group_: set
* - _complexity_: O(N) where N is the total number of elements in all given sets.
* - _since_: 1.0.0
*/
sdiff(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Result<string[], Context>;
sdiffBuffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Result<Buffer[], Context>;
sdiff(...args: [keys: RedisKey[], callback: Callback<string[]>]): Result<string[], Context>;
sdiffBuffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Result<Buffer[], Context>;
sdiff(...args: [...keys: RedisKey[]]): Result<string[], Context>;
sdiffBuffer(...args: [...keys: RedisKey[]]): Result<Buffer[], Context>;
sdiff(...args: [keys: RedisKey[]]): Result<string[], Context>;
sdiffBuffer(...args: [keys: RedisKey[]]): Result<Buffer[], Context>;
/**
* Subtract multiple sets and store the resulting set in a key
* - _group_: set
* - _complexity_: O(N) where N is the total number of elements in all given sets.
* - _since_: 1.0.0
*/
sdiffstore(...args: [
destination: RedisKey,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sdiffstore(...args: [
destination: RedisKey,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sdiffstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Result<number, Context>;
sdiffstore(...args: [destination: RedisKey, keys: RedisKey[]]): Result<number, Context>;
/**
* Change the selected database for the current connection
* - _group_: connection
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
select(index: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Set the string value of a key
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
set(key: RedisKey, value: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
set(key: RedisKey, value: string | Buffer | number, get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, nx: "NX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, nx: "NX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, nx: "NX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, xx: "XX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, xx: "XX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, xx: "XX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
set(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, nx: "NX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, nx: "NX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, nx: "NX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, xx: "XX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, xx: "XX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, secondsToken: "EX", seconds: number | string, xx: "XX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
set(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, nx: "NX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, nx: "NX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, nx: "NX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, xx: "XX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, xx: "XX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, millisecondsToken: "PX", milliseconds: number | string, xx: "XX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, nx: "NX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, nx: "NX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, nx: "NX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, xx: "XX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, xx: "XX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, unixTimeSecondsToken: "EXAT", unixTimeSeconds: number | string, xx: "XX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, nx: "NX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, nx: "NX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, nx: "NX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, xx: "XX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, xx: "XX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, unixTimeMillisecondsToken: "PXAT", unixTimeMilliseconds: number | string, xx: "XX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", callback?: Callback<"OK">): Result<"OK", Context>;
set(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", nx: "NX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", nx: "NX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
set(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", xx: "XX", callback?: Callback<"OK" | null>): Result<"OK" | null, Context>;
set(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<string | null>): Result<string | null, Context>;
setBuffer(key: RedisKey, value: string | Buffer | number, keepttl: "KEEPTTL", xx: "XX", get: "GET", callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Sets or clears the bit at offset in the string value stored at key
* - _group_: bitmap
* - _complexity_: O(1)
* - _since_: 2.2.0
*/
setbit(key: RedisKey, offset: number | string, value: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Set the value and expiration of a key
* - _group_: string
* - _complexity_: O(1)
* - _since_: 2.0.0
*/
setex(key: RedisKey, seconds: number | string, value: string | Buffer | number, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Set the value of a key, only if the key does not exist
* - _group_: string
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
setnx(key: RedisKey, value: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Overwrite part of a string at key starting at the specified offset
* - _group_: string
* - _complexity_: O(1), not counting the time taken to copy the new string in place. Usually, this string is very small so the amortized complexity is O(1). Otherwise, complexity is O(M) with M being the length of the value argument.
* - _since_: 2.2.0
*/
setrange(key: RedisKey, offset: number | string, value: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Synchronously save the dataset to disk and then shut down the server
* - _group_: server
* - _complexity_: O(N) when saving, where N is the total number of keys in all databases when saving data, otherwise O(1)
* - _since_: 1.0.0
*/
shutdown(callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(now: "NOW", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(now: "NOW", force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", now: "NOW", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(nosave: "NOSAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", now: "NOW", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", now: "NOW", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", now: "NOW", force: "FORCE", callback?: Callback<"OK">): Result<"OK", Context>;
shutdown(save: "SAVE", now: "NOW", force: "FORCE", abort: "ABORT", callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Intersect multiple sets
* - _group_: set
* - _complexity_: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
* - _since_: 1.0.0
*/
sinter(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Result<string[], Context>;
sinterBuffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Result<Buffer[], Context>;
sinter(...args: [keys: RedisKey[], callback: Callback<string[]>]): Result<string[], Context>;
sinterBuffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Result<Buffer[], Context>;
sinter(...args: [...keys: RedisKey[]]): Result<string[], Context>;
sinterBuffer(...args: [...keys: RedisKey[]]): Result<Buffer[], Context>;
sinter(...args: [keys: RedisKey[]]): Result<string[], Context>;
sinterBuffer(...args: [keys: RedisKey[]]): Result<Buffer[], Context>;
/**
* Intersect multiple sets and return the cardinality of the result
* - _group_: set
* - _complexity_: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
* - _since_: 7.0.0
*/
sintercard(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sintercard(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sintercard(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<number, Context>;
sintercard(...args: [numkeys: number | string, keys: RedisKey[]]): Result<number, Context>;
sintercard(...args: [
numkeys: number | string,
...keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string,
callback: Callback<number>
]): Result<number, Context>;
sintercard(...args: [
numkeys: number | string,
keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string,
callback: Callback<number>
]): Result<number, Context>;
sintercard(...args: [
numkeys: number | string,
...keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string
]): Result<number, Context>;
sintercard(...args: [
numkeys: number | string,
keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string
]): Result<number, Context>;
/**
* Intersect multiple sets and store the resulting set in a key
* - _group_: set
* - _complexity_: O(N*M) worst case where N is the cardinality of the smallest set and M is the number of sets.
* - _since_: 1.0.0
*/
sinterstore(...args: [
destination: RedisKey,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sinterstore(...args: [
destination: RedisKey,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sinterstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Result<number, Context>;
sinterstore(...args: [destination: RedisKey, keys: RedisKey[]]): Result<number, Context>;
/**
* Determine if a given value is a member of a set
* - _group_: set
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
sismember(key: RedisKey, member: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Make the server a replica of another instance, or promote it as master.
* - _group_: server
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
slaveof(host: string | Buffer, port: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Get the slow log's entries
* - _group_: server
* - _complexity_: O(N) where N is the number of entries returned
* - _since_: 2.2.12
*/
slowlog(subcommand: "GET", callback?: Callback<unknown>): Result<unknown, Context>;
slowlog(subcommand: "GET", count: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: server
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
slowlog(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get the slow log's length
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.2.12
*/
slowlog(subcommand: "LEN", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Clear all entries from the slow log
* - _group_: server
* - _complexity_: O(N) where N is the number of entries in the slowlog
* - _since_: 2.2.12
*/
slowlog(subcommand: "RESET", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get all the members in a set
* - _group_: set
* - _complexity_: O(N) where N is the set cardinality.
* - _since_: 1.0.0
*/
smembers(key: RedisKey, callback?: Callback<string[]>): Result<string[], Context>;
smembersBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Returns the membership associated with the given elements for a set
* - _group_: set
* - _complexity_: O(N) where N is the number of elements being checked for membership
* - _since_: 6.2.0
*/
smismember(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<number[]>
]): Result<number[], Context>;
smismember(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<number[]>
]): Result<number[], Context>;
smismember(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<number[], Context>;
smismember(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<number[], Context>;
/**
* Move a member from one set to another
* - _group_: set
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
smove(source: RedisKey, destination: RedisKey, member: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Sort the elements in a list, set or sorted set
* - _group_: generic
* - _complexity_: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).
* - _since_: 1.0.0
*/
sort(...args: [key: RedisKey, ...args: RedisValue[], callback: Callback<unknown>]): Result<unknown, Context>;
sort(...args: [key: RedisKey, ...args: RedisValue[]]): Result<unknown, Context>;
/**
* Sort the elements in a list, set or sorted set. Read-only variant of SORT.
* - _group_: generic
* - _complexity_: O(N+M*log(M)) where N is the number of elements in the list or set to sort, and M the number of returned elements. When the elements are not sorted, complexity is O(N).
* - _since_: 7.0.0
*/
sort_ro(key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, asc: "ASC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, desc: "DESC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [key: RedisKey, patternToken: "GET", ...patterns: string[]]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
asc: "ASC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
asc: "ASC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
asc: "ASC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
asc: "ASC",
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
desc: "DESC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
desc: "DESC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
desc: "DESC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "GET",
...patterns: string[],
desc: "DESC",
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(key: RedisKey, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, offsetCountToken: "LIMIT", offset: number | string, count: number | string, alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, offsetCountToken: "LIMIT", offset: number | string, count: number | string, asc: "ASC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, offsetCountToken: "LIMIT", offset: number | string, count: number | string, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, offsetCountToken: "LIMIT", offset: number | string, count: number | string, desc: "DESC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, offsetCountToken: "LIMIT", offset: number | string, count: number | string, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[]
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
asc: "ASC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
asc: "ASC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
asc: "ASC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
asc: "ASC",
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
desc: "DESC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
desc: "DESC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
desc: "DESC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken: "GET",
...patterns: string[],
desc: "DESC",
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[]
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC",
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC",
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, asc: "ASC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, asc: "ASC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, desc: "DESC", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(key: RedisKey, patternToken: "BY", pattern: string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, desc: "DESC", alpha: "ALPHA", callback?: Callback<unknown>): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[]
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
asc: "ASC",
alpha: "ALPHA"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC"
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC",
alpha: "ALPHA",
callback: Callback<unknown>
]): Result<unknown, Context>;
sort_ro(...args: [
key: RedisKey,
patternToken: "BY",
pattern: string,
offsetCountToken: "LIMIT",
offset: number | string,
count: number | string,
patternToken1: "GET",
...pattern1s: string[],
desc: "DESC",
alpha: "ALPHA"
]): Result<unknown, Context>;
/**
* Remove and return one or multiple random members from a set
* - _group_: set
* - _complexity_: Without the count argument O(1), otherwise O(N) where N is the value of the passed count.
* - _since_: 1.0.0
*/
spop(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
spopBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
spop(key: RedisKey, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
spopBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Post a message to a shard channel
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of clients subscribed to the receiving shard channel.
* - _since_: 7.0.0
*/
spublish(shardchannel: string | Buffer, message: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get one or multiple random members from a set
* - _group_: set
* - _complexity_: Without the count argument O(1), otherwise O(N) where N is the absolute value of the passed count.
* - _since_: 1.0.0
*/
srandmember(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
srandmemberBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
srandmember(key: RedisKey, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
srandmemberBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Remove one or more members from a set
* - _group_: set
* - _complexity_: O(N) where N is the number of members to be removed.
* - _since_: 1.0.0
*/
srem(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
srem(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
srem(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<number, Context>;
srem(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Incrementally iterate Set elements
* - _group_: set
* - _complexity_: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..
* - _since_: 2.8.0
*/
sscan(key: RedisKey, cursor: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
sscanBuffer(key: RedisKey, cursor: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
sscan(key: RedisKey, cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
sscanBuffer(key: RedisKey, cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
sscan(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
sscanBuffer(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
sscan(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
sscanBuffer(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
/**
* Listen for messages published to the given shard channels
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of shard channels to subscribe to.
* - _since_: 7.0.0
*/
ssubscribe(...args: [
...shardchannels: (string | Buffer)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
ssubscribe(...args: [...shardchannels: (string | Buffer)[]]): Result<unknown, Context>;
/**
* Get the length of the value stored in a key
* - _group_: string
* - _complexity_: O(1)
* - _since_: 2.2.0
*/
strlen(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Listen for messages published to the given channels
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of channels to subscribe to.
* - _since_: 2.0.0
*/
subscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Result<unknown, Context>;
subscribe(...args: [...channels: (string | Buffer)[]]): Result<unknown, Context>;
/**
* Get a substring of the string stored at a key
* - _group_: string
* - _complexity_: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
* - _since_: 1.0.0
*/
substr(key: RedisKey, start: number | string, end: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Add multiple sets
* - _group_: set
* - _complexity_: O(N) where N is the total number of elements in all given sets.
* - _since_: 1.0.0
*/
sunion(...args: [...keys: RedisKey[], callback: Callback<string[]>]): Result<string[], Context>;
sunionBuffer(...args: [...keys: RedisKey[], callback: Callback<Buffer[]>]): Result<Buffer[], Context>;
sunion(...args: [keys: RedisKey[], callback: Callback<string[]>]): Result<string[], Context>;
sunionBuffer(...args: [keys: RedisKey[], callback: Callback<Buffer[]>]): Result<Buffer[], Context>;
sunion(...args: [...keys: RedisKey[]]): Result<string[], Context>;
sunionBuffer(...args: [...keys: RedisKey[]]): Result<Buffer[], Context>;
sunion(...args: [keys: RedisKey[]]): Result<string[], Context>;
sunionBuffer(...args: [keys: RedisKey[]]): Result<Buffer[], Context>;
/**
* Add multiple sets and store the resulting set in a key
* - _group_: set
* - _complexity_: O(N) where N is the total number of elements in all given sets.
* - _since_: 1.0.0
*/
sunionstore(...args: [
destination: RedisKey,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sunionstore(...args: [
destination: RedisKey,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
sunionstore(...args: [destination: RedisKey, ...keys: RedisKey[]]): Result<number, Context>;
sunionstore(...args: [destination: RedisKey, keys: RedisKey[]]): Result<number, Context>;
/**
* Stop listening for messages posted to the given shard channels
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of clients already subscribed to a shard channel.
* - _since_: 7.0.0
*/
sunsubscribe(callback?: Callback<unknown>): Result<unknown, Context>;
sunsubscribe(...args: [
...shardchannels: (string | Buffer)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
sunsubscribe(...args: [...shardchannels: (string | Buffer)[]]): Result<unknown, Context>;
/**
* Swaps two Redis databases
* - _group_: server
* - _complexity_: O(N) where N is the count of clients watching or blocking on keys from both databases.
* - _since_: 4.0.0
*/
swapdb(index1: number | string, index2: number | string, callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Internal command used for replication
* - _group_: server
* - _complexity_: undefined
* - _since_: 1.0.0
*/
sync(callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Return the current server time
* - _group_: server
* - _complexity_: O(1)
* - _since_: 2.6.0
*/
time(callback?: Callback<number[]>): Result<number[], Context>;
/**
* Alters the last access time of a key(s). Returns the number of existing keys specified.
* - _group_: generic
* - _complexity_: O(N) where N is the number of keys that will be touched.
* - _since_: 3.2.1
*/
touch(...args: [...keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
touch(...args: [keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
touch(...args: [...keys: RedisKey[]]): Result<number, Context>;
touch(...args: [keys: RedisKey[]]): Result<number, Context>;
/**
* Get the time to live for a key in seconds
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
ttl(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Determine the type stored at key
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 1.0.0
*/
type(key: RedisKey, callback?: Callback<string>): Result<string, Context>;
/**
* Delete a key asynchronously in another thread. Otherwise it is just as DEL, but non blocking.
* - _group_: generic
* - _complexity_: O(1) for each key removed regardless of its size. Then the command does O(N) work in a different thread in order to reclaim memory, where N is the number of allocations the deleted objects where composed of.
* - _since_: 4.0.0
*/
unlink(...args: [...keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
unlink(...args: [keys: RedisKey[], callback: Callback<number>]): Result<number, Context>;
unlink(...args: [...keys: RedisKey[]]): Result<number, Context>;
unlink(...args: [keys: RedisKey[]]): Result<number, Context>;
/**
* Stop listening for messages posted to the given channels
* - _group_: pubsub
* - _complexity_: O(N) where N is the number of clients already subscribed to a channel.
* - _since_: 2.0.0
*/
unsubscribe(callback?: Callback<unknown>): Result<unknown, Context>;
unsubscribe(...args: [...channels: (string | Buffer)[], callback: Callback<unknown>]): Result<unknown, Context>;
unsubscribe(...args: [...channels: (string | Buffer)[]]): Result<unknown, Context>;
/**
* Forget about all watched keys
* - _group_: transactions
* - _complexity_: O(1)
* - _since_: 2.2.0
*/
unwatch(callback?: Callback<"OK">): Result<"OK", Context>;
/**
* Add one or more elements to a vector set, or update its vector if it already exists
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vadd(...args: [key: RedisKey, ...args: (RedisValue)[], callback: Callback<number>]): Result<number, Context>;
vadd(...args: [key: RedisKey, ...args: (RedisValue)[]]): Result<number, Context>;
/**
* Return the number of elements in a vector set
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vcard(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Return the dimension of vectors in the vector set
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vdim(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Return the vector associated with an element
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vemb(key: RedisKey, element: string | Buffer | number, callback?: Callback<string[] | null>): Result<string[] | null, Context>;
vembBuffer(key: RedisKey, element: string | Buffer | number, callback?: Callback<Buffer[] | null>): Result<Buffer[] | null, Context>;
vemb(key: RedisKey, element: string | Buffer | number, raw: 'RAW', callback?: Callback<string[] | null>): Result<string[] | null, Context>;
vembBuffer(key: RedisKey, element: string | Buffer | number, raw: 'RAW', callback?: Callback<Buffer[] | null>): Result<Buffer[] | null, Context>;
/**
* Retrieve the JSON attributes of elements
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vgetattr(key: RedisKey, element: string | Buffer | number, callback?: Callback<string | null>): Result<string | null, Context>;
vgetattrBuffer(key: RedisKey, element: string | Buffer | number, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Return information about a vector set
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vinfo(key: RedisKey, callback?: Callback<(string | number)[] | null>): Result<(string | number)[] | null, Context>;
vinfoBuffer(key: RedisKey, callback?: Callback<(Buffer | number)[] | null>): Result<(Buffer | number)[] | null, Context>;
/**
* Check if an element exists in a vector set
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vismember(key: RedisKey, element: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Return the neighbors of an element at each layer in the HNSW graph
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vlinks(key: RedisKey, element: string | Buffer | number, callback?: Callback<string[][] | null>): Result<string[][] | null, Context>;
vlinksBuffer(key: RedisKey, element: string | Buffer | number, callback?: Callback<Buffer[][] | null>): Result<Buffer[][] | null, Context>;
vlinks(key: RedisKey, element: string | Buffer | number, withscores: 'WITHSCORES', callback?: Callback<string[][] | null>): Result<string[][] | null, Context>;
vlinksBuffer(key: RedisKey, element: string | Buffer | number, withscores: 'WITHSCORES', callback?: Callback<Buffer[][] | null>): Result<Buffer[][] | null, Context>;
/**
* Return one or multiple random members from a vector set
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vrandmember(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
vrandmemberBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
vrandmember(key: RedisKey, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
vrandmemberBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Return vector set elements in a lex range
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.4.0
*/
vrange(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, callback?: Callback<string[]>): Result<string[], Context>;
vrangeBuffer(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
vrange(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
vrangeBuffer(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Remove an element from a vector set
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vrem(key: RedisKey, element: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Associate or remove the JSON attributes of elements
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vsetattr(key: RedisKey, element: string | Buffer | number, json: string | Buffer, callback?: Callback<number>): Result<number, Context>;
/**
* Return elements by vector similarity
* - _group_: module
* - _complexity_: undefined
* - _since_: 8.0.0
*/
vsim(...args: [key: RedisKey, ...args: (RedisValue)[], callback: Callback<(string | null)[]>]): Result<(string | null)[], Context>;
vsimBuffer(...args: [key: RedisKey, ...args: (RedisValue)[], callback: Callback<(Buffer | null)[]>]): Result<(Buffer | null)[], Context>;
vsim(...args: [key: RedisKey, ...args: (RedisValue)[]]): Result<(string | null)[], Context>;
vsimBuffer(...args: [key: RedisKey, ...args: (RedisValue)[]]): Result<(Buffer | null)[], Context>;
/**
* Wait for the synchronous replication of all the write commands sent in the context of the current connection
* - _group_: generic
* - _complexity_: O(1)
* - _since_: 3.0.0
*/
wait(numreplicas: number | string, timeout: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Watch the given keys to determine execution of the MULTI/EXEC block
* - _group_: transactions
* - _complexity_: O(1) for every key.
* - _since_: 2.2.0
*/
watch(...args: [...keys: RedisKey[], callback: Callback<"OK">]): Result<"OK", Context>;
watch(...args: [keys: RedisKey[], callback: Callback<"OK">]): Result<"OK", Context>;
watch(...args: [...keys: RedisKey[]]): Result<"OK", Context>;
watch(...args: [keys: RedisKey[]]): Result<"OK", Context>;
/**
* Marks a pending message as correctly processed, effectively removing it from the pending entries list of the consumer group. Return value of the command is the number of messages successfully acknowledged, that is, the IDs we were actually able to resolve in the PEL.
* - _group_: stream
* - _complexity_: O(1) for each message ID processed.
* - _since_: 5.0.0
*/
xack(...args: [
key: RedisKey,
group: string | Buffer,
...ids: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
xack(...args: [
key: RedisKey,
group: string | Buffer,
...ids: (string | Buffer | number)[]
]): Result<number, Context>;
/**
* Appends a new entry to a stream
* - _group_: stream
* - _complexity_: O(1) when adding a new entry, O(N) when trimming where N being the number of entries evicted.
* - _since_: 5.0.0
*/
xadd(...args: [
key: RedisKey,
...args: RedisValue[],
callback: Callback<string | null>
]): Result<string | null, Context>;
xaddBuffer(...args: [
key: RedisKey,
...args: RedisValue[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
xadd(...args: [key: RedisKey, ...args: RedisValue[]]): Result<string | null, Context>;
xaddBuffer(...args: [key: RedisKey, ...args: RedisValue[]]): Result<Buffer | null, Context>;
/**
* Changes (or acquires) ownership of messages in a consumer group, as if the messages were delivered to the specified consumer.
* - _group_: stream
* - _complexity_: O(1) if COUNT is small.
* - _since_: 6.2.0
*/
xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | Buffer | number, start: string | Buffer | number, callback?: Callback<unknown[]>): Result<unknown[], Context>;
xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | Buffer | number, start: string | Buffer | number, justid: "JUSTID", callback?: Callback<unknown[]>): Result<unknown[], Context>;
xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | Buffer | number, start: string | Buffer | number, countToken: "COUNT", count: number | string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
xautoclaim(key: RedisKey, group: string | Buffer, consumer: string | Buffer, minIdleTime: string | Buffer | number, start: string | Buffer | number, countToken: "COUNT", count: number | string, justid: "JUSTID", callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Changes (or acquires) ownership of a message in a consumer group, as if the message was delivered to the specified consumer.
* - _group_: stream
* - _complexity_: O(log N) with N being the number of messages in the PEL of the consumer group.
* - _since_: 5.0.0
*/
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[]
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string,
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string,
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
justid: "JUSTID"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE"
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID",
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xclaim(...args: [
key: RedisKey,
group: string | Buffer,
consumer: string | Buffer,
minIdleTime: string | Buffer | number,
...ids: (string | Buffer | number)[],
msToken: "IDLE",
ms: number | string,
unixTimeMillisecondsToken: "TIME",
unixTimeMilliseconds: number | string,
countToken: "RETRYCOUNT",
count: number | string,
force: "FORCE",
justid: "JUSTID"
]): Result<unknown[], Context>;
/**
* Removes the specified entries from the stream. Returns the number of items actually deleted, that may be different from the number of IDs passed in case certain IDs do not exist.
* - _group_: stream
* - _complexity_: O(1) for each single item to delete in the stream, regardless of the stream size.
* - _since_: 5.0.0
*/
xdel(...args: [
key: RedisKey,
...ids: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
xdel(...args: [key: RedisKey, ...ids: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Deletes one or multiple entries from the stream.
* - _group_: stream
* - _complexity_: O(1) for each single item to delete in the stream, regardless of the stream size.
* - _since_: 8.2.0
*/
xdelex(...args: [
key: RedisKey,
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
xdelex(...args: [
key: RedisKey,
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[]
]): Result<unknown, Context>;
xdelex(...args: [
key: RedisKey,
keepref: "KEEPREF",
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
xdelex(...args: [
key: RedisKey,
keepref: "KEEPREF",
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[]
]): Result<unknown, Context>;
xdelex(...args: [
key: RedisKey,
delref: "DELREF",
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
xdelex(...args: [
key: RedisKey,
delref: "DELREF",
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[]
]): Result<unknown, Context>;
xdelex(...args: [
key: RedisKey,
acked: "ACKED",
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[],
callback: Callback<unknown>
]): Result<unknown, Context>;
xdelex(...args: [
key: RedisKey,
acked: "ACKED",
idsToken: "IDS",
numids: number | string,
...ids: (string | Buffer | number)[]
]): Result<unknown, Context>;
/**
* Create a consumer group.
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | Buffer | number, entriesReadToken: "ENTRIESREAD", entriesRead: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | Buffer | number, mkstream: "MKSTREAM", callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, id: string | Buffer | number, mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "CREATE", key: RedisKey, groupname: string | Buffer, newId: "$", mkstream: "MKSTREAM", entriesReadToken: "ENTRIESREAD", entriesRead: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Create a consumer in a consumer group.
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 6.2.0
*/
xgroup(subcommand: "CREATECONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Delete a consumer from a consumer group.
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xgroup(subcommand: "DELCONSUMER", key: RedisKey, groupname: string | Buffer, consumername: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Destroy a consumer group.
* - _group_: stream
* - _complexity_: O(N) where N is the number of entries in the group's pending entries list (PEL).
* - _since_: 5.0.0
*/
xgroup(subcommand: "DESTROY", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xgroup(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Set a consumer group to an arbitrary last delivered ID value.
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, id: string | Buffer | number, entriesReadToken: "ENTRIESREAD", entriesRead: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", callback?: Callback<unknown>): Result<unknown, Context>;
xgroup(subcommand: "SETID", key: RedisKey, groupname: string | Buffer, newId: "$", entriesReadToken: "ENTRIESREAD", entriesRead: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* List the consumers in a consumer group
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xinfo(subcommand: "CONSUMERS", key: RedisKey, groupname: string | Buffer, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* List the consumer groups of a stream
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xinfo(subcommand: "GROUPS", key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Show helpful text about the different subcommands
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xinfo(subcommand: "HELP", callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Get information about a stream
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xinfo(subcommand: "STREAM", key: RedisKey, callback?: Callback<unknown>): Result<unknown, Context>;
xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", callback?: Callback<unknown>): Result<unknown, Context>;
xinfo(subcommand: "STREAM", key: RedisKey, fullToken: "FULL", countToken: "COUNT", count: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Return the number of entries in a stream
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xlen(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Releases claimed messages back to the group's PEL without acknowledging them, making them available for re-delivery.
* - _group_: stream
* - _complexity_: O(1) for each message ID processed.
* - _since_: 8.8.0
*/
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[]]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], force: 'FORCE', callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], force: 'FORCE']): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, force: 'FORCE', callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, silent: 'SILENT', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, force: 'FORCE']): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[]]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], force: 'FORCE', callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], force: 'FORCE']): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, force: 'FORCE', callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fail: 'FAIL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, force: 'FORCE']): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[]]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], force: 'FORCE', callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], force: 'FORCE']): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, force: 'FORCE', callback: Callback<number>]): Result<number, Context>;
xnack(...args: [key: RedisKey, group: string | Buffer, fatal: 'FATAL', idsToken: 'IDS', numids: number | string, ...ids: (string | Buffer | number)[], countToken: 'RETRYCOUNT', count: number | string, force: 'FORCE']): Result<number, Context>;
/**
* Return information and entries from a stream consumer group pending entries list, that are messages fetched but never acknowledged.
* - _group_: stream
* - _complexity_: O(N) with N being the number of elements returned, so asking for a small fixed number of entries per call is O(1). O(M), where M is the total number of entries scanned when used with the IDLE filter. When the command returns just the summary and the list of consumers is small, it runs in O(1) time; otherwise, an additional O(N) time for iterating every consumer.
* - _since_: 5.0.0
*/
xpending(key: RedisKey, group: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
xpending(key: RedisKey, group: string | Buffer, start: string | Buffer | number, end: string | Buffer | number, count: number | string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
xpending(key: RedisKey, group: string | Buffer, start: string | Buffer | number, end: string | Buffer | number, count: number | string, consumer: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: number | string, start: string | Buffer | number, end: string | Buffer | number, count: number | string, callback?: Callback<unknown[]>): Result<unknown[], Context>;
xpending(key: RedisKey, group: string | Buffer, minIdleTimeToken: "IDLE", minIdleTime: number | string, start: string | Buffer | number, end: string | Buffer | number, count: number | string, consumer: string | Buffer, callback?: Callback<unknown[]>): Result<unknown[], Context>;
/**
* Return a range of elements in a stream, with IDs matching the specified IDs interval
* - _group_: stream
* - _complexity_: O(N) with N being the number of elements being returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
* - _since_: 5.0.0
*/
xrange(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, callback?: Callback<[id: string, fields: string[]][]>): Result<[id: string, fields: string[]][], Context>;
xrangeBuffer(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Result<[id: Buffer, fields: Buffer[]][], Context>;
xrange(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, countToken: "COUNT", count: number | string, callback?: Callback<[id: string, fields: string[]][]>): Result<[id: string, fields: string[]][], Context>;
xrangeBuffer(key: RedisKey, start: string | Buffer | number, end: string | Buffer | number, countToken: "COUNT", count: number | string, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Result<[id: Buffer, fields: Buffer[]][], Context>;
/**
* Return never seen elements in multiple streams, with IDs greater than the ones reported by the caller for each stream. Can block.
* - _group_: stream
* - _complexity_: For each stream mentioned: O(N) with N being the number of elements being returned, it means that XREAD-ing with a fixed COUNT is O(1). Note that when the BLOCK option is used, XADD will pay O(M) time in order to serve the M clients blocked on the stream getting new data.
* - _since_: 5.0.0
*/
xread(...args: [
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: string,
items: [id: string, fields: string[]][]
][] | null>
]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null>
]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
xread(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [streamsToken: "STREAMS", ...args: RedisValue[]]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
xread(...args: [
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: string,
items: [id: string, fields: string[]][]
][] | null>
]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null>
]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
xread(...args: [
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
xread(...args: [
countToken: "COUNT",
count: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: string,
items: [id: string, fields: string[]][]
][] | null>
]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [
countToken: "COUNT",
count: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null>
]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
xread(...args: [
countToken: "COUNT",
count: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [
countToken: "COUNT",
count: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
xread(...args: [
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: string,
items: [id: string, fields: string[]][]
][] | null>
]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null>
]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
xread(...args: [
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<[
key: string,
items: [id: string, fields: string[]][]
][] | null, Context>;
xreadBuffer(...args: [
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<[
key: Buffer,
items: [id: Buffer, fields: Buffer[]][]
][] | null, Context>;
/**
* Return new entries from a stream using a consumer group, or access the history of the pending entries for a given consumer. Can block.
* - _group_: stream
* - _complexity_: For each stream mentioned: O(M) with M being the number of elements returned. If M is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1). On the other side when XREADGROUP blocks, XADD will pay the O(N) time in order to serve the N clients blocked on the stream getting new data.
* - _since_: 5.0.0
*/
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
millisecondsToken: "BLOCK",
milliseconds: number | string,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
millisecondsToken: "BLOCK",
milliseconds: number | string,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[],
callback: Callback<unknown[]>
]): Result<unknown[], Context>;
xreadgroup(...args: [
groupConsumerToken: "GROUP",
group: string | Buffer,
consumer: string | Buffer,
countToken: "COUNT",
count: number | string,
millisecondsToken: "BLOCK",
milliseconds: number | string,
noack: "NOACK",
streamsToken: "STREAMS",
...args: RedisValue[]
]): Result<unknown[], Context>;
/**
* Return a range of elements in a stream, with IDs matching the specified IDs interval, in reverse order (from greater to smaller IDs) compared to XRANGE
* - _group_: stream
* - _complexity_: O(N) with N being the number of elements returned. If N is constant (e.g. always asking for the first 10 elements with COUNT), you can consider it O(1).
* - _since_: 5.0.0
*/
xrevrange(key: RedisKey, end: string | Buffer | number, start: string | Buffer | number, callback?: Callback<[id: string, fields: string[]][]>): Result<[id: string, fields: string[]][], Context>;
xrevrangeBuffer(key: RedisKey, end: string | Buffer | number, start: string | Buffer | number, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Result<[id: Buffer, fields: Buffer[]][], Context>;
xrevrange(key: RedisKey, end: string | Buffer | number, start: string | Buffer | number, countToken: "COUNT", count: number | string, callback?: Callback<[id: string, fields: string[]][]>): Result<[id: string, fields: string[]][], Context>;
xrevrangeBuffer(key: RedisKey, end: string | Buffer | number, start: string | Buffer | number, countToken: "COUNT", count: number | string, callback?: Callback<[id: Buffer, fields: Buffer[]][]>): Result<[id: Buffer, fields: Buffer[]][], Context>;
/**
* An internal command for replicating stream values
* - _group_: stream
* - _complexity_: O(1)
* - _since_: 5.0.0
*/
xsetid(key: RedisKey, lastId: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
xsetid(key: RedisKey, lastId: string | Buffer | number, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
xsetid(key: RedisKey, lastId: string | Buffer | number, entriesAddedToken: "ENTRIESADDED", entriesAdded: number | string, callback?: Callback<unknown>): Result<unknown, Context>;
xsetid(key: RedisKey, lastId: string | Buffer | number, entriesAddedToken: "ENTRIESADDED", entriesAdded: number | string, maxDeletedEntryIdToken: "MAXDELETEDID", maxDeletedEntryId: string | Buffer | number, callback?: Callback<unknown>): Result<unknown, Context>;
/**
* Deletes messages from the beginning of a stream.
* - _group_: stream
* - _complexity_: O(N), with N being the number of evicted entries. Constant times are very small however, since entries are organized in macro nodes containing multiple entries that can be released with a single deallocation.
* - _since_: 5.0.0
*/
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, maxlen: "MAXLEN", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", equal: "=", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, keepref: "KEEPREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, delref: "DELREF", callback?: Callback<number>): Result<number, Context>;
xtrim(key: RedisKey, minid: "MINID", approximately: "~", threshold: string | Buffer | number, countToken: "LIMIT", count: number | string, acked: "ACKED", callback?: Callback<number>): Result<number, Context>;
/**
* Add one or more members to a sorted set, or update its score if it already exists
* - _group_: sorted-set
* - _complexity_: O(log(N)) for each item added, where N is the number of elements in the sorted set.
* - _since_: 1.2.0
*/
zadd(...args: [
key: RedisKey,
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [key: RedisKey, ...scoreMembers: (string | Buffer | number)[]]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string>
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer>
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string>
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer>
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string>
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer>
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string>
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer>
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string>
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer>
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string>
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer>
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string, Context>;
zaddBuffer(...args: [
key: RedisKey,
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
nx: "NX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
gt: "GT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
ch: "CH",
...scoreMembers: (string | Buffer | number)[]
]): Result<number, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<string | null>
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[],
callback: Callback<Buffer | null>
]): Result<Buffer | null, Context>;
zadd(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<string | null, Context>;
zaddBuffer(...args: [
key: RedisKey,
xx: "XX",
lt: "LT",
ch: "CH",
incr: "INCR",
...scoreMembers: (string | Buffer | number)[]
]): Result<Buffer | null, Context>;
/**
* Get the number of members in a sorted set
* - _group_: sorted-set
* - _complexity_: O(1)
* - _since_: 1.2.0
*/
zcard(key: RedisKey, callback?: Callback<number>): Result<number, Context>;
/**
* Count the members in a sorted set with scores within the given values
* - _group_: sorted-set
* - _complexity_: O(log(N)) with N being the number of elements in the sorted set.
* - _since_: 2.0.0
*/
zcount(key: RedisKey, min: number | string, max: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Subtract multiple sorted sets
* - _group_: sorted-set
* - _complexity_: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set.
* - _since_: 6.2.0
*/
zdiff(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<string[]>
]): Result<string[], Context>;
zdiffBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zdiff(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<string[]>
]): Result<string[], Context>;
zdiffBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zdiff(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<string[], Context>;
zdiffBuffer(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<Buffer[], Context>;
zdiff(...args: [numkeys: number | string, keys: RedisKey[]]): Result<string[], Context>;
zdiffBuffer(...args: [numkeys: number | string, keys: RedisKey[]]): Result<Buffer[], Context>;
zdiff(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zdiffBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zdiff(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zdiffBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zdiff(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zdiffBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zdiff(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zdiffBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
/**
* Subtract multiple sorted sets and store the resulting sorted set in a new key
* - _group_: sorted-set
* - _complexity_: O(L + (N-K)log(N)) worst case where L is the total number of elements in all the sets, N is the size of the first set, and K is the size of the result set.
* - _since_: 6.2.0
*/
zdiffstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zdiffstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zdiffstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[]
]): Result<number, Context>;
zdiffstore(...args: [destination: RedisKey, numkeys: number | string, keys: RedisKey[]]): Result<number, Context>;
/**
* Increment the score of a member in a sorted set
* - _group_: sorted-set
* - _complexity_: O(log(N)) where N is the number of elements in the sorted set.
* - _since_: 1.2.0
*/
zincrby(key: RedisKey, increment: number | string, member: string | Buffer | number, callback?: Callback<string>): Result<string, Context>;
zincrbyBuffer(key: RedisKey, increment: number | string, member: string | Buffer | number, callback?: Callback<Buffer>): Result<Buffer, Context>;
/**
* Intersect multiple sorted sets
* - _group_: sorted-set
* - _complexity_: O(N*K)+O(M*log(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.
* - _since_: 6.2.0
*/
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<string[], Context>;
zinterBuffer(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<Buffer[], Context>;
zinter(...args: [numkeys: number | string, keys: RedisKey[]]): Result<string[], Context>;
zinterBuffer(...args: [numkeys: number | string, keys: RedisKey[]]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [numkeys: number | string, ...args: RedisValue[]]): Result<string[], Context>;
zinterBuffer(...args: [numkeys: number | string, ...args: RedisValue[]]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zinter(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zinterBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
/**
* Intersect multiple sorted sets and return the cardinality of the result
* - _group_: sorted-set
* - _complexity_: O(N*K) worst case with N being the smallest input sorted set, K being the number of input sorted sets.
* - _since_: 7.0.0
*/
zintercard(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zintercard(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zintercard(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<number, Context>;
zintercard(...args: [numkeys: number | string, keys: RedisKey[]]): Result<number, Context>;
zintercard(...args: [
numkeys: number | string,
...keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string,
callback: Callback<number>
]): Result<number, Context>;
zintercard(...args: [
numkeys: number | string,
keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string,
callback: Callback<number>
]): Result<number, Context>;
zintercard(...args: [
numkeys: number | string,
...keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string
]): Result<number, Context>;
zintercard(...args: [
numkeys: number | string,
keys: RedisKey[],
limitToken: "LIMIT",
limit: number | string
]): Result<number, Context>;
/**
* Intersect multiple sorted sets and store the resulting sorted set in a new key
* - _group_: sorted-set
* - _complexity_: O(N*K)+O(M*log(M)) worst case with N being the smallest input sorted set, K being the number of input sorted sets and M being the number of elements in the resulting sorted set.
* - _since_: 2.0.0
*/
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[]
]): Result<number, Context>;
zinterstore(...args: [destination: RedisKey, numkeys: number | string, keys: RedisKey[]]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[]
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<number>
]): Result<number, Context>;
zinterstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<number, Context>;
/**
* Count the number of members in a sorted set between a given lexicographical range
* - _group_: sorted-set
* - _complexity_: O(log(N)) with N being the number of elements in the sorted set.
* - _since_: 2.8.9
*/
zlexcount(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Remove and return members with scores in a sorted set
* - _group_: sorted-set
* - _complexity_: O(K) + O(N*log(M)) where K is the number of provided keys, N being the number of elements in the sorted set, and M being the number of elements popped.
* - _since_: 7.0.0
*/
zmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
min: "MIN",
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
min: "MIN",
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [numkeys: number | string, ...keys: RedisKey[], min: "MIN"]): Result<unknown, Context>;
zmpop(...args: [numkeys: number | string, keys: RedisKey[], min: "MIN"]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
min: "MIN",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
max: "MAX",
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
max: "MAX",
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [numkeys: number | string, ...keys: RedisKey[], max: "MAX"]): Result<unknown, Context>;
zmpop(...args: [numkeys: number | string, keys: RedisKey[], max: "MAX"]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string,
callback: Callback<unknown>
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
...keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
zmpop(...args: [
numkeys: number | string,
keys: RedisKey[],
max: "MAX",
countToken: "COUNT",
count: number | string
]): Result<unknown, Context>;
/**
* Get the score associated with the given members in a sorted set
* - _group_: sorted-set
* - _complexity_: O(N) where N is the number of members being requested.
* - _since_: 6.2.0
*/
zmscore(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<(string | null)[]>
]): Result<(string | null)[], Context>;
zmscoreBuffer(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<(Buffer | null)[]>
]): Result<(Buffer | null)[], Context>;
zmscore(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<(string | null)[]>
]): Result<(string | null)[], Context>;
zmscoreBuffer(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<(Buffer | null)[]>
]): Result<(Buffer | null)[], Context>;
zmscore(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<(string | null)[], Context>;
zmscoreBuffer(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<(Buffer | null)[], Context>;
zmscore(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<(string | null)[], Context>;
zmscoreBuffer(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<(Buffer | null)[], Context>;
/**
* Remove and return members with the highest scores in a sorted set
* - _group_: sorted-set
* - _complexity_: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
* - _since_: 5.0.0
*/
zpopmax(key: RedisKey, callback?: Callback<string[]>): Result<string[], Context>;
zpopmaxBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zpopmax(key: RedisKey, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zpopmaxBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Remove and return members with the lowest scores in a sorted set
* - _group_: sorted-set
* - _complexity_: O(log(N)*M) with N being the number of elements in the sorted set, and M being the number of elements popped.
* - _since_: 5.0.0
*/
zpopmin(key: RedisKey, callback?: Callback<string[]>): Result<string[], Context>;
zpopminBuffer(key: RedisKey, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zpopmin(key: RedisKey, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zpopminBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Get one or multiple random elements from a sorted set
* - _group_: sorted-set
* - _complexity_: O(N) where N is the number of elements returned
* - _since_: 6.2.0
*/
zrandmember(key: RedisKey, callback?: Callback<string | null>): Result<string | null, Context>;
zrandmemberBuffer(key: RedisKey, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
zrandmember(key: RedisKey, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrandmemberBuffer(key: RedisKey, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrandmember(key: RedisKey, count: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrandmemberBuffer(key: RedisKey, count: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Return a range of members in a sorted set
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.
* - _since_: 1.2.0
*/
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrange(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangeBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Return a range of members in a sorted set, by lexicographical range
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
* - _since_: 2.8.9
*/
zrangebylex(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, callback?: Callback<string[]>): Result<string[], Context>;
zrangebylexBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrangebylex(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangebylexBuffer(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Return a range of members in a sorted set, by score
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
* - _since_: 1.0.5
*/
zrangebyscore(key: RedisKey, min: number | string, max: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangebyscoreBuffer(key: RedisKey, min: number | string, max: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrangebyscore(key: RedisKey, min: number | string, max: number | string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangebyscoreBuffer(key: RedisKey, min: number | string, max: number | string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrangebyscore(key: RedisKey, min: number | string, max: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrangebyscoreBuffer(key: RedisKey, min: number | string, max: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrangebyscore(key: RedisKey, min: number | string, max: number | string, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrangebyscoreBuffer(key: RedisKey, min: number | string, max: number | string, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Store a range of members from sorted set into another key
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements stored into the destination key.
* - _since_: 6.2.0
*/
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, byscore: "BYSCORE", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", callback?: Callback<number>): Result<number, Context>;
zrangestore(dst: RedisKey, src: RedisKey, min: string | Buffer | number, max: string | Buffer | number, bylex: "BYLEX", rev: "REV", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Determine the index of a member in a sorted set
* - _group_: sorted-set
* - _complexity_: O(log(N))
* - _since_: 2.0.0
*/
zrank(key: RedisKey, member: string | Buffer | number, callback?: Callback<number | null>): Result<number | null, Context>;
/**
* Remove one or more members from a sorted set
* - _group_: sorted-set
* - _complexity_: O(M*log(N)) with N being the number of elements in the sorted set and M the number of elements to be removed.
* - _since_: 1.2.0
*/
zrem(...args: [
key: RedisKey,
...members: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zrem(...args: [
key: RedisKey,
members: (string | Buffer | number)[],
callback: Callback<number>
]): Result<number, Context>;
zrem(...args: [key: RedisKey, ...members: (string | Buffer | number)[]]): Result<number, Context>;
zrem(...args: [key: RedisKey, members: (string | Buffer | number)[]]): Result<number, Context>;
/**
* Remove all members in a sorted set between the given lexicographical range
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
* - _since_: 2.8.9
*/
zremrangebylex(key: RedisKey, min: string | Buffer | number, max: string | Buffer | number, callback?: Callback<number>): Result<number, Context>;
/**
* Remove all members in a sorted set within the given indexes
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
* - _since_: 2.0.0
*/
zremrangebyrank(key: RedisKey, start: number | string, stop: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Remove all members in a sorted set within the given scores
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements removed by the operation.
* - _since_: 1.2.0
*/
zremrangebyscore(key: RedisKey, min: number | string, max: number | string, callback?: Callback<number>): Result<number, Context>;
/**
* Return a range of members in a sorted set, by index, with scores ordered from high to low
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements returned.
* - _since_: 1.2.0
*/
zrevrange(key: RedisKey, start: number | string, stop: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrevrangeBuffer(key: RedisKey, start: number | string, stop: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrevrange(key: RedisKey, start: number | string, stop: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrevrangeBuffer(key: RedisKey, start: number | string, stop: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Return a range of members in a sorted set, by lexicographical range, ordered from higher to lower strings.
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
* - _since_: 2.8.9
*/
zrevrangebylex(key: RedisKey, max: string | Buffer | number, min: string | Buffer | number, callback?: Callback<string[]>): Result<string[], Context>;
zrevrangebylexBuffer(key: RedisKey, max: string | Buffer | number, min: string | Buffer | number, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrevrangebylex(key: RedisKey, max: string | Buffer | number, min: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrevrangebylexBuffer(key: RedisKey, max: string | Buffer | number, min: string | Buffer | number, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Return a range of members in a sorted set, by score, with scores ordered from high to low
* - _group_: sorted-set
* - _complexity_: O(log(N)+M) with N being the number of elements in the sorted set and M the number of elements being returned. If M is constant (e.g. always asking for the first 10 elements with LIMIT), you can consider it O(log(N)).
* - _since_: 2.2.0
*/
zrevrangebyscore(key: RedisKey, max: number | string, min: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrevrangebyscoreBuffer(key: RedisKey, max: number | string, min: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrevrangebyscore(key: RedisKey, max: number | string, min: number | string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrevrangebyscoreBuffer(key: RedisKey, max: number | string, min: number | string, offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrevrangebyscore(key: RedisKey, max: number | string, min: number | string, withscores: "WITHSCORES", callback?: Callback<string[]>): Result<string[], Context>;
zrevrangebyscoreBuffer(key: RedisKey, max: number | string, min: number | string, withscores: "WITHSCORES", callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
zrevrangebyscore(key: RedisKey, max: number | string, min: number | string, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<string[]>): Result<string[], Context>;
zrevrangebyscoreBuffer(key: RedisKey, max: number | string, min: number | string, withscores: "WITHSCORES", offsetCountToken: "LIMIT", offset: number | string, count: number | string, callback?: Callback<Buffer[]>): Result<Buffer[], Context>;
/**
* Determine the index of a member in a sorted set, with scores ordered from high to low
* - _group_: sorted-set
* - _complexity_: O(log(N))
* - _since_: 2.0.0
*/
zrevrank(key: RedisKey, member: string | Buffer | number, callback?: Callback<number | null>): Result<number | null, Context>;
/**
* Incrementally iterate sorted sets elements and associated scores
* - _group_: sorted-set
* - _complexity_: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..
* - _since_: 2.8.0
*/
zscan(key: RedisKey, cursor: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
zscanBuffer(key: RedisKey, cursor: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
zscan(key: RedisKey, cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
zscanBuffer(key: RedisKey, cursor: number | string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
zscan(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
zscanBuffer(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
zscan(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: string, elements: string[]]>): Result<[cursor: string, elements: string[]], Context>;
zscanBuffer(key: RedisKey, cursor: number | string, patternToken: "MATCH", pattern: string, countToken: "COUNT", count: number | string, callback?: Callback<[cursor: Buffer, elements: Buffer[]]>): Result<[cursor: Buffer, elements: Buffer[]], Context>;
/**
* Get the score associated with the given member in a sorted set
* - _group_: sorted-set
* - _complexity_: O(1)
* - _since_: 1.2.0
*/
zscore(key: RedisKey, member: string | Buffer | number, callback?: Callback<string | null>): Result<string | null, Context>;
zscoreBuffer(key: RedisKey, member: string | Buffer | number, callback?: Callback<Buffer | null>): Result<Buffer | null, Context>;
/**
* Add multiple sorted sets
* - _group_: sorted-set
* - _complexity_: O(N)+O(M*log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.
* - _since_: 6.2.0
*/
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<string[], Context>;
zunionBuffer(...args: [numkeys: number | string, ...keys: RedisKey[]]): Result<Buffer[], Context>;
zunion(...args: [numkeys: number | string, keys: RedisKey[]]): Result<string[], Context>;
zunionBuffer(...args: [numkeys: number | string, keys: RedisKey[]]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [numkeys: number | string, ...args: RedisValue[]]): Result<string[], Context>;
zunionBuffer(...args: [numkeys: number | string, ...args: RedisValue[]]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<string[]>
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES",
callback: Callback<Buffer[]>
]): Result<Buffer[], Context>;
zunion(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<string[], Context>;
zunionBuffer(...args: [
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
withscores: "WITHSCORES"
]): Result<Buffer[], Context>;
/**
* Add multiple sorted sets and store the resulting sorted set in a new key
* - _group_: sorted-set
* - _complexity_: O(N)+O(M log(M)) with N being the sum of the sizes of the input sorted sets, and M being the number of elements in the resulting sorted set.
* - _since_: 2.0.0
*/
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[]
]): Result<number, Context>;
zunionstore(...args: [destination: RedisKey, numkeys: number | string, keys: RedisKey[]]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
keys: RedisKey[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[]
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
sum: "SUM"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
min: "MIN"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
max: "MAX"
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT",
callback: Callback<number>
]): Result<number, Context>;
zunionstore(...args: [
destination: RedisKey,
numkeys: number | string,
...args: RedisValue[],
aggregate: "AGGREGATE",
count: "COUNT"
]): Result<number, Context>;
}
export default RedisCommander;
landvex/node_modules/ioredis/built/utils/RedisCommander.js
Generated Vendored
+7
View File
@@ -0,0 +1,7 @@
"use strict";
/**
* This file is generated by @ioredis/interface-generator.
* Don't edit it manually. Instead, run `npm run generate` to update
* this file.
*/
Object.defineProperty(exports, "__esModule", { value: true });
landvex/node_modules/ioredis/built/utils/applyMixin.d.ts
Generated Vendored
+3
View File
@@ -0,0 +1,3 @@
declare type Constructor = new (...args: any[]) => void;
declare function applyMixin(derivedConstructor: Constructor, mixinConstructor: Constructor): void;
export default applyMixin;
landvex/node_modules/ioredis/built/utils/applyMixin.js
Generated Vendored
+8
View File
@@ -0,0 +1,8 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
function applyMixin(derivedConstructor, mixinConstructor) {
Object.getOwnPropertyNames(mixinConstructor.prototype).forEach((name) => {
Object.defineProperty(derivedConstructor.prototype, name, Object.getOwnPropertyDescriptor(mixinConstructor.prototype, name));
});
}
exports.default = applyMixin;
landvex/node_modules/ioredis/built/utils/argumentParsers.d.ts
Generated Vendored
+14
View File
@@ -0,0 +1,14 @@
import { CommandParameter } from "../types";
/**
* Parses a command parameter as seconds and converts to milliseconds.
* @param arg - The command parameter representing seconds
* @returns The value in milliseconds, 0 if value is <= 0, or undefined if parsing fails
*/
export declare const parseSecondsArgument: (arg: CommandParameter | undefined) => number | undefined;
/**
* Parses the BLOCK option from Redis command arguments (e.g., XREAD, XREADGROUP).
* @param args - Array of command parameters to search for the BLOCK option
* @returns The block duration in milliseconds, 0 if duration is <= 0,
* null if BLOCK option is not found, or undefined if BLOCK is found but duration is invalid
*/
export declare const parseBlockOption: (args: CommandParameter[]) => number | null | undefined;
landvex/node_modules/ioredis/built/utils/argumentParsers.js
Generated Vendored
+74
View File
@@ -0,0 +1,74 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.parseBlockOption = exports.parseSecondsArgument = void 0;
/**
* Parses a command parameter to a number.
* @param arg - The command parameter to parse (number, string, or Buffer)
* @returns The parsed number, or undefined if parsing fails or arg is undefined
*/
const parseNumberArgument = (arg) => {
if (typeof arg === "number") {
return arg;
}
if (Buffer.isBuffer(arg)) {
return parseNumberArgument(arg.toString());
}
if (typeof arg === "string") {
const value = Number(arg);
return Number.isFinite(value) ? value : undefined;
}
return undefined;
};
/**
* Parses a command parameter to a string.
* @param arg - The command parameter to parse (string or Buffer)
* @returns The parsed string, or undefined if arg is not a string/Buffer or is undefined
*/
const parseStringArgument = (arg) => {
if (typeof arg === "string") {
return arg;
}
if (Buffer.isBuffer(arg)) {
return arg.toString();
}
return undefined;
};
/**
* Parses a command parameter as seconds and converts to milliseconds.
* @param arg - The command parameter representing seconds
* @returns The value in milliseconds, 0 if value is <= 0, or undefined if parsing fails
*/
const parseSecondsArgument = (arg) => {
const value = parseNumberArgument(arg);
if (value === undefined) {
return undefined;
}
if (value <= 0) {
return 0;
}
return value * 1000;
};
exports.parseSecondsArgument = parseSecondsArgument;
/**
* Parses the BLOCK option from Redis command arguments (e.g., XREAD, XREADGROUP).
* @param args - Array of command parameters to search for the BLOCK option
* @returns The block duration in milliseconds, 0 if duration is <= 0,
* null if BLOCK option is not found, or undefined if BLOCK is found but duration is invalid
*/
const parseBlockOption = (args) => {
for (let i = 0; i < args.length; i++) {
const token = parseStringArgument(args[i]);
if (token && token.toLowerCase() === "block") {
const duration = parseNumberArgument(args[i + 1]);
if (duration === undefined) {
return undefined;
}
if (duration <= 0) {
return 0;
}
return duration;
}
}
return null;
};
exports.parseBlockOption = parseBlockOption;
landvex/node_modules/ioredis/built/utils/debug.d.ts
Generated Vendored
+16
View File
@@ -0,0 +1,16 @@
declare const MAX_ARGUMENT_LENGTH = 200;
/**
* helper function that tried to get a string value for
* arbitrary "debug" arg
*/
declare function getStringValue(v: any): string | void;
/**
* helper function that redacts a string representation of a "debug" arg
*/
declare function genRedactedString(str: string, maxLen: number): string;
/**
* a wrapper for the `debug` module, used to generate
* "debug functions" that trim the values in their output
*/
export default function genDebugFunction(namespace: string): (...args: any[]) => void;
export { MAX_ARGUMENT_LENGTH, getStringValue, genRedactedString };
landvex/node_modules/ioredis/built/utils/debug.js
Generated Vendored
+95
View File
@@ -0,0 +1,95 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.genRedactedString = exports.getStringValue = exports.MAX_ARGUMENT_LENGTH = void 0;
const debug_1 = require("debug");
const MAX_ARGUMENT_LENGTH = 200;
exports.MAX_ARGUMENT_LENGTH = MAX_ARGUMENT_LENGTH;
const NAMESPACE_PREFIX = "ioredis";
/**
* helper function that tried to get a string value for
* arbitrary "debug" arg
*/
function getStringValue(v) {
if (v === null) {
return;
}
switch (typeof v) {
case "boolean":
return;
case "number":
return;
case "object":
if (Buffer.isBuffer(v)) {
return v.toString("hex");
}
if (Array.isArray(v)) {
return v.join(",");
}
try {
return JSON.stringify(v);
}
catch (e) {
return;
}
case "string":
return v;
}
}
exports.getStringValue = getStringValue;
/**
* helper function that redacts a string representation of a "debug" arg
*/
function genRedactedString(str, maxLen) {
const { length } = str;
return length <= maxLen
? str
: str.slice(0, maxLen) + ' ... <REDACTED full-length="' + length + '">';
}
exports.genRedactedString = genRedactedString;
/**
* a wrapper for the `debug` module, used to generate
* "debug functions" that trim the values in their output
*/
function genDebugFunction(namespace) {
const fn = (0, debug_1.default)(`${NAMESPACE_PREFIX}:${namespace}`);
function wrappedDebug(...args) {
if (!fn.enabled) {
return; // no-op
}
// we skip the first arg because that is the message
for (let i = 1; i < args.length; i++) {
const str = getStringValue(args[i]);
if (typeof str === "string" && str.length > MAX_ARGUMENT_LENGTH) {
args[i] = genRedactedString(str, MAX_ARGUMENT_LENGTH);
}
}
return fn.apply(null, args);
}
Object.defineProperties(wrappedDebug, {
namespace: {
get() {
return fn.namespace;
},
},
enabled: {
get() {
return fn.enabled;
},
},
destroy: {
get() {
return fn.destroy;
},
},
log: {
get() {
return fn.log;
},
set(l) {
fn.log = l;
},
},
});
return wrappedDebug;
}
exports.default = genDebugFunction;
landvex/node_modules/ioredis/built/utils/defaults.d.ts
Generated Vendored
+6
View File
@@ -0,0 +1,6 @@
export declare function defaults<T, S>(object: T, source: S): NonNullable<S & T>;
export declare function defaults<T, S1, S2>(object: T, source1: S1, source2: S2): NonNullable<S2 & S1 & T>;
export declare function defaults<T, S1, S2, S3>(object: T, source1: S1, source2: S2, source3: S3): NonNullable<S3 & S2 & S1 & T>;
export declare function defaults<T, S1, S2, S3, S4>(object: T, source1: S1, source2: S2, source3: S3, source4: S4): NonNullable<S4 & S3 & S2 & S1 & T>;
export declare function defaults<T>(object: T): NonNullable<T>;
export declare function defaults(object: any, ...sources: any[]): any;
landvex/node_modules/ioredis/built/utils/defaults.js
Generated Vendored
+102
View File
@@ -0,0 +1,102 @@
"use strict";
/*
* Derived from `src/compat/object/defaults.ts` in es-toolkit
* (https://github.com/toss/es-toolkit).
*
* Copyright (c) 2024 Viva Republica, Inc
* Copyright OpenJS Foundation and other contributors
*
* Parts of the compatibility layer in `es-toolkit/compat` are derived from
* Lodash (https://github.com/lodash/lodash) by the OpenJS Foundation
* (https://openjsf.org/) and Underscore.js by Jeremy Ashkenas, DocumentCloud
* and Investigative Reporters & Editors (http://underscorejs.org/).
*
* This file has been modified from the original source to create a standalone
* adaptation.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.defaults = void 0;
const IS_UNSIGNED_INTEGER = /^(?:0|[1-9]\d*)$/;
function isNil(value) {
return value == null;
}
function eq(value, other) {
return value === other || (Number.isNaN(value) && Number.isNaN(other));
}
function isLength(value) {
return Number.isSafeInteger(value) && value >= 0;
}
function isArrayLike(value) {
return (value != null &&
typeof value !== "function" &&
isLength(value.length));
}
function isObject(value) {
return (value !== null && (typeof value === "object" || typeof value === "function"));
}
function isIndex(value, length = Number.MAX_SAFE_INTEGER) {
switch (typeof value) {
case "number":
return Number.isInteger(value) && value >= 0 && value < length;
case "symbol":
return false;
case "string":
return IS_UNSIGNED_INTEGER.test(value);
}
}
function isIterateeCall(value, index, object) {
if (!isObject(object)) {
return false;
}
if ((typeof index === "number" &&
isArrayLike(object) &&
isIndex(index) &&
index < object.length) ||
(typeof index === "string" && index in object)) {
return eq(object[index], value);
}
return false;
}
function defaults(object, ...sources) {
object = Object(object);
const objectProto = Object.prototype;
let length = sources.length;
const guard = length > 2 ? sources[2] : undefined;
if (guard && isIterateeCall(sources[0], sources[1], guard)) {
length = 1;
}
for (let i = 0; i < length; i++) {
if (isNil(sources[i])) {
continue;
}
const source = sources[i];
for (const key in source) {
const value = object[key];
if (value === undefined ||
(!objectProto.hasOwnProperty.call(object, key) &&
eq(value, objectProto[key]))) {
object[key] = source[key];
}
}
}
return object;
}
exports.defaults = defaults;
landvex/node_modules/ioredis/built/utils/index.d.ts
Generated Vendored
+124
View File
@@ -0,0 +1,124 @@
/// <reference types="node" />
import { defaults, isArguments, noop } from "./lodash";
import { Callback } from "../types";
import Debug from "./debug";
/**
* Convert a buffer to string, supports buffer array
*
* @example
* ```js
* const input = [Buffer.from('foo'), [Buffer.from('bar')]]
* const res = convertBufferToString(input, 'utf8')
* expect(res).to.eql(['foo', ['bar']])
* ```
*/
export declare function convertBufferToString(value: any, encoding?: BufferEncoding): any;
/**
* Convert a list of results to node-style
*
* @example
* ```js
* const input = ['a', 'b', new Error('c'), 'd']
* const output = exports.wrapMultiResult(input)
* expect(output).to.eql([[null, 'a'], [null, 'b'], [new Error('c')], [null, 'd'])
* ```
*/
export declare function wrapMultiResult(arr: unknown[] | null): unknown[][] | null;
/**
* Detect if the argument is a int
* @example
* ```js
* > isInt('123')
* true
* > isInt('123.3')
* false
* > isInt('1x')
* false
* > isInt(123)
* true
* > isInt(true)
* false
* ```
*/
export declare function isInt(value: any): value is string;
/**
* Pack an array to an Object
*
* @example
* ```js
* > packObject(['a', 'b', 'c', 'd'])
* { a: 'b', c: 'd' }
* ```
*/
export declare function packObject(array: any[]): Record<string, any>;
/**
* Return a callback with timeout
*/
export declare function timeout<T>(callback: Callback<T>, timeout: number): Callback<T>;
/**
* Convert an object to an array
* @example
* ```js
* > convertObjectToArray({ a: '1' })
* ['a', '1']
* ```
*/
export declare function convertObjectToArray<T>(obj: Record<string, T>): (string | T)[];
/**
* Convert a map to an array
* @example
* ```js
* > convertMapToArray(new Map([[1, '2']]))
* [1, '2']
* ```
*/
export declare function convertMapToArray<K, V>(map: Map<K, V>): (K | V)[];
/**
* Convert a non-string arg to a string
*/
export declare function toArg(arg: any): string;
/**
* Optimize error stack
*
* @param error actually error
* @param friendlyStack the stack that more meaningful
* @param filterPath only show stacks with the specified path
*/
export declare function optimizeErrorStack(error: Error, friendlyStack: string, filterPath: string): Error;
/**
* Parse the redis protocol url
*/
export declare function parseURL(url: string): Record<string, unknown>;
interface TLSOptions {
port: number;
host: string;
[key: string]: any;
}
/**
* Resolve TLS profile shortcut in connection options
*/
export declare function resolveTLSProfile(options: TLSOptions): TLSOptions;
/**
* Get a random element from `array`
*/
export declare function sample<T>(array: T[], from?: number): T;
/**
* Shuffle the array using the Fisher-Yates Shuffle.
* This method will mutate the original array.
*/
export declare function shuffle<T>(array: T[]): T[];
/**
* Error message for connection being disconnected
*/
export declare const CONNECTION_CLOSED_ERROR_MSG = "Connection is closed.";
export declare function zipMap<K, V>(keys: K[], values: V[]): Map<K, V>;
/**
* Retrieves cached package metadata from package.json.
*
* @internal
* @returns {Promise<{version: string} | null>} Package metadata or null if unavailable
*/
export declare function getPackageMeta(): Promise<{
version: string;
}>;
export { Debug, defaults, isArguments, noop };
landvex/node_modules/ioredis/built/utils/index.js
Generated Vendored
+376
View File
@@ -0,0 +1,376 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.noop = exports.isArguments = exports.defaults = exports.Debug = exports.getPackageMeta = exports.zipMap = exports.CONNECTION_CLOSED_ERROR_MSG = exports.shuffle = exports.sample = exports.resolveTLSProfile = exports.parseURL = exports.optimizeErrorStack = exports.toArg = exports.convertMapToArray = exports.convertObjectToArray = exports.timeout = exports.packObject = exports.isInt = exports.wrapMultiResult = exports.convertBufferToString = void 0;
const fs_1 = require("fs");
const path_1 = require("path");
const lodash_1 = require("./lodash");
Object.defineProperty(exports, "defaults", { enumerable: true, get: function () { return lodash_1.defaults; } });
Object.defineProperty(exports, "isArguments", { enumerable: true, get: function () { return lodash_1.isArguments; } });
Object.defineProperty(exports, "noop", { enumerable: true, get: function () { return lodash_1.noop; } });
const debug_1 = require("./debug");
exports.Debug = debug_1.default;
const TLSProfiles_1 = require("../constants/TLSProfiles");
/**
* Convert a buffer to string, supports buffer array
*
* @example
* ```js
* const input = [Buffer.from('foo'), [Buffer.from('bar')]]
* const res = convertBufferToString(input, 'utf8')
* expect(res).to.eql(['foo', ['bar']])
* ```
*/
function convertBufferToString(value, encoding) {
if (value instanceof Buffer) {
return value.toString(encoding);
}
if (Array.isArray(value)) {
const length = value.length;
const res = Array(length);
for (let i = 0; i < length; ++i) {
res[i] =
value[i] instanceof Buffer && encoding === "utf8"
? value[i].toString()
: convertBufferToString(value[i], encoding);
}
return res;
}
return value;
}
exports.convertBufferToString = convertBufferToString;
/**
* Convert a list of results to node-style
*
* @example
* ```js
* const input = ['a', 'b', new Error('c'), 'd']
* const output = exports.wrapMultiResult(input)
* expect(output).to.eql([[null, 'a'], [null, 'b'], [new Error('c')], [null, 'd'])
* ```
*/
function wrapMultiResult(arr) {
// When using WATCH/EXEC transactions, the EXEC will return
// a null instead of an array
if (!arr) {
return null;
}
const result = [];
const length = arr.length;
for (let i = 0; i < length; ++i) {
const item = arr[i];
if (item instanceof Error) {
result.push([item]);
}
else {
result.push([null, item]);
}
}
return result;
}
exports.wrapMultiResult = wrapMultiResult;
/**
* Detect if the argument is a int
* @example
* ```js
* > isInt('123')
* true
* > isInt('123.3')
* false
* > isInt('1x')
* false
* > isInt(123)
* true
* > isInt(true)
* false
* ```
*/
function isInt(value) {
const x = parseFloat(value);
return !isNaN(value) && (x | 0) === x;
}
exports.isInt = isInt;
/**
* Pack an array to an Object
*
* @example
* ```js
* > packObject(['a', 'b', 'c', 'd'])
* { a: 'b', c: 'd' }
* ```
*/
function packObject(array) {
const result = {};
const length = array.length;
for (let i = 1; i < length; i += 2) {
result[array[i - 1]] = array[i];
}
return result;
}
exports.packObject = packObject;
/**
* Return a callback with timeout
*/
function timeout(callback, timeout) {
let timer = null;
const run = function () {
if (timer) {
clearTimeout(timer);
timer = null;
callback.apply(this, arguments);
}
};
timer = setTimeout(run, timeout, new Error("timeout"));
return run;
}
exports.timeout = timeout;
/**
* Convert an object to an array
* @example
* ```js
* > convertObjectToArray({ a: '1' })
* ['a', '1']
* ```
*/
function convertObjectToArray(obj) {
const result = [];
const keys = Object.keys(obj); // Object.entries requires node 7+
for (let i = 0, l = keys.length; i < l; i++) {
result.push(keys[i], obj[keys[i]]);
}
return result;
}
exports.convertObjectToArray = convertObjectToArray;
/**
* Convert a map to an array
* @example
* ```js
* > convertMapToArray(new Map([[1, '2']]))
* [1, '2']
* ```
*/
function convertMapToArray(map) {
const result = [];
let pos = 0;
map.forEach(function (value, key) {
result[pos] = key;
result[pos + 1] = value;
pos += 2;
});
return result;
}
exports.convertMapToArray = convertMapToArray;
/**
* Convert a non-string arg to a string
*/
function toArg(arg) {
if (arg === null || typeof arg === "undefined") {
return "";
}
return String(arg);
}
exports.toArg = toArg;
/**
* Optimize error stack
*
* @param error actually error
* @param friendlyStack the stack that more meaningful
* @param filterPath only show stacks with the specified path
*/
function optimizeErrorStack(error, friendlyStack, filterPath) {
const stacks = friendlyStack.split("\n");
let lines = "";
let i;
for (i = 1; i < stacks.length; ++i) {
if (stacks[i].indexOf(filterPath) === -1) {
break;
}
}
for (let j = i; j < stacks.length; ++j) {
lines += "\n" + stacks[j];
}
if (error.stack) {
const pos = error.stack.indexOf("\n");
error.stack = error.stack.slice(0, pos) + lines;
}
return error;
}
exports.optimizeErrorStack = optimizeErrorStack;
/**
* Parse the redis protocol url
*/
function parseURL(url) {
if (isInt(url)) {
return { port: url };
}
// Re-assert string type: isInt's type guard (value is string) incorrectly
// narrows url to 'never' in the false branch since url is already string.
const rawUrl = url;
// Determine if the URL has a known protocol (redis:// or rediss://)
const hasProtocol = /^rediss?:\/\//i.test(rawUrl);
const isProtocolRelative = rawUrl.startsWith("//");
// TODO(next major): Consider rejecting protocol-relative Redis URLs early and
// requiring explicit redis:// or rediss:// schemes instead. Keep them working
// in 5.x for backward compatibility.
// Unix socket paths (starting with "/") are not valid URLs — handle separately.
// Preserve query params (e.g., /tmp/redis.sock?db=2)
if (rawUrl[0] === "/" && !isProtocolRelative) {
const qIdx = rawUrl.indexOf("?");
const result = {
path: qIdx === -1 ? rawUrl : rawUrl.slice(0, qIdx),
};
if (qIdx !== -1) {
const options = {};
const params = new URLSearchParams(rawUrl.slice(qIdx + 1));
params.forEach((value, key) => {
options[key] = parseURLQueryItem(key, value);
});
(0, lodash_1.defaults)(result, options);
}
return result;
}
let parsed;
if (hasProtocol) {
parsed = new URL(rawUrl);
}
else if (isProtocolRelative) {
parsed = new URL("redis:" + rawUrl);
}
else {
// Prepend a dummy protocol so new URL() can parse "host:port?query" correctly
parsed = new URL("redis://" + rawUrl);
}
// Convert searchParams to a plain object (equivalent to url.parse(url, true).query)
const options = {};
parsed.searchParams.forEach((value, key) => {
options[key] = parseURLQueryItem(key, value);
});
const result = {};
// Extract auth — WHATWG URL percent-encodes special chars, so decode them.
// Check both username AND password: redis://:password@host has empty username but valid password.
if (parsed.username || parsed.password) {
result.username = decodeURIComponent(parsed.username);
result.password = decodeURIComponent(parsed.password);
}
if (parsed.pathname && parsed.pathname !== "/") {
if (hasProtocol || isProtocolRelative) {
// For redis://, rediss://, and protocol-relative URLs, the path after /
// is the db number
if (parsed.pathname.length > 1) {
result.db = parsed.pathname.slice(1);
}
}
else {
result.path = parsed.pathname;
}
}
if (parsed.hostname) {
// WHATWG URL keeps brackets around IPv6 addresses (e.g., "[::1]").
// Strip them to match the old url.parse() behavior.
result.host = parsed.hostname.replace(/^\[|\]$/g, "");
}
if (parsed.port) {
result.port = parsed.port;
}
(0, lodash_1.defaults)(result, options);
return result;
}
exports.parseURL = parseURL;
function parseURLQueryItem(key, value) {
if (key === "family") {
const intFamily = Number.parseInt(value, 10);
if (!Number.isNaN(intFamily)) {
return intFamily;
}
}
return value;
}
/**
* Resolve TLS profile shortcut in connection options
*/
function resolveTLSProfile(options) {
let tls = options === null || options === void 0 ? void 0 : options.tls;
if (typeof tls === "string")
tls = { profile: tls };
const profile = TLSProfiles_1.default[tls === null || tls === void 0 ? void 0 : tls.profile];
if (profile) {
tls = Object.assign({}, profile, tls);
delete tls.profile;
options = Object.assign({}, options, { tls });
}
return options;
}
exports.resolveTLSProfile = resolveTLSProfile;
/**
* Get a random element from `array`
*/
function sample(array, from = 0) {
const length = array.length;
if (from >= length) {
return null;
}
return array[from + Math.floor(Math.random() * (length - from))];
}
exports.sample = sample;
/**
* Shuffle the array using the Fisher-Yates Shuffle.
* This method will mutate the original array.
*/
function shuffle(array) {
let counter = array.length;
// While there are elements in the array
while (counter > 0) {
// Pick a random index
const index = Math.floor(Math.random() * counter);
// Decrease counter by 1
counter--;
// And swap the last element with it
[array[counter], array[index]] = [array[index], array[counter]];
}
return array;
}
exports.shuffle = shuffle;
/**
* Error message for connection being disconnected
*/
exports.CONNECTION_CLOSED_ERROR_MSG = "Connection is closed.";
function zipMap(keys, values) {
const map = new Map();
keys.forEach((key, index) => {
map.set(key, values[index]);
});
return map;
}
exports.zipMap = zipMap;
/**
* Memoized package metadata to avoid repeated file system reads.
*
* @internal
*/
let cachedPackageMeta = null;
/**
* Retrieves cached package metadata from package.json.
*
* @internal
* @returns {Promise<{version: string} | null>} Package metadata or null if unavailable
*/
async function getPackageMeta() {
if (cachedPackageMeta) {
return cachedPackageMeta;
}
try {
const filePath = (0, path_1.resolve)(__dirname, "..", "..", "package.json");
const data = await fs_1.promises.readFile(filePath, "utf8");
const parsed = JSON.parse(data);
cachedPackageMeta = {
version: parsed.version,
};
return cachedPackageMeta;
}
catch (err) {
cachedPackageMeta = {
version: "error-fetching-version",
};
return cachedPackageMeta;
}
}
exports.getPackageMeta = getPackageMeta;
landvex/node_modules/ioredis/built/utils/isArguments.d.ts
Generated Vendored
+1
View File
@@ -0,0 +1 @@
export declare function isArguments(value?: unknown): value is IArguments;
landvex/node_modules/ioredis/built/utils/isArguments.js
Generated Vendored
+48
View File
@@ -0,0 +1,48 @@
"use strict";
/*
* Derived from `src/compat/predicate/isArguments.ts` in es-toolkit
* (https://github.com/toss/es-toolkit).
*
* Copyright (c) 2024 Viva Republica, Inc
* Copyright OpenJS Foundation and other contributors
*
* Parts of the compatibility layer in `es-toolkit/compat` are derived from
* Lodash (https://github.com/lodash/lodash) by the OpenJS Foundation
* (https://openjsf.org/) and Underscore.js by Jeremy Ashkenas, DocumentCloud
* and Investigative Reporters & Editors (http://underscorejs.org/).
*
* This file has been modified from the original source to create a standalone
* adaptation.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.isArguments = void 0;
function getTag(value) {
if (value == null) {
return value === undefined ? "[object Undefined]" : "[object Null]";
}
return Object.prototype.toString.call(value);
}
function isArguments(value) {
return (value !== null &&
typeof value === "object" &&
getTag(value) === "[object Arguments]");
}
exports.isArguments = isArguments;
landvex/node_modules/ioredis/built/utils/lodash.d.ts
Generated Vendored
+3
View File
@@ -0,0 +1,3 @@
export declare function noop(): void;
export * from "./defaults";
export * from "./isArguments";
landvex/node_modules/ioredis/built/utils/lodash.js
Generated Vendored
+17
View File
@@ -0,0 +1,17 @@
"use strict";
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.noop = void 0;
function noop() { }
exports.noop = noop;
__exportStar(require("./defaults"), exports);
__exportStar(require("./isArguments"), exports);
landvex/node_modules/ioredis/package.json
Generated Vendored
+98
View File
@@ -0,0 +1,98 @@
{
"name": "ioredis",
"version": "5.11.1",
"description": "A robust, performance-focused and full-featured Redis client for Node.js.",
"main": "./built/index.js",
"types": "./built/index.d.ts",
"files": [
"built/"
],
"scripts": {
"docker:setup": "docker compose -f test/docker-compose.yml up -d --wait",
"docker:teardown": "docker compose -f test/docker-compose.yml down --volumes --remove-orphans",
"test:tsd": "npm run build && tsd",
"test:js": "TS_NODE_TRANSPILE_ONLY=true NODE_ENV=test mocha --no-experimental-strip-types \"test/helpers/*.ts\" \"test/unit/**/*.ts\" \"test/functional/**/*.ts\"",
"test:cov": "nyc npm run test:js",
"test:cluster": "TS_NODE_TRANSPILE_ONLY=true NODE_ENV=test mocha --no-experimental-strip-types \"test/cluster/**/*.ts\"",
"test": "npm run test:js && npm run test:tsd",
"lint": "eslint --ext .js,.ts ./lib",
"docs": "npx typedoc --logLevel Error --excludeExternals --excludeProtected --excludePrivate --readme none lib/index.ts",
"format": "prettier --write \"{,!(node_modules)/**/}*.{js,ts}\"",
"format-check": "prettier --check \"{,!(node_modules)/**/}*.{js,ts}\"",
"build": "rm -rf built && tsc",
"prepublishOnly": "npm run build",
"semantic-release": "semantic-release"
},
"repository": {
"type": "git",
"url": "git://github.com/luin/ioredis.git"
},
"keywords": [
"redis",
"cluster",
"sentinel",
"pipelining"
],
"tsd": {
"directory": "test/typing"
},
"author": "Zihua Li <i@zihua.li> (http://zihua.li)",
"license": "MIT",
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/ioredis"
},
"dependencies": {
"@ioredis/commands": "1.10.0",
"cluster-key-slot": "1.1.1",
"debug": "4.4.3",
"denque": "2.1.0",
"redis-errors": "1.2.0",
"redis-parser": "3.0.0",
"standard-as-callback": "2.1.0"
},
"devDependencies": {
"@ioredis/interface-generator": "^1.3.0",
"@semantic-release/changelog": "^6.0.1",
"@semantic-release/commit-analyzer": "^9.0.2",
"@semantic-release/git": "^10.0.1",
"@types/chai": "^4.3.0",
"@types/chai-as-promised": "^7.1.5",
"@types/debug": "^4.1.5",
"@types/mocha": "^9.1.0",
"@types/node": "^14.18.12",
"@types/redis-errors": "^1.2.1",
"@types/sinon": "^10.0.11",
"@typescript-eslint/eslint-plugin": "^5.48.1",
"@typescript-eslint/parser": "^5.48.1",
"chai": "^4.3.6",
"chai-as-promised": "^7.1.1",
"eslint": "^8.31.0",
"eslint-config-prettier": "^8.6.0",
"mocha": "^11.7.6",
"nyc": "^15.1.0",
"prettier": "^2.6.1",
"semantic-release": "^19.0.2",
"server-destroy": "^1.0.1",
"sinon": "^13.0.1",
"ts-node": "^10.4.0",
"tsd": "^0.19.1",
"typedoc": "^0.22.18",
"typescript": "^4.6.3",
"uuid": "^9.0.0"
},
"nyc": {
"reporter": [
"lcov"
]
},
"engines": {
"node": ">=12.22.0"
},
"mocha": {
"exit": true,
"timeout": 8000,
"recursive": true,
"require": "ts-node/register"
}
}