Directus / @directus/memory / index / ExtendedRedis

Interface: ExtendedRedis ​

Extends ​

• Redis

Properties ​

options ​

options: RedisOptions

Inherited from ​

Redis.options

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:42

status ​

status: RedisStatus

Inherited from ​

Redis.status

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:43

Accessors ​

autoPipelineQueueSize ​

get autoPipelineQueueSize(): number

Returns ​

number

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:77

mode ​

get mode(): "monitor" | "normal" | "subscriber"

Mode of the connection.

One of "normal", "subscriber", or "monitor". When the connection is not in "normal" mode, certain commands are not allowed.

Returns ​

"monitor" | "normal" | "subscriber"

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:117

Methods ​

[captureRejectionSymbol]()? ​

optional [captureRejectionSymbol]<K>(error, event, ...args): void

Type parameters ​

• K

Parameters ​

• error: Error

• event: string | symbol

• ...args: AnyRest

Returns ​

void

Inherited from ​

Redis.[captureRejectionSymbol]

Source ​

node_modules/.pnpm/@types+node@18.19.50/node_modules/@types/node/events.d.ts:131

acl() ​

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<unknown>

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

Parameters ​

• subcommand: "CAT"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:62

acl(subcommand, categoryname, callback) ​

acl(subcommand, categoryname, callback?): Promise<unknown>

Parameters ​

• subcommand: "CAT"

• categoryname: string | Buffer

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:63

acl(args) ​

acl(...args): Promise<number>

Remove the specified ACL users and the associated rules

• group: server
• complexity: O(1) amortized time considering the typical user.
• since: 6.0.0

Parameters ​

• ...args: ["DELUSER", ...usernames: (string | Buffer)[], Callback<number>]

Returns ​

Promise<number>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:70

acl(args) ​

acl(...args): Promise<number>

Parameters ​

• ...args: ["DELUSER", ...usernames: (string | Buffer)[]]

Returns ​

Promise<number>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:75

acl(subcommand, username, command, callback) ​

acl(subcommand, username, command, callback?): Promise<string>

Returns whether the user can execute the given command without executing the command.

• group: server
• complexity: O(1).
• since: 7.0.0

Parameters ​

• subcommand: "DRYRUN"

• username: string | Buffer

• command: string | Buffer

• callback?: Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:82

acl(args) ​

acl(...args): Promise<string>

Parameters ​

• ...args: ["DRYRUN", string | Buffer, string | Buffer, ...args: (string | number | Buffer)[], Callback<string>]

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:84

acl(args) ​

acl(...args): Promise<string>

Parameters ​

• ...args: ["DRYRUN", string | Buffer, string | Buffer, ...args: (string | number | Buffer)[]]

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:98

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<string>

Generate a pseudorandom secure password to use for ACL users

• group: server
• complexity: O(1)
• since: 6.0.0

Parameters ​

• subcommand: "GENPASS"

• callback?: Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:116

acl(subcommand, bits, callback) ​

acl(subcommand, bits, callback?): Promise<string>

Parameters ​

• subcommand: "GENPASS"

• bits: string | number

• callback?: Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:118

acl(subcommand, username, callback) ​

acl(subcommand, username, callback?): Promise<null | string[]>

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

Parameters ​

• subcommand: "GETUSER"

• username: string | Buffer

• callback?: Callback<null | string[]>

Returns ​

Promise<null | string[]>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:126

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<unknown>

Show helpful text about the different subcommands

• group: server
• complexity: O(1)
• since: 6.0.0

Parameters ​

• subcommand: "HELP"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:134

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<string[]>

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

Parameters ​

• subcommand: "LIST"

• callback?: Callback<string[]>

Returns ​

Promise<string[]>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:141

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<"OK">

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

Parameters ​

• subcommand: "LOAD"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:149

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<unknown>

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

Parameters ​

• subcommand: "LOG"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:156

acl(subcommand, count, callback) ​

acl(subcommand, count, callback?): Promise<unknown>

Parameters ​

• subcommand: "LOG"

• count: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:157

acl(subcommand, reset, callback) ​

acl(subcommand, reset, callback?): Promise<unknown>

Parameters ​

• subcommand: "LOG"

• reset: "RESET"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:158

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<"OK">

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

Parameters ​

• subcommand: "SAVE"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:165

acl(subcommand, username, callback) ​

acl(subcommand, username, callback?): Promise<"OK">

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

Parameters ​

• subcommand: "SETUSER"

• username: string | Buffer

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:172

acl(args) ​

acl(...args): Promise<"OK">

Parameters ​

• ...args: ["SETUSER", string | Buffer, ...rules: (string | Buffer)[], Callback<"OK">]

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:173

acl(args) ​

acl(...args): Promise<"OK">

Parameters ​

• ...args: ["SETUSER", string | Buffer, ...rules: (string | Buffer)[]]

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:179

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<string[]>

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

Parameters ​

• subcommand: "USERS"

• callback?: Callback<string[]>

Returns ​

Promise<string[]>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:190

acl(subcommand, callback) ​

acl(subcommand, callback?): Promise<string>

Return the name of the user associated to the current connection

• group: server
• complexity: O(1)
• since: 6.0.0

Parameters ​

• subcommand: "WHOAMI"

• callback?: Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:198

aclBuffer() ​

aclBuffer(subcommand, username, command, callback) ​

aclBuffer(subcommand, username, command, callback?): Promise<Buffer>

Parameters ​

• subcommand: "DRYRUN"

• username: string | Buffer

• command: string | Buffer

• callback?: Callback<Buffer>

Returns ​

Promise<Buffer>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:83

aclBuffer(args) ​

aclBuffer(...args): Promise<Buffer>

Parameters ​

• ...args: ["DRYRUN", string | Buffer, string | Buffer, ...args: (string | number | Buffer)[], Callback<Buffer>]

Returns ​

Promise<Buffer>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:91

aclBuffer(args) ​

aclBuffer(...args): Promise<Buffer>

Parameters ​

• ...args: ["DRYRUN", string | Buffer, string | Buffer, ...args: (string | number | Buffer)[]]

Returns ​

Promise<Buffer>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:104

aclBuffer(subcommand, callback) ​

aclBuffer(subcommand, callback?): Promise<Buffer>

Parameters ​

• subcommand: "GENPASS"

• callback?: Callback<Buffer>

Returns ​

Promise<Buffer>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:117

aclBuffer(subcommand, bits, callback) ​

aclBuffer(subcommand, bits, callback?): Promise<Buffer>

Parameters ​

• subcommand: "GENPASS"

• bits: string | number

• callback?: Callback<Buffer>

Returns ​

Promise<Buffer>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:119

aclBuffer(subcommand, username, callback) ​

aclBuffer(subcommand, username, callback?): Promise<null | Buffer[]>

Parameters ​

• subcommand: "GETUSER"

• username: string | Buffer

• callback?: Callback<null | Buffer[]>

Returns ​

Promise<null | Buffer[]>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:127

aclBuffer(subcommand, callback) ​

aclBuffer(subcommand, callback?): Promise<Buffer[]>

Parameters ​

• subcommand: "LIST"

• callback?: Callback<Buffer[]>

Returns ​

Promise<Buffer[]>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:142

aclBuffer(subcommand, callback) ​

aclBuffer(subcommand, callback?): Promise<Buffer[]>

Parameters ​

• subcommand: "USERS"

• callback?: Callback<Buffer[]>

Returns ​

Promise<Buffer[]>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:191

aclBuffer(subcommand, callback) ​

aclBuffer(subcommand, callback?): Promise<Buffer>

Parameters ​

• subcommand: "WHOAMI"

• callback?: Callback<Buffer>

Returns ​

Promise<Buffer>

Inherited from ​

Redis.aclBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:199

addBuiltinCommand() ​

addBuiltinCommand(commandName): void

Create add builtin command

Parameters ​

• commandName: string

Returns ​

void

Inherited from ​

Redis.addBuiltinCommand

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/Commander.d.ts:34

addListener() ​

addListener<K>(eventName, listener): this

Alias for emitter.on(eventName, listener).

Type parameters ​

• K

Parameters ​

• eventName: string | symbol

• listener

Returns ​

this

Inherited from ​

Redis.addListener

Since ​

v0.1.26

Source ​

node_modules/.pnpm/@types+node@18.19.50/node_modules/@types/node/events.d.ts:491

append() ​

append(key, value, callback?): Promise<number>

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

Parameters ​

• key: RedisKey

• value: string | number | Buffer

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.append

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:206

asking() ​

asking(callback?): Promise<"OK">

Sent by cluster clients after an -ASK redirect

• group: cluster
• complexity: O(1)
• since: 3.0.0

Parameters ​

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.asking

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:213

auth() ​

auth(password, callback) ​

auth(password, callback?): Promise<"OK">

Authenticate to the server

• group: connection
• complexity: O(N) where N is the number of passwords defined for the user
• since: 1.0.0

Parameters ​

• password: string | Buffer

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.auth

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:220

auth(username, password, callback) ​

auth(username, password, callback?): Promise<"OK">

Parameters ​

• username: string | Buffer

• password: string | Buffer

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.auth

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:221

bgrewriteaof() ​

bgrewriteaof(callback?): Promise<string>

Asynchronously rewrite the append-only file

• group: server
• complexity: O(1)
• since: 1.0.0

Parameters ​

• callback?: Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.bgrewriteaof

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:228

bgrewriteaofBuffer() ​

bgrewriteaofBuffer(callback?): Promise<Buffer>

Parameters ​

• callback?: Callback<Buffer>

Returns ​

Promise<Buffer>

Inherited from ​

Redis.bgrewriteaofBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:229

bgsave() ​

bgsave(callback) ​

bgsave(callback?): Promise<"OK">

Asynchronously save the dataset to disk

• group: server
• complexity: O(1)
• since: 1.0.0

Parameters ​

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.bgsave

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:236

bgsave(schedule, callback) ​

bgsave(schedule, callback?): Promise<"OK">

Parameters ​

• schedule: "SCHEDULE"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.bgsave

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:237

bitcount() ​

bitcount(key, callback) ​

bitcount(key, callback?): Promise<number>

Count set bits in a string

• group: bitmap
• complexity: O(N)
• since: 2.6.0

Parameters ​

• key: RedisKey

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitcount

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:244

bitcount(key, start, end, callback) ​

bitcount(key, start, end, callback?): Promise<number>

Parameters ​

• key: RedisKey

• start: string | number

• end: string | number

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitcount

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:245

bitcount(key, start, end, byte, callback) ​

bitcount(key, start, end, byte, callback?): Promise<number>

Parameters ​

• key: RedisKey

• start: string | number

• end: string | number

• byte: "BYTE"

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitcount

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:246

bitcount(key, start, end, bit, callback) ​

bitcount(key, start, end, bit, callback?): Promise<number>

Parameters ​

• key: RedisKey

• start: string | number

• end: string | number

• bit: "BIT"

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitcount

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:247

bitfield() ​

bitfield(key, encodingOffsetToken, encoding, offset, callback) ​

bitfield(key, encodingOffsetToken, encoding, offset, callback?): Promise<unknown>

Perform arbitrary bitfield integer operations on strings

• group: bitmap
• complexity: O(1) for each subcommand specified
• since: 3.2.0

Parameters ​

• key: RedisKey

• encodingOffsetToken: "GET"

• encoding: string | Buffer

• offset: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:254

bitfield(key, encodingOffsetValueToken, encoding, offset, value, callback) ​

bitfield(key, encodingOffsetValueToken, encoding, offset, value, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• encodingOffsetValueToken: "SET"

• encoding: string | Buffer

• offset: string | number

• value: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:255

bitfield(key, encodingOffsetIncrementToken, encoding, offset, increment, callback) ​

bitfield(key, encodingOffsetIncrementToken, encoding, offset, increment, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• encodingOffsetIncrementToken: "INCRBY"

• encoding: string | Buffer

• offset: string | number

• increment: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:256

bitfield(key, overflow, wrap, encodingOffsetValueToken, encoding, offset, value, callback) ​

bitfield(key, overflow, wrap, encodingOffsetValueToken, encoding, offset, value, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• overflow: "OVERFLOW"

• wrap: "WRAP"

• encodingOffsetValueToken: "SET"

• encoding: string | Buffer

• offset: string | number

• value: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:257

bitfield(key, overflow, wrap, encodingOffsetIncrementToken, encoding, offset, increment, callback) ​

bitfield(key, overflow, wrap, encodingOffsetIncrementToken, encoding, offset, increment, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• overflow: "OVERFLOW"

• wrap: "WRAP"

• encodingOffsetIncrementToken: "INCRBY"

• encoding: string | Buffer

• offset: string | number

• increment: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:258

bitfield(key, overflow, sat, encodingOffsetValueToken, encoding, offset, value, callback) ​

bitfield(key, overflow, sat, encodingOffsetValueToken, encoding, offset, value, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• overflow: "OVERFLOW"

• sat: "SAT"

• encodingOffsetValueToken: "SET"

• encoding: string | Buffer

• offset: string | number

• value: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:259

bitfield(key, overflow, sat, encodingOffsetIncrementToken, encoding, offset, increment, callback) ​

bitfield(key, overflow, sat, encodingOffsetIncrementToken, encoding, offset, increment, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• overflow: "OVERFLOW"

• sat: "SAT"

• encodingOffsetIncrementToken: "INCRBY"

• encoding: string | Buffer

• offset: string | number

• increment: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:260

bitfield(key, overflow, fail, encodingOffsetValueToken, encoding, offset, value, callback) ​

bitfield(key, overflow, fail, encodingOffsetValueToken, encoding, offset, value, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• overflow: "OVERFLOW"

• fail: "FAIL"

• encodingOffsetValueToken: "SET"

• encoding: string | Buffer

• offset: string | number

• value: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:261

bitfield(key, overflow, fail, encodingOffsetIncrementToken, encoding, offset, increment, callback) ​

bitfield(key, overflow, fail, encodingOffsetIncrementToken, encoding, offset, increment, callback?): Promise<unknown>

Parameters ​

• key: RedisKey

• overflow: "OVERFLOW"

• fail: "FAIL"

• encodingOffsetIncrementToken: "INCRBY"

• encoding: string | Buffer

• offset: string | number

• increment: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:262

bitfield_ro() ​

bitfield_ro(args) ​

bitfield_ro(...args): Promise<unknown[]>

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

Parameters ​

• ...args: [RedisKey, "GET", ...encodingOffsets: (string | number | Buffer)[], Callback<unknown[]>]

Returns ​

Promise<unknown[]>

Inherited from ​

Redis.bitfield_ro

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:269

bitfield_ro(args) ​

bitfield_ro(...args): Promise<unknown[]>

Parameters ​

• ...args: [RedisKey, "GET", ...encodingOffsets: (string | number | Buffer)[]]

Returns ​

Promise<unknown[]>

Inherited from ​

Redis.bitfield_ro

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:275

bitop() ​

bitop(args) ​

bitop(...args): Promise<number>

Perform bitwise operations between strings

• group: bitmap
• complexity: O(N)
• since: 2.6.0

Parameters ​

• ...args: [string | Buffer, RedisKey, ...keys: RedisKey[], Callback<number>]

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:286

bitop(args) ​

bitop(...args): Promise<number>

Parameters ​

• ...args: [string | Buffer, RedisKey, RedisKey[], Callback<number>]

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:292

bitop(args) ​

bitop(...args): Promise<number>

Parameters ​

• ...args: [string | Buffer, RedisKey, ...keys: RedisKey[]]

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:298

bitop(args) ​

bitop(...args): Promise<number>

Parameters ​

• ...args: [string | Buffer, RedisKey, RedisKey[]]

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:303

bitpos() ​

bitpos(key, bit, callback) ​

bitpos(key, bit, callback?): Promise<number>

Find first bit set or clear in a string

• group: bitmap
• complexity: O(N)
• since: 2.8.7

Parameters ​

• key: RedisKey

• bit: string | number

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:310

bitpos(key, bit, start, callback) ​

bitpos(key, bit, start, callback?): Promise<number>

Parameters ​

• key: RedisKey

• bit: string | number

• start: string | number

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:311

bitpos(key, bit, start, end, callback) ​

bitpos(key, bit, start, end, callback?): Promise<number>

Parameters ​

• key: RedisKey

• bit: string | number

• start: string | number

• end: string | number

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:312

bitpos(key, bit, start, end, byte, callback) ​

bitpos(key, bit, start, end, byte, callback?): Promise<number>

Parameters ​

• key: RedisKey

• bit: string | number

• start: string | number

• end: string | number

• byte: "BYTE"

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:313

bitpos(key, bit, start, end, bit1, callback) ​

bitpos(key, bit, start, end, bit1, callback?): Promise<number>

Parameters ​

• key: RedisKey

• bit: string | number

• start: string | number

• end: string | number

• bit1: "BIT"

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:314

blmove() ​

blmove(source, destination, left, left1, timeout, callback) ​

blmove(source, destination, left, left1, timeout, callback?): Promise<null | string>

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

Parameters ​

• source: RedisKey

• destination: RedisKey

• left: "LEFT"

• left1: "LEFT"

• timeout: string | number

• callback?: Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.blmove

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:321

blmove(source, destination, left, right, timeout, callback) ​

blmove(source, destination, left, right, timeout, callback?): Promise<null | string>

Parameters ​

• source: RedisKey

• destination: RedisKey

• left: "LEFT"

• right: "RIGHT"

• timeout: string | number

• callback?: Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.blmove

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:323

blmove(source, destination, right, left, timeout, callback) ​

blmove(source, destination, right, left, timeout, callback?): Promise<null | string>

Parameters ​

• source: RedisKey

• destination: RedisKey

• right: "RIGHT"

• left: "LEFT"

• timeout: string | number

• callback?: Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.blmove

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:325

blmove(source, destination, right, right1, timeout, callback) ​

blmove(source, destination, right, right1, timeout, callback?): Promise<null | string>

Parameters ​

• source: RedisKey

• destination: RedisKey

• right: "RIGHT"

• right1: "RIGHT"

• timeout: string | number

• callback?: Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.blmove

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:327

blmoveBuffer() ​

blmoveBuffer(source, destination, left, left1, timeout, callback) ​

blmoveBuffer(source, destination, left, left1, timeout, callback?): Promise<null | Buffer>

Parameters ​

• source: RedisKey

• destination: RedisKey

• left: "LEFT"

• left1: "LEFT"

• timeout: string | number

• callback?: Callback<null | Buffer>

Returns ​

Promise<null | Buffer>

Inherited from ​

Redis.blmoveBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:322

blmoveBuffer(source, destination, left, right, timeout, callback) ​

blmoveBuffer(source, destination, left, right, timeout, callback?): Promise<null | Buffer>

Parameters ​

• source: RedisKey

• destination: RedisKey

• left: "LEFT"

• right: "RIGHT"

• timeout: string | number

• callback?: Callback<null | Buffer>

Returns ​

Promise<null | Buffer>

Inherited from ​

Redis.blmoveBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:324

blmoveBuffer(source, destination, right, left, timeout, callback) ​

blmoveBuffer(source, destination, right, left, timeout, callback?): Promise<null | Buffer>

Parameters ​

• source: RedisKey

• destination: RedisKey

• right: "RIGHT"

• left: "LEFT"

• timeout: string | number

• callback?: Callback<null | Buffer>

Returns ​

Promise<null | Buffer>

Inherited from ​

Redis.blmoveBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:326

blmoveBuffer(source, destination, right, right1, timeout, callback) ​

blmoveBuffer(source, destination, right, right1, timeout, callback?): Promise<null | Buffer>

Parameters ​

• source: RedisKey

• destination: RedisKey

• right: "RIGHT"

• right1: "RIGHT"

• timeout: string | number

• callback?: Callback<null | Buffer>

Returns ​

Promise<null | Buffer>

Inherited from ​

Redis.blmoveBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:328

blmpop() ​

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

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

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT", Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:335

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT", Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:349

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT"]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:363

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT"]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:375

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT", "COUNT", string | number, Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:387

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT", "COUNT", string | number, Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:405

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT", "COUNT", string | number]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:423

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT", "COUNT", string | number]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:439

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT", Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:455

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT", Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:469

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT"]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:483

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT"]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:495

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT", "COUNT", string | number, Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:507

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT", "COUNT", string | number, Callback<null | [string, string[]]>]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:525

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT", "COUNT", string | number]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:543

blmpop(args) ​

blmpop(...args): Promise<null | [string, string[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT", "COUNT", string | number]

Returns ​

Promise<null | [string, string[]]>

Inherited from ​

Redis.blmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:559

blmpopBuffer() ​

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT", Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:342

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT", Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:356

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT"]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:369

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT"]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:381

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT", "COUNT", string | number, Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:396

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT", "COUNT", string | number, Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:414

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "LEFT", "COUNT", string | number]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:431

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "LEFT", "COUNT", string | number]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:447

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT", Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:462

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT", Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:476

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT"]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:489

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT"]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:501

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT", "COUNT", string | number, Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:516

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT", "COUNT", string | number, Callback<null | [Buffer, Buffer[]]>]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:534

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "RIGHT", "COUNT", string | number]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:551

blmpopBuffer(args) ​

blmpopBuffer(...args): Promise<null | [Buffer, Buffer[]]>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "RIGHT", "COUNT", string | number]

Returns ​

Promise<null | [Buffer, Buffer[]]>

Inherited from ​

Redis.blmpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:567

blpop() ​

blpop(args) ​

blpop(...args): Promise<null | [string, string]>

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

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [string, string]>]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.blpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:581

blpop(args) ​

blpop(...args): Promise<null | [string, string]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [string, string]>]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.blpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:591

blpop(args) ​

blpop(...args): Promise<null | [string, string]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.blpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:601

blpop(args) ​

blpop(...args): Promise<null | [string, string]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.blpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:603

blpopBuffer() ​

blpopBuffer(args) ​

blpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.blpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:586

blpopBuffer(args) ​

blpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.blpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:596

blpopBuffer(args) ​

blpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.blpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:602

blpopBuffer(args) ​

blpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.blpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:604

brpop() ​

brpop(args) ​

brpop(...args): Promise<null | [string, string]>

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

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [string, string]>]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.brpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:611

brpop(args) ​

brpop(...args): Promise<null | [string, string]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [string, string]>]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.brpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:621

brpop(args) ​

brpop(...args): Promise<null | [string, string]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.brpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:631

brpop(args) ​

brpop(...args): Promise<null | [string, string]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.brpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:633

brpopBuffer() ​

brpopBuffer(args) ​

brpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.brpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:616

brpopBuffer(args) ​

brpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.brpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:626

brpopBuffer(args) ​

brpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.brpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:632

brpopBuffer(args) ​

brpopBuffer(...args): Promise<null | [Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer]>

Inherited from ​

Redis.brpopBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:634

brpoplpush() ​

brpoplpush(source, destination, timeout, callback?): Promise<null | string>

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

Parameters ​

• source: RedisKey

• destination: RedisKey

• timeout: string | number

• callback?: Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.brpoplpush

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:641

brpoplpushBuffer() ​

brpoplpushBuffer(source, destination, timeout, callback?): Promise<null | Buffer>

Parameters ​

• source: RedisKey

• destination: RedisKey

• timeout: string | number

• callback?: Callback<null | Buffer>

Returns ​

Promise<null | Buffer>

Inherited from ​

Redis.brpoplpushBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:642

bzmpop() ​

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

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

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MIN", Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:649

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MIN", Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:656

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MIN"]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:663

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MIN"]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:669

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MIN", "COUNT", string | number, Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:675

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MIN", "COUNT", string | number, Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:684

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MIN", "COUNT", string | number]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:693

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MIN", "COUNT", string | number]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:701

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MAX", Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:709

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MAX", Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:716

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MAX"]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:723

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MAX"]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:729

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MAX", "COUNT", string | number, Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:735

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MAX", "COUNT", string | number, Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:744

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, ...keys: RedisKey[], "MAX", "COUNT", string | number]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:753

bzmpop(args) ​

bzmpop(...args): Promise<unknown>

Parameters ​

• ...args: [string | number, string | number, RedisKey[], "MAX", "COUNT", string | number]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:761

bzpopmax() ​

bzpopmax(args) ​

bzpopmax(...args): Promise<null | [string, string, string]>

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

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [string, string, string]>]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmax

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:775

bzpopmax(args) ​

bzpopmax(...args): Promise<null | [string, string, string]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [string, string, string]>]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmax

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:785

bzpopmax(args) ​

bzpopmax(...args): Promise<null | [string, string, string]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmax

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:795

bzpopmax(args) ​

bzpopmax(...args): Promise<null | [string, string, string]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmax

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:797

bzpopmaxBuffer() ​

bzpopmaxBuffer(args) ​

bzpopmaxBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [Buffer, Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopmaxBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:780

bzpopmaxBuffer(args) ​

bzpopmaxBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [Buffer, Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopmaxBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:790

bzpopmaxBuffer(args) ​

bzpopmaxBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopmaxBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:796

bzpopmaxBuffer(args) ​

bzpopmaxBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopmaxBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:798

bzpopmin() ​

bzpopmin(args) ​

bzpopmin(...args): Promise<null | [string, string, string]>

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

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [string, string, string]>]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmin

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:805

bzpopmin(args) ​

bzpopmin(...args): Promise<null | [string, string, string]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [string, string, string]>]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmin

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:815

bzpopmin(args) ​

bzpopmin(...args): Promise<null | [string, string, string]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmin

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:825

bzpopmin(args) ​

bzpopmin(...args): Promise<null | [string, string, string]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [string, string, string]>

Inherited from ​

Redis.bzpopmin

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:827

bzpopminBuffer() ​

bzpopminBuffer(args) ​

bzpopminBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number, Callback<null | [Buffer, Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopminBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:810

bzpopminBuffer(args) ​

bzpopminBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number, Callback<null | [Buffer, Buffer, Buffer]>]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopminBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:820

bzpopminBuffer(args) ​

bzpopminBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [...keys: RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopminBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:826

bzpopminBuffer(args) ​

bzpopminBuffer(...args): Promise<null | [Buffer, Buffer, Buffer]>

Parameters ​

• ...args: [RedisKey[], string | number]

Returns ​

Promise<null | [Buffer, Buffer, Buffer]>

Inherited from ​

Redis.bzpopminBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:828

call() ​

call(command, callback) ​

call(command, callback?): Promise<unknown>

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.

redis.call('set', 'foo', 'bar');
redis.call('get', 'foo', (err, value) => {
  // value === 'bar'
});

redis.call('set', 'foo', 'bar');
redis.call('get', 'foo', (err, value) => {
  // value === 'bar'
});

Parameters ​

• command: string

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.call

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:40

call(command, args, callback) ​

call(command, args, callback?): Promise<unknown>

Parameters ​

• command: string

• args: (string | number | Buffer)[]

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.call

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:41

call(args) ​

call(...args): Promise<unknown>

Parameters ​

• ...args: [string, ...args: (string | number | Buffer)[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.call

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:42

call(args) ​

call(...args): Promise<unknown>

Parameters ​

• ...args: [string, ...args: (string | number | Buffer)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.call

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:47

callBuffer() ​

callBuffer(command, callback) ​

callBuffer(command, callback?): Promise<unknown>

Parameters ​

• command: string

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:48

callBuffer(command, args, callback) ​

callBuffer(command, args, callback?): Promise<unknown>

Parameters ​

• command: string

• args: (string | number | Buffer)[]

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:49

callBuffer(args) ​

callBuffer(...args): Promise<unknown>

Parameters ​

• ...args: [string, ...args: (string | number | Buffer)[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:50

callBuffer(args) ​

callBuffer(...args): Promise<unknown>

Parameters ​

• ...args: [string, ...args: (string | number | Buffer)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:55

client() ​

client(subcommand, yes, callback) ​

client(subcommand, yes, callback?): Promise<"OK">

Instruct the server about tracking or not keys in the next request

• group: connection
• complexity: O(1)
• since: 6.0.0

Parameters ​

• subcommand: "CACHING"

• yes: "YES"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:835

client(subcommand, no, callback) ​

client(subcommand, no, callback?): Promise<"OK">

Parameters ​

• subcommand: "CACHING"

• no: "NO"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:836

client(subcommand, callback) ​

client(subcommand, callback?): Promise<null | string>

Get the current connection name

• group: connection
• complexity: O(1)
• since: 2.6.9

Parameters ​

• subcommand: "GETNAME"

• callback?: Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:843

client(subcommand, callback) ​

client(subcommand, callback?): Promise<number>

Get tracking notifications redirection client ID if any

• group: connection
• complexity: O(1)
• since: 6.0.0

Parameters ​

• subcommand: "GETREDIR"

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:851

client(subcommand, callback) ​

client(subcommand, callback?): Promise<unknown>

Show helpful text about the different subcommands

• group: connection
• complexity: O(1)
• since: 5.0.0

Parameters ​

• subcommand: "HELP"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:858

client(subcommand, callback) ​

client(subcommand, callback?): Promise<number>

Returns the client ID for the current connection

• group: connection
• complexity: O(1)
• since: 5.0.0

Parameters ​

• subcommand: "ID"

• callback?: Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:865

client(subcommand, callback) ​

client(subcommand, callback?): Promise<string>

Returns information about the current client connection.

• group: connection
• complexity: O(1)
• since: 6.2.0

Parameters ​

• subcommand: "INFO"

• callback?: Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:872

client(args) ​

client(...args): Promise<unknown>

Kill the connection of a client

• group: connection
• complexity: O(N) where N is the number of client connections
• since: 2.4.0

Parameters ​

• ...args: ["KILL", ...args: RedisValue[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:880

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["KILL", ...args: RedisValue[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:885

client(subcommand, callback) ​

client(subcommand, callback?): Promise<unknown>

Get the list of client connections

• group: connection
• complexity: O(N) where N is the number of client connections
• since: 2.4.0

Parameters ​

• subcommand: "LIST"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:892

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "ID", ...clientIds: (string | number)[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:893

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "ID", ...clientIds: (string | number)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:899

client(subcommand, type, normal, callback) ​

client(subcommand, type, normal, callback?): Promise<unknown>

Parameters ​

• subcommand: "LIST"

• type: "TYPE"

• normal: "NORMAL"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:904

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "NORMAL", "ID", ...clientIds: (string | number)[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:905

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "NORMAL", "ID", ...clientIds: (string | number)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:913

client(subcommand, type, master, callback) ​

client(subcommand, type, master, callback?): Promise<unknown>

Parameters ​

• subcommand: "LIST"

• type: "TYPE"

• master: "MASTER"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:920

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "MASTER", "ID", ...clientIds: (string | number)[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:921

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "MASTER", "ID", ...clientIds: (string | number)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:929

client(subcommand, type, replica, callback) ​

client(subcommand, type, replica, callback?): Promise<unknown>

Parameters ​

• subcommand: "LIST"

• type: "TYPE"

• replica: "REPLICA"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:936

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "REPLICA", "ID", ...clientIds: (string | number)[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:937

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "REPLICA", "ID", ...clientIds: (string | number)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:945

client(subcommand, type, pubsub, callback) ​

client(subcommand, type, pubsub, callback?): Promise<unknown>

Parameters ​

• subcommand: "LIST"

• type: "TYPE"

• pubsub: "PUBSUB"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:952

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "PUBSUB", "ID", ...clientIds: (string | number)[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:953

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["LIST", "TYPE", "PUBSUB", "ID", ...clientIds: (string | number)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:961

client(subcommand, on, callback) ​

client(subcommand, on, callback?): Promise<unknown>

Set client eviction mode for the current connection

• group: connection
• complexity: O(1)
• since: 7.0.0

Parameters ​

• subcommand: "NO-EVICT"

• on: "ON"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:974

client(subcommand, off, callback) ​

client(subcommand, off, callback?): Promise<unknown>

Parameters ​

• subcommand: "NO-EVICT"

• off: "OFF"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:975

client(subcommand, timeout, callback) ​

client(subcommand, timeout, callback?): Promise<"OK">

Stop processing commands from clients for some time

• group: connection
• complexity: O(1)
• since: 2.9.50

Parameters ​

• subcommand: "PAUSE"

• timeout: string | number

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:982

client(subcommand, timeout, write, callback) ​

client(subcommand, timeout, write, callback?): Promise<"OK">

Parameters ​

• subcommand: "PAUSE"

• timeout: string | number

• write: "WRITE"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:983

client(subcommand, timeout, all, callback) ​

client(subcommand, timeout, all, callback?): Promise<"OK">

Parameters ​

• subcommand: "PAUSE"

• timeout: string | number

• all: "ALL"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:984

client(subcommand, on, callback) ​

client(subcommand, on, callback?): Promise<unknown>

Instruct the server whether to reply to commands

• group: connection
• complexity: O(1)
• since: 3.2.0

Parameters ​

• subcommand: "REPLY"

• on: "ON"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:991

client(subcommand, off, callback) ​

client(subcommand, off, callback?): Promise<unknown>

Parameters ​

• subcommand: "REPLY"

• off: "OFF"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:992

client(subcommand, skip, callback) ​

client(subcommand, skip, callback?): Promise<unknown>

Parameters ​

• subcommand: "REPLY"

• skip: "SKIP"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:993

client(subcommand, connectionName, callback) ​

client(subcommand, connectionName, callback?): Promise<"OK">

Set the current connection name

• group: connection
• complexity: O(1)
• since: 2.6.9

Parameters ​

• subcommand: "SETNAME"

• connectionName: string | Buffer

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1000

client(args) ​

client(...args): Promise<unknown>

Enable or disable server assisted client side caching support

• group: connection
• complexity: O(1). Some options may introduce additional complexity.
• since: 6.0.0

Parameters ​

• ...args: ["TRACKING", ...args: RedisValue[], Callback<unknown>]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1007

client(args) ​

client(...args): Promise<unknown>

Parameters ​

• ...args: ["TRACKING", ...args: RedisValue[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1012

client(subcommand, callback) ​

client(subcommand, callback?): Promise<string>

Return information about server assisted client side caching for the current connection

• group: connection
• complexity: O(1)
• since: 6.2.0

Parameters ​

• subcommand: "TRACKINGINFO"

• callback?: Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1019

client(subcommand, clientId, callback) ​

client(subcommand, clientId, callback?): Promise<unknown>

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

Parameters ​

• subcommand: "UNBLOCK"

• clientId: string | number

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1027

client(subcommand, clientId, timeout, callback) ​

client(subcommand, clientId, timeout, callback?): Promise<unknown>

Parameters ​

• subcommand: "UNBLOCK"

• clientId: string | number

• timeout: "TIMEOUT"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1028

client(subcommand, clientId, error, callback) ​

client(subcommand, clientId, error, callback?): Promise<unknown>

Parameters ​

• subcommand: "UNBLOCK"

• clientId: string | number

• error: "ERROR"

• callback?: Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1029

client(subcommand, callback) ​

client(subcommand, callback?): Promise<"OK">

Resume processing of clients that were paused

• group: connection
• complexity: O(N) Where N is the number of paused clients
• since: 6.2.0

Parameters ​

• subcommand: "UNPAUSE"

• callback?: Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1036

clientBuffer() ​

clientBuffer(subcommand, callback) ​

clientBuffer(subcommand, callback?): Promise<null | Buffer>

Parameters ​

• subcommand: "GETNAME"

• callback?: Callback<null | Buffer>

Returns ​

Promise<null | Buffer>

Inherited from ​

Redis.clientBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:844

clientBuffer(subcommand, callback) ​

clientBuffer(subcommand, callback?): Promise<Buffer>

Parameters ​

• subcommand: "INFO"

• callback?: Callback<Buffer>

Returns ​

Promise<Buffer>

Inherited from ​

Redis.clientBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:873

clientBuffer(subcommand, callback) ​

clientBuffer(subcommand, callback?): Promise<Buffer>

Parameters ​

• subcommand: "TRACKINGINFO"

• callback?: Callback<Buffer>

Returns ​

Promise<Buffer>

Inherited from ​

Redis.clientBuffer

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1020

cluster() ​

cluster(args) ​

cluster(...args): Promise<[number, number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>

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

Parameters ​

• ...args: ["ADDSLOTS", ...slots: (string | number)[], Callback<[number, number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]

Returns ​

Promise<[number, number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>

Inherited from ​

Redis.cluster

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1043

cluster(args) ​

cluster(...args): Promise<[number, number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>

Parameters ​

• ...args: ["ADDSLOTS", (string | number)[], Callback<[number, number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>]

Returns ​

Promise<[number, number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>

Inherited from ​

Redis.cluster

Source ​

node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1061

cluster(args) ​

cluster(...args): Promise<[number, number, ...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]][]>