Directus / @directus/memory / index / ExtendedRedis

Interface: ExtendedRedis ​

Defined in: packages/memory/src/kv/types/config.ts:3

Extends ​

• Redis

Properties ​

options ​

options: RedisOptions

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/Redis.d.ts:42

Inherited from ​

Redis.options

status ​

status: RedisStatus

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/Redis.d.ts:43

Inherited from ​

Redis.status

Accessors ​

autoPipelineQueueSize ​

Get Signature ​

get autoPipelineQueueSize(): number

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/Redis.d.ts:77

Returns ​

number

Inherited from ​

Redis.autoPipelineQueueSize

mode ​

Get Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/Redis.d.ts:117

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"

Inherited from ​

Redis.mode

Methods ​

[captureRejectionSymbol]()? ​

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

Defined in: node_modules/.pnpm/@types+node@22.13.8/node_modules/@types/node/events.d.ts:136

Type Parameters ​

• K

Parameters ​

error ​

Error

event ​

string | symbol

args ​

...AnyRest

Returns ​

void

Inherited from ​

Redis.[captureRejectionSymbol]

acl() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:62

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:63

Parameters ​

subcommand ​

"CAT"

categoryname ​

string | Buffer<ArrayBufferLike>

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:70

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<ArrayBufferLike>)[], Callback<number>]

Returns ​

Promise<number>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:75

Parameters ​

args ​

...["DELUSER", ...usernames: (string | Buffer<ArrayBufferLike>)[]]

Returns ​

Promise<number>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:82

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<ArrayBufferLike>

command ​

string | Buffer<ArrayBufferLike>

callback? ​

Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:84

Parameters ​

args ​

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

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:98

Parameters ​

args ​

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

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:116

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:118

Parameters ​

subcommand ​

"GENPASS"

bits ​

string | number

callback? ​

Callback<string>

Returns ​

Promise<string>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:126

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<ArrayBufferLike>

callback? ​

Callback<null | string[]>

Returns ​

Promise<null | string[]>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:134

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:141

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:149

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:156

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:157

Parameters ​

subcommand ​

"LOG"

count ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:158

Parameters ​

subcommand ​

"LOG"

reset ​

"RESET"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:165

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:172

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<ArrayBufferLike>

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:173

Parameters ​

args ​

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

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:179

Parameters ​

args ​

...["SETUSER", string | Buffer<ArrayBufferLike>, ...rules: (string | Buffer<ArrayBufferLike>)[]]

Returns ​

Promise<"OK">

Inherited from ​

Redis.acl

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:190

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:198

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

aclBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:83

Parameters ​

subcommand ​

"DRYRUN"

username ​

string | Buffer<ArrayBufferLike>

command ​

string | Buffer<ArrayBufferLike>

callback? ​

Callback<Buffer<ArrayBufferLike>>

Returns ​

Promise<Buffer<ArrayBufferLike>>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:91

Parameters ​

args ​

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

Returns ​

Promise<Buffer<ArrayBufferLike>>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:104

Parameters ​

args ​

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

Returns ​

Promise<Buffer<ArrayBufferLike>>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:117

Parameters ​

subcommand ​

"GENPASS"

callback? ​

Callback<Buffer<ArrayBufferLike>>

Returns ​

Promise<Buffer<ArrayBufferLike>>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:119

Parameters ​

subcommand ​

"GENPASS"

bits ​

string | number

callback? ​

Callback<Buffer<ArrayBufferLike>>

Returns ​

Promise<Buffer<ArrayBufferLike>>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:127

Parameters ​

subcommand ​

"GETUSER"

username ​

string | Buffer<ArrayBufferLike>

callback? ​

Callback<null | Buffer<ArrayBufferLike>[]>

Returns ​

Promise<null | Buffer<ArrayBufferLike>[]>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:142

Parameters ​

subcommand ​

"LIST"

callback? ​

Callback<Buffer<ArrayBufferLike>[]>

Returns ​

Promise<Buffer<ArrayBufferLike>[]>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:191

Parameters ​

subcommand ​

"USERS"

callback? ​

Callback<Buffer<ArrayBufferLike>[]>

Returns ​

Promise<Buffer<ArrayBufferLike>[]>

Inherited from ​

Redis.aclBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:199

Parameters ​

subcommand ​

"WHOAMI"

callback? ​

Callback<Buffer<ArrayBufferLike>>

Returns ​

Promise<Buffer<ArrayBufferLike>>

Inherited from ​

Redis.aclBuffer

addBuiltinCommand() ​

addBuiltinCommand(commandName): void

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/Commander.d.ts:34

Create add builtin command

Parameters ​

commandName ​

string

Returns ​

void

Inherited from ​

Redis.addBuiltinCommand

addListener() ​

addListener<K>(eventName, listener): this

Defined in: node_modules/.pnpm/@types+node@22.13.8/node_modules/@types/node/events.d.ts:597

Alias for emitter.on(eventName, listener).

Type Parameters ​

• K

Parameters ​

eventName ​

string | symbol

listener ​

(...args) => void

Returns ​

this

Since ​

v0.1.26

Inherited from ​

Redis.addListener

append() ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:206

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<ArrayBufferLike>

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.append

asking() ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:213

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

auth() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:220

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<ArrayBufferLike>

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.auth

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:221

Parameters ​

username ​

string | Buffer<ArrayBufferLike>

password ​

string | Buffer<ArrayBufferLike>

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.auth

bgrewriteaof() ​

bgrewriteaof(callback?): Promise<string>

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:228

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

bgrewriteaofBuffer() ​

bgrewriteaofBuffer(callback?): Promise<Buffer<ArrayBufferLike>>

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:229

Parameters ​

callback? ​

Callback<Buffer<ArrayBufferLike>>

Returns ​

Promise<Buffer<ArrayBufferLike>>

Inherited from ​

Redis.bgrewriteaofBuffer

bgsave() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:236

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:237

Parameters ​

schedule ​

"SCHEDULE"

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.bgsave

bitcount() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:244

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:245

Parameters ​

key ​

RedisKey

start ​

string | number

end ​

string | number

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitcount

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:246

Parameters ​

key ​

RedisKey

start ​

string | number

end ​

string | number

byte ​

"BYTE"

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitcount

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:247

Parameters ​

key ​

RedisKey

start ​

string | number

end ​

string | number

bit ​

"BIT"

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitcount

bitfield() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:254

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<ArrayBufferLike>

offset ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:255

Parameters ​

key ​

RedisKey

encodingOffsetValueToken ​

"SET"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

value ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:256

Parameters ​

key ​

RedisKey

encodingOffsetIncrementToken ​

"INCRBY"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

increment ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:257

Parameters ​

key ​

RedisKey

overflow ​

"OVERFLOW"

wrap ​

"WRAP"

encodingOffsetValueToken ​

"SET"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

value ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:258

Parameters ​

key ​

RedisKey

overflow ​

"OVERFLOW"

wrap ​

"WRAP"

encodingOffsetIncrementToken ​

"INCRBY"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

increment ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:259

Parameters ​

key ​

RedisKey

overflow ​

"OVERFLOW"

sat ​

"SAT"

encodingOffsetValueToken ​

"SET"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

value ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:260

Parameters ​

key ​

RedisKey

overflow ​

"OVERFLOW"

sat ​

"SAT"

encodingOffsetIncrementToken ​

"INCRBY"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

increment ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:261

Parameters ​

key ​

RedisKey

overflow ​

"OVERFLOW"

fail ​

"FAIL"

encodingOffsetValueToken ​

"SET"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

value ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:262

Parameters ​

key ​

RedisKey

overflow ​

"OVERFLOW"

fail ​

"FAIL"

encodingOffsetIncrementToken ​

"INCRBY"

encoding ​

string | Buffer<ArrayBufferLike>

offset ​

string | number

increment ​

string | number

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.bitfield

bitfield_ro() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:269

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<ArrayBufferLike>)[], Callback<unknown[]>]

Returns ​

Promise<unknown[]>

Inherited from ​

Redis.bitfield_ro

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:275

Parameters ​

args ​

...[RedisKey, "GET", ...encodingOffsets: (string | number | Buffer<ArrayBufferLike>)[]]

Returns ​

Promise<unknown[]>

Inherited from ​

Redis.bitfield_ro

bitop() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:286

Perform bitwise operations between strings

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

Parameters ​

args ​

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

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:292

Parameters ​

args ​

...[string | Buffer<ArrayBufferLike>, RedisKey, RedisKey[], Callback<number>]

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:298

Parameters ​

args ​

...[string | Buffer<ArrayBufferLike>, RedisKey, ...keys: RedisKey[]]

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:303

Parameters ​

args ​

...[string | Buffer<ArrayBufferLike>, RedisKey, RedisKey[]]

Returns ​

Promise<number>

Inherited from ​

Redis.bitop

bitpos() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:310

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:311

Parameters ​

key ​

RedisKey

bit ​

string | number

start ​

string | number

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:312

Parameters ​

key ​

RedisKey

bit ​

string | number

start ​

string | number

end ​

string | number

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:313

Parameters ​

key ​

RedisKey

bit ​

string | number

start ​

string | number

end ​

string | number

byte ​

"BYTE"

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:314

Parameters ​

key ​

RedisKey

bit ​

string | number

start ​

string | number

end ​

string | number

bit1 ​

"BIT"

callback? ​

Callback<number>

Returns ​

Promise<number>

Inherited from ​

Redis.bitpos

blmove() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:321

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:323

Parameters ​

source ​

RedisKey

destination ​

RedisKey

left ​

"LEFT"

right ​

"RIGHT"

timeout ​

string | number

callback? ​

Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.blmove

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:325

Parameters ​

source ​

RedisKey

destination ​

RedisKey

right ​

"RIGHT"

left ​

"LEFT"

timeout ​

string | number

callback? ​

Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.blmove

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:327

Parameters ​

source ​

RedisKey

destination ​

RedisKey

right ​

"RIGHT"

right1 ​

"RIGHT"

timeout ​

string | number

callback? ​

Callback<null | string>

Returns ​

Promise<null | string>

Inherited from ​

Redis.blmove

blmoveBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:322

Parameters ​

source ​

RedisKey

destination ​

RedisKey

left ​

"LEFT"

left1 ​

"LEFT"

timeout ​

string | number

callback? ​

Callback<null | Buffer<ArrayBufferLike>>

Returns ​

Promise<null | Buffer<ArrayBufferLike>>

Inherited from ​

Redis.blmoveBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:324

Parameters ​

source ​

RedisKey

destination ​

RedisKey

left ​

"LEFT"

right ​

"RIGHT"

timeout ​

string | number

callback? ​

Callback<null | Buffer<ArrayBufferLike>>

Returns ​

Promise<null | Buffer<ArrayBufferLike>>

Inherited from ​

Redis.blmoveBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:326

Parameters ​

source ​

RedisKey

destination ​

RedisKey

right ​

"RIGHT"

left ​

"LEFT"

timeout ​

string | number

callback? ​

Callback<null | Buffer<ArrayBufferLike>>

Returns ​

Promise<null | Buffer<ArrayBufferLike>>

Inherited from ​

Redis.blmoveBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:328

Parameters ​

source ​

RedisKey

destination ​

RedisKey

right ​

"RIGHT"

right1 ​

"RIGHT"

timeout ​

string | number

callback? ​

Callback<null | Buffer<ArrayBufferLike>>

Returns ​

Promise<null | Buffer<ArrayBufferLike>>

Inherited from ​

Redis.blmoveBuffer

blmpop() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:335

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:349

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:363

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:375

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "LEFT"]

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:387

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:405

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:423

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:439

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "LEFT", "COUNT", string | number]

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:455

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:469

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:483

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:495

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "RIGHT"]

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:507

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:525

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:543

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:559

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "RIGHT", "COUNT", string | number]

Returns ​

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

Inherited from ​

Redis.blmpop

blmpopBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:342

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:356

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "LEFT", Callback<null | [Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>[]]>]

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:369

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:381

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "LEFT"]

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:396

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:414

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:431

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:447

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "LEFT", "COUNT", string | number]

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:462

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:476

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "RIGHT", Callback<null | [Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>[]]>]

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:489

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:501

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "RIGHT"]

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:516

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:534

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:551

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:567

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "RIGHT", "COUNT", string | number]

Returns ​

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

Inherited from ​

Redis.blmpopBuffer

blpop() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:581

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:591

Parameters ​

args ​

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

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.blpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:601

Parameters ​

args ​

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

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.blpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:603

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.blpop

blpopBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:586

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:596

Parameters ​

args ​

...[RedisKey[], string | number, Callback<null | [Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>]>]

Returns ​

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

Inherited from ​

Redis.blpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:602

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.blpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:604

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

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

Inherited from ​

Redis.blpopBuffer

brpop() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:611

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:621

Parameters ​

args ​

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

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.brpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:631

Parameters ​

args ​

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

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.brpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:633

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

Promise<null | [string, string]>

Inherited from ​

Redis.brpop

brpopBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:616

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.brpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:626

Parameters ​

args ​

...[RedisKey[], string | number, Callback<null | [Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>]>]

Returns ​

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

Inherited from ​

Redis.brpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:632

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.brpopBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:634

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

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

Inherited from ​

Redis.brpopBuffer

brpoplpush() ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:641

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

brpoplpushBuffer() ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:642

Parameters ​

source ​

RedisKey

destination ​

RedisKey

timeout ​

string | number

callback? ​

Callback<null | Buffer<ArrayBufferLike>>

Returns ​

Promise<null | Buffer<ArrayBufferLike>>

Inherited from ​

Redis.brpoplpushBuffer

bzmpop() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:649

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:656

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:663

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:669

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "MIN"]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:675

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:684

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:693

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:701

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "MIN", "COUNT", string | number]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:709

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:716

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:723

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:729

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "MAX"]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:735

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:744

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:753

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:761

Parameters ​

args ​

...[string | number, string | number, RedisKey[], "MAX", "COUNT", string | number]

Returns ​

Promise<unknown>

Inherited from ​

Redis.bzmpop

bzpopmax() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:775

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:785

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopmax

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:795

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopmax

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:797

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

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

Inherited from ​

Redis.bzpopmax

bzpopmaxBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:780

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopmaxBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:790

Parameters ​

args ​

...[RedisKey[], string | number, Callback<null | [Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>]>]

Returns ​

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

Inherited from ​

Redis.bzpopmaxBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:796

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopmaxBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:798

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

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

Inherited from ​

Redis.bzpopmaxBuffer

bzpopmin() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:805

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:815

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopmin

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:825

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopmin

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:827

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

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

Inherited from ​

Redis.bzpopmin

bzpopminBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:810

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopminBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:820

Parameters ​

args ​

...[RedisKey[], string | number, Callback<null | [Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>, Buffer<ArrayBufferLike>]>]

Returns ​

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

Inherited from ​

Redis.bzpopminBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:826

Parameters ​

args ​

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

Returns ​

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

Inherited from ​

Redis.bzpopminBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:828

Parameters ​

args ​

...[RedisKey[], string | number]

Returns ​

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

Inherited from ​

Redis.bzpopminBuffer

call() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:40

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:41

Parameters ​

command ​

string

args ​

(string | number | Buffer<ArrayBufferLike>)[]

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.call

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:42

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.call

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:47

Parameters ​

args ​

...[string, ...args: (string | number | Buffer<ArrayBufferLike>)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.call

callBuffer() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:48

Parameters ​

command ​

string

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:49

Parameters ​

command ​

string

args ​

(string | number | Buffer<ArrayBufferLike>)[]

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:50

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:55

Parameters ​

args ​

...[string, ...args: (string | number | Buffer<ArrayBufferLike>)[]]

Returns ​

Promise<unknown>

Inherited from ​

Redis.callBuffer

client() ​

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:835

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:836

Parameters ​

subcommand ​

"CACHING"

no ​

"NO"

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:843

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:851

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:858

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:865

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:872

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:880

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:885

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:892

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:893

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:899

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:904

Parameters ​

subcommand ​

"LIST"

type ​

"TYPE"

normal ​

"NORMAL"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:905

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:913

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:920

Parameters ​

subcommand ​

"LIST"

type ​

"TYPE"

master ​

"MASTER"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:921

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:929

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:936

Parameters ​

subcommand ​

"LIST"

type ​

"TYPE"

replica ​

"REPLICA"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:937

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:945

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:952

Parameters ​

subcommand ​

"LIST"

type ​

"TYPE"

pubsub ​

"PUBSUB"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:953

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:961

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:974

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:975

Parameters ​

subcommand ​

"NO-EVICT"

off ​

"OFF"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:982

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:983

Parameters ​

subcommand ​

"PAUSE"

timeout ​

string | number

write ​

"WRITE"

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:984

Parameters ​

subcommand ​

"PAUSE"

timeout ​

string | number

all ​

"ALL"

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:991

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:992

Parameters ​

subcommand ​

"REPLY"

off ​

"OFF"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:993

Parameters ​

subcommand ​

"REPLY"

skip ​

"SKIP"

callback? ​

Callback<unknown>

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:1000

Set the current connection name

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

Parameters ​

subcommand ​

"SETNAME"

connectionName ​

string | Buffer<ArrayBufferLike>

callback? ​

Callback<"OK">

Returns ​

Promise<"OK">

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:1007

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:1012

Parameters ​

args ​

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

Returns ​

Promise<unknown>

Inherited from ​

Redis.client

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:1019

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:1027

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

Call Signature ​

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

Defined in: node_modules/.pnpm/ioredis@5.5.0/node_modules/ioredis/built/utils/RedisCommander.d.ts:1028

Parameters ​

subcommand ​

"UNBLOCK"

clientId ​

string | number

timeout ​

"TIMEOUT"

callback? ​

Callback<unknown>