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[]][]
][]>
Parameters
• ...args: ["ADDSLOTS"
, ...slots: (string | number)[]
]
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:1079
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Parameters
• ...args: ["ADDSLOTS"
, (string
| number
)[]]
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:1084
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 the slots between the start slot and end slot arguments.
- since: 7.0.0
Parameters
• ...args: ["ADDSLOTSRANGE"
, ...startSlotEndSlots: (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:1095
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Parameters
• ...args: ["ADDSLOTSRANGE"
, ...startSlotEndSlots: (string | number)[]
]
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:1113
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<"BUMPED"
|"STILL"
>
Advance the cluster config epoch
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "BUMPEPOCH"
• callback?: Callback
<"BUMPED"
| "STILL"
>
Returns
Promise
<"BUMPED"
| "STILL"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1127
cluster(subcommand, nodeId, callback)
cluster(
subcommand
,nodeId
,callback
?):Promise
<number
>
Return the number of failure reports active for a given node
- group: cluster
- complexity: O(N) where N is the number of failure reports
- since: 3.0.0
Parameters
• subcommand: "COUNT-FAILURE-REPORTS"
• nodeId: string
| number
| Buffer
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1134
cluster(subcommand, slot, callback)
cluster(
subcommand
,slot
,callback
?):Promise
<number
>
Return the number of local keys in the specified hash slot
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "COUNTKEYSINSLOT"
• slot: string
| number
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1141
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Set hash slots as unbound in receiving node
- group: cluster
- complexity: O(N) where N is the total number of hash slot arguments
- since: 3.0.0
Parameters
• ...args: ["DELSLOTS"
, ...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:1148
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Parameters
• ...args: ["DELSLOTS"
, (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:1166
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Parameters
• ...args: ["DELSLOTS"
, ...slots: (string | number)[]
]
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:1184
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Parameters
• ...args: ["DELSLOTS"
, (string
| number
)[]]
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:1189
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Set hash slots as unbound in receiving node
- group: cluster
- complexity: O(N) where N is the total number of the slots between the start slot and end slot arguments.
- since: 7.0.0
Parameters
• ...args: ["DELSLOTSRANGE"
, ...startSlotEndSlots: (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:1200
cluster(args)
cluster(...
args
):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Parameters
• ...args: ["DELSLOTSRANGE"
, ...startSlotEndSlots: (string | number)[]
]
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:1218
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<"OK"
>
Forces a replica to perform a manual failover of its master.
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "FAILOVER"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1232
cluster(subcommand, force, callback)
cluster(
subcommand
,force
,callback
?):Promise
<"OK"
>
Parameters
• subcommand: "FAILOVER"
• force: "FORCE"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1233
cluster(subcommand, takeover, callback)
cluster(
subcommand
,takeover
,callback
?):Promise
<"OK"
>
Parameters
• subcommand: "FAILOVER"
• takeover: "TAKEOVER"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1234
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Delete a node's own slots information
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "FLUSHSLOTS"
• callback?: 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:1241
cluster(subcommand, nodeId, callback)
cluster(
subcommand
,nodeId
,callback
?):Promise
<"OK"
>
Remove a node from the nodes table
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "FORGET"
• nodeId: string
| number
| Buffer
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1261
cluster(subcommand, slot, count, callback)
cluster(
subcommand
,slot
,count
,callback
?):Promise
<string
[]>
Return local key names in the specified hash slot
- group: cluster
- complexity: O(log(N)) where N is the number of requested keys
- since: 3.0.0
Parameters
• subcommand: "GETKEYSINSLOT"
• slot: string
| number
• count: string
| number
• callback?: Callback
<string
[]>
Returns
Promise
<string
[]>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1268
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<unknown
>
Show helpful text about the different subcommands
- group: cluster
- complexity: O(1)
- since: 5.0.0
Parameters
• subcommand: "HELP"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1275
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<string
>
Provides info about Redis Cluster node state
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "INFO"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1282
cluster(subcommand, key, callback)
cluster(
subcommand
,key
,callback
?):Promise
<number
>
Returns the hash slot of the specified key
- group: cluster
- complexity: O(N) where N is the number of bytes in the key
- since: 3.0.0
Parameters
• subcommand: "KEYSLOT"
• key: string
| Buffer
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1289
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<unknown
[]>
Returns a list of all TCP links to and from peer nodes in cluster
- group: cluster
- complexity: O(N) where N is the total number of Cluster nodes
- since: 7.0.0
Parameters
• subcommand: "LINKS"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1296
cluster(subcommand, ip, port, callback)
cluster(
subcommand
,ip
,port
,callback
?):Promise
<"OK"
>
Force a node cluster to handshake with another node
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "MEET"
• ip: string
| Buffer
• port: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1303
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<string
>
Return the node id
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "MYID"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1310
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<unknown
>
Get Cluster config for the node
- group: cluster
- complexity: O(N) where N is the total number of Cluster nodes
- since: 3.0.0
Parameters
• subcommand: "NODES"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1317
cluster(subcommand, nodeId, callback)
cluster(
subcommand
,nodeId
,callback
?):Promise
<unknown
>
List replica nodes of the specified master node
- group: cluster
- complexity: O(1)
- since: 5.0.0
Parameters
• subcommand: "REPLICAS"
• nodeId: string
| number
| Buffer
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1324
cluster(subcommand, nodeId, callback)
cluster(
subcommand
,nodeId
,callback
?):Promise
<"OK"
>
Reconfigure a node as a replica of the specified master node
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "REPLICATE"
• nodeId: string
| number
| Buffer
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1331
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<"OK"
>
Reset a Redis Cluster node
- group: cluster
- complexity: O(N) where N is the number of known nodes. The command may execute a FLUSHALL as a side effect.
- since: 3.0.0
Parameters
• subcommand: "RESET"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1338
cluster(subcommand, hard, callback)
cluster(
subcommand
,hard
,callback
?):Promise
<"OK"
>
Parameters
• subcommand: "RESET"
• hard: "HARD"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1339
cluster(subcommand, soft, callback)
cluster(
subcommand
,soft
,callback
?):Promise
<"OK"
>
Parameters
• subcommand: "RESET"
• soft: "SOFT"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1340
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<"OK"
>
Forces the node to save cluster state on disk
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "SAVECONFIG"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1347
cluster(subcommand, configEpoch, callback)
cluster(
subcommand
,configEpoch
,callback
?):Promise
<"OK"
>
Set the configuration epoch in a new node
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "SET-CONFIG-EPOCH"
• configEpoch: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1354
cluster(subcommand, slot, nodeIdToken, nodeId, callback)
cluster(
subcommand
,slot
,nodeIdToken
,nodeId
,callback
?):Promise
<"OK"
>
Bind a hash slot to a specific node
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "SETSLOT"
• slot: string
| number
• nodeIdToken: "IMPORTING"
• nodeId: string
| number
| Buffer
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1361
cluster(subcommand, slot, nodeIdToken, nodeId, callback)
cluster(
subcommand
,slot
,nodeIdToken
,nodeId
,callback
?):Promise
<"OK"
>
Parameters
• subcommand: "SETSLOT"
• slot: string
| number
• nodeIdToken: "MIGRATING"
• nodeId: string
| number
| Buffer
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1362
cluster(subcommand, slot, nodeIdToken, nodeId, callback)
cluster(
subcommand
,slot
,nodeIdToken
,nodeId
,callback
?):Promise
<"OK"
>
Parameters
• subcommand: "SETSLOT"
• slot: string
| number
• nodeIdToken: "NODE"
• nodeId: string
| number
| Buffer
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1363
cluster(subcommand, slot, stable, callback)
cluster(
subcommand
,slot
,stable
,callback
?):Promise
<"OK"
>
Parameters
• subcommand: "SETSLOT"
• slot: string
| number
• stable: "STABLE"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1364
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<unknown
>
Get array of cluster slots to node mappings
- group: cluster
- complexity: O(N) where N is the total number of cluster nodes
- since: 7.0.0
Parameters
• subcommand: "SHARDS"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1371
cluster(subcommand, nodeId, callback)
cluster(
subcommand
,nodeId
,callback
?):Promise
<unknown
>
List replica nodes of the specified master node
- group: cluster
- complexity: O(1)
- since: 3.0.0
Parameters
• subcommand: "SLAVES"
• nodeId: string
| number
| Buffer
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.cluster
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1378
cluster(subcommand, callback)
cluster(
subcommand
,callback
?):Promise
<[number
,number
,...nodes: [host: string, port: number, nodeId: string, info: unknown[]][]
][]>
Get array of Cluster slot to node mappings
- group: cluster
- complexity: O(N) where N is the total number of Cluster nodes
- since: 3.0.0
Parameters
• subcommand: "SLOTS"
• callback?: 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:1385
command()
command(subcommand, callback)
command(
subcommand
,callback
?):Promise
<unknown
[]>
Get total number of Redis commands
- group: server
- complexity: O(1)
- since: 2.8.13
Parameters
• subcommand: "COUNT"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1405
command(subcommand, callback)
command(
subcommand
,callback
?):Promise
<unknown
[]>
Get array of specific Redis command documentation
- group: server
- complexity: O(N) where N is the number of commands to look up
- since: 7.0.0
Parameters
• subcommand: "DOCS"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1412
command(args)
command(...
args
):Promise
<unknown
[]>
Parameters
• ...args: ["DOCS"
, ...commandNames: (string | Buffer)[]
, Callback
<unknown
[]>]
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1413
command(args)
command(...
args
):Promise
<unknown
[]>
Parameters
• ...args: ["DOCS"
, ...commandNames: (string | Buffer)[]
]
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1418
command(subcommand, callback)
command(
subcommand
,callback
?):Promise
<unknown
[]>
Extract keys given a full Redis command
- group: server
- complexity: O(N) where N is the number of arguments to the command
- since: 2.8.13
Parameters
• subcommand: "GETKEYS"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1425
command(subcommand, callback)
command(
subcommand
,callback
?):Promise
<unknown
[]>
Extract keys and access flags given a full Redis command
- group: server
- complexity: O(N) where N is the number of arguments to the command
- since: 7.0.0
Parameters
• subcommand: "GETKEYSANDFLAGS"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1432
command(subcommand, callback)
command(
subcommand
,callback
?):Promise
<unknown
[]>
Show helpful text about the different subcommands
- group: server
- complexity: O(1)
- since: 5.0.0
Parameters
• subcommand: "HELP"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1439
command(subcommand, callback)
command(
subcommand
,callback
?):Promise
<unknown
[]>
Get array of specific Redis command details, or all when no argument is given.
- group: server
- complexity: O(N) where N is the number of commands to look up
- since: 2.8.13
Parameters
• subcommand: "INFO"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1446
command(args)
command(...
args
):Promise
<unknown
[]>
Parameters
• ...args: ["INFO"
, ...commandNames: (string | Buffer)[]
, Callback
<unknown
[]>]
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1447
command(args)
command(...
args
):Promise
<unknown
[]>
Parameters
• ...args: ["INFO"
, ...commandNames: (string | Buffer)[]
]
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1452
command(subcommand, callback)
command(
subcommand
,callback
?):Promise
<unknown
[]>
Get an array of Redis command names
- group: server
- complexity: O(N) where N is the total number of Redis commands
- since: 7.0.0
Parameters
• subcommand: "LIST"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1459
command(subcommand, filterby, moduleNameToken, moduleName, callback)
command(
subcommand
,filterby
,moduleNameToken
,moduleName
,callback
?):Promise
<unknown
[]>
Parameters
• subcommand: "LIST"
• filterby: "FILTERBY"
• moduleNameToken: "MODULE"
• moduleName: string
| Buffer
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1460
command(subcommand, filterby, categoryToken, category, callback)
command(
subcommand
,filterby
,categoryToken
,category
,callback
?):Promise
<unknown
[]>
Parameters
• subcommand: "LIST"
• filterby: "FILTERBY"
• categoryToken: "ACLCAT"
• category: string
| Buffer
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1461
command(subcommand, filterby, patternToken, pattern, callback)
command(
subcommand
,filterby
,patternToken
,pattern
,callback
?):Promise
<unknown
[]>
Parameters
• subcommand: "LIST"
• filterby: "FILTERBY"
• patternToken: "PATTERN"
• pattern: string
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.command
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1462
config()
config(args)
config(...
args
):Promise
<unknown
>
Get the values of configuration parameters
- group: server
- complexity: O(N) when N is the number of configuration parameters provided
- since: 2.0.0
Parameters
• ...args: ["GET"
, ...parameters: (string | Buffer)[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.config
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1469
config(args)
config(...
args
):Promise
<unknown
>
Parameters
• ...args: ["GET"
, ...parameters: (string | Buffer)[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.config
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1474
config(subcommand, callback)
config(
subcommand
,callback
?):Promise
<unknown
>
Show helpful text about the different subcommands
- group: server
- complexity: O(1)
- since: 5.0.0
Parameters
• subcommand: "HELP"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.config
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1481
config(subcommand, callback)
config(
subcommand
,callback
?):Promise
<unknown
>
Reset the stats returned by INFO
- group: server
- complexity: O(1)
- since: 2.0.0
Parameters
• subcommand: "RESETSTAT"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.config
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1488
config(subcommand, callback)
config(
subcommand
,callback
?):Promise
<unknown
>
Rewrite the configuration file with the in memory configuration
- group: server
- complexity: O(1)
- since: 2.8.0
Parameters
• subcommand: "REWRITE"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.config
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1495
config(args)
config(...
args
):Promise
<unknown
>
Set configuration parameters to the given values
- group: server
- complexity: O(N) when N is the number of configuration parameters provided
- since: 2.0.0
Parameters
• ...args: ["SET"
, ...parameterValues: (string | number | Buffer)[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.config
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1502
config(args)
config(...
args
):Promise
<unknown
>
Parameters
• ...args: ["SET"
, ...parameterValues: (string | number | Buffer)[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.config
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1507
connect()
connect(
callback
?):Promise
<void
>
Create a connection to Redis. This method will be invoked automatically when creating a new Redis instance unless lazyConnect: true
is passed.
When calling this method manually, a Promise is returned, which will be resolved when the connection status is ready.
Parameters
• callback?: Callback
<void
>
Returns
Promise
<void
>
Inherited from
Redis.connect
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:86
copy()
copy(source, destination, callback)
copy(
source
,destination
,callback
?):Promise
<number
>
Copy a key
- group: generic
- complexity: O(N) worst case for collections, where N is the number of nested items. O(1) for string values.
- since: 6.2.0
Parameters
• source: RedisKey
• destination: RedisKey
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.copy
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1517
copy(source, destination, replace, callback)
copy(
source
,destination
,replace
,callback
?):Promise
<number
>
Parameters
• source: RedisKey
• destination: RedisKey
• replace: "REPLACE"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.copy
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1518
copy(source, destination, destinationDbToken, destinationDb, callback)
copy(
source
,destination
,destinationDbToken
,destinationDb
,callback
?):Promise
<number
>
Parameters
• source: RedisKey
• destination: RedisKey
• destinationDbToken: "DB"
• destinationDb: string
| number
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.copy
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1519
copy(source, destination, destinationDbToken, destinationDb, replace, callback)
copy(
source
,destination
,destinationDbToken
,destinationDb
,replace
,callback
?):Promise
<number
>
Parameters
• source: RedisKey
• destination: RedisKey
• destinationDbToken: "DB"
• destinationDb: string
| number
• replace: "REPLACE"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.copy
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1520
createBuiltinCommand()
createBuiltinCommand(
commandName
):Object
Create a builtin command
Parameters
• commandName: string
Returns
Object
buffer
buffer:
any
string
string:
any
Inherited from
Redis.createBuiltinCommand
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/Commander.d.ts:27
dbsize()
dbsize(
callback
?):Promise
<number
>
Return the number of keys in the selected database
- group: server
- complexity: O(1)
- since: 1.0.0
Parameters
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.dbsize
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1527
debug()
debug(subcommand, callback)
debug(
subcommand
,callback
?):Promise
<unknown
>
A container for debugging commands
- group: server
- complexity: Depends on subcommand.
- since: 1.0.0
Parameters
• subcommand: string
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.debug
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1534
debug(args)
debug(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
, ...args: (string | number | Buffer)[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.debug
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1535
debug(args)
debug(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
, ...args: (string | number | Buffer)[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.debug
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1540
decr()
decr(
key
,callback
?):Promise
<number
>
Decrement the integer value of a key by one
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
• key: RedisKey
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.decr
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1547
decrby()
decrby(
key
,decrement
,callback
?):Promise
<number
>
Decrement the integer value of a key by the given number
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
• key: RedisKey
• decrement: string
| number
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.decrby
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1554
defineCommand()
defineCommand(
name
,definition
):void
Define a custom command using lua script
Parameters
• name: string
• definition
• definition.lua: string
• definition.numberOfKeys?: number
• definition.readOnly?: boolean
Returns
void
Inherited from
Redis.defineCommand
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/Commander.d.ts:38
del()
del(args)
del(...
args
):Promise
<number
>
Delete a key
- group: generic
- complexity: O(N) where N is the number of keys that will be removed. When a key to remove holds a value other than a string, the individual complexity for this key is O(M) where M is the number of elements in the list, set, sorted set or hash. Removing a single key that holds a string value is O(1).
- since: 1.0.0
Parameters
• ...args: [...keys: RedisKey[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.del
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1561
del(args)
del(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
[], Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.del
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1562
del(args)
del(...
args
):Promise
<number
>
Parameters
• ...args: RedisKey
[]
Returns
Promise
<number
>
Inherited from
Redis.del
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1563
del(args)
del(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
[]]
Returns
Promise
<number
>
Inherited from
Redis.del
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1564
discard()
discard(
callback
?):Promise
<"OK"
>
Discard all commands issued after MULTI
- group: transactions
- complexity: O(N), when N is the number of queued commands
- since: 2.0.0
Parameters
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.discard
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1571
disconnect()
disconnect(
reconnect
?):void
Disconnect from Redis.
This method closes the connection immediately, and may lose some pending replies that haven't written to client. If you want to wait for the pending replies, use Redis#quit instead.
Parameters
• reconnect?: boolean
Returns
void
Inherited from
Redis.disconnect
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:94
dump()
dump(
key
,callback
?):Promise
<string
>
Return a serialized version of the value stored at the specified key.
- group: generic
- complexity: O(1) to access the key and additional O(NM) to serialize it, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1).
- since: 2.6.0
Parameters
• key: RedisKey
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.dump
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1578
dumpBuffer()
dumpBuffer(
key
,callback
?):Promise
<Buffer
>
Parameters
• key: RedisKey
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.dumpBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1579
duplicate()
duplicate(
override
?):Redis
Create a new instance with the same options as the current one.
Parameters
• override?: Partial
<RedisOptions
>
Returns
Redis
Inherited from
Redis.duplicate
Example
var redis = new Redis(6380);
var anotherRedis = redis.duplicate();
var redis = new Redis(6380);
var anotherRedis = redis.duplicate();
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:110
echo()
echo(
message
,callback
?):Promise
<string
>
Echo the given string
- group: connection
- complexity: O(1)
- since: 1.0.0
Parameters
• message: string
| Buffer
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.echo
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1586
echoBuffer()
echoBuffer(
message
,callback
?):Promise
<Buffer
>
Parameters
• message: string
| Buffer
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.echoBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1587
emit()
emit<
K
>(eventName
, ...args
):boolean
Synchronously calls each of the listeners registered for the event namedeventName
, in the order they were registered, passing the supplied arguments to each.
Returns true
if the event had listeners, false
otherwise.
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Type parameters
• K
Parameters
• eventName: string
| symbol
• ...args: AnyRest
Returns
boolean
Inherited from
Redis.emit
Since
v0.1.26
Source
node_modules/.pnpm/@types+node@18.19.50/node_modules/@types/node/events.d.ts:747
end()
end():
void
Disconnect from Redis.
Returns
void
Inherited from
Redis.end
Deprecated
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:100
eval()
eval(script, numkeys, callback)
eval(
script
,numkeys
,callback
?):Promise
<unknown
>
Execute a Lua script server side
- group: scripting
- complexity: Depends on the script that is executed.
- since: 2.6.0
Parameters
• script: string
| Buffer
• numkeys: string
| number
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1594
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: (string | number | Buffer)[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1595
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: (string | number | Buffer)[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1601
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...keys: RedisKey[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1606
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, RedisKey
[], Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1612
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...keys: RedisKey[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1618
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, RedisKey
[]]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1623
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1628
eval(args)
eval(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.eval
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1634
eval_ro()
eval_ro(args)
eval_ro(...
args
):Promise
<unknown
>
Execute a read-only Lua script server side
- group: scripting
- complexity: Depends on the script that is executed.
- since: 7.0.0
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.eval_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1645
eval_ro(args)
eval_ro(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.eval_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1651
evalsha()
evalsha(sha1, numkeys, callback)
evalsha(
sha1
,numkeys
,callback
?):Promise
<unknown
>
Execute a Lua script server side
- group: scripting
- complexity: Depends on the script that is executed.
- since: 2.6.0
Parameters
• sha1: string
| Buffer
• numkeys: string
| number
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1662
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: (string | number | Buffer)[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1663
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: (string | number | Buffer)[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1669
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...keys: RedisKey[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1674
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, RedisKey
[], Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1680
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...keys: RedisKey[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1686
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, RedisKey
[]]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1691
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1692
evalsha(args)
evalsha(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1698
evalsha_ro()
evalsha_ro(args)
evalsha_ro(...
args
):Promise
<unknown
>
Execute a read-only Lua script server side
- group: scripting
- complexity: Depends on the script that is executed.
- since: 7.0.0
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1709
evalsha_ro(args)
evalsha_ro(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.evalsha_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1715
eventNames()
eventNames(): (
string
|symbol
)[]
Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbol
s.
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
Returns
(string
| symbol
)[]
Inherited from
Redis.eventNames
Since
v6.0.0
Source
node_modules/.pnpm/@types+node@18.19.50/node_modules/@types/node/events.d.ts:810
exec()
exec(
callback
?):Promise
<null
| [null
|Error
,unknown
][]>
Execute all commands issued after MULTI
- group: transactions
- complexity: Depends on commands in the transaction
- since: 1.2.0
Parameters
• callback?: Callback
<null
| [null
| Error
, unknown
][]>
Returns
Promise
<null
| [null
| Error
, unknown
][]>
Inherited from
Redis.exec
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1726
exists()
exists(args)
exists(...
args
):Promise
<number
>
Determine if a key exists
- group: generic
- complexity: O(N) where N is the number of keys to check.
- since: 1.0.0
Parameters
• ...args: [...keys: RedisKey[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.exists
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1733
exists(args)
exists(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
[], Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.exists
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1734
exists(args)
exists(...
args
):Promise
<number
>
Parameters
• ...args: RedisKey
[]
Returns
Promise
<number
>
Inherited from
Redis.exists
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1735
exists(args)
exists(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
[]]
Returns
Promise
<number
>
Inherited from
Redis.exists
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1736
expire()
expire(key, seconds, callback)
expire(
key
,seconds
,callback
?):Promise
<number
>
Set a key's time to live in seconds
- group: generic
- complexity: O(1)
- since: 1.0.0
Parameters
• key: RedisKey
• seconds: string
| number
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expire
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1743
expire(key, seconds, nx, callback)
expire(
key
,seconds
,nx
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• seconds: string
| number
• nx: "NX"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expire
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1744
expire(key, seconds, xx, callback)
expire(
key
,seconds
,xx
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• seconds: string
| number
• xx: "XX"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expire
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1745
expire(key, seconds, gt, callback)
expire(
key
,seconds
,gt
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• seconds: string
| number
• gt: "GT"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expire
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1746
expire(key, seconds, lt, callback)
expire(
key
,seconds
,lt
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• seconds: string
| number
• lt: "LT"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expire
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1747
expireat()
expireat(key, unixTimeSeconds, callback)
expireat(
key
,unixTimeSeconds
,callback
?):Promise
<number
>
Set the expiration for a key as a UNIX timestamp
- group: generic
- complexity: O(1)
- since: 1.2.0
Parameters
• key: RedisKey
• unixTimeSeconds: string
| number
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expireat
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1754
expireat(key, unixTimeSeconds, nx, callback)
expireat(
key
,unixTimeSeconds
,nx
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• unixTimeSeconds: string
| number
• nx: "NX"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expireat
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1755
expireat(key, unixTimeSeconds, xx, callback)
expireat(
key
,unixTimeSeconds
,xx
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• unixTimeSeconds: string
| number
• xx: "XX"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expireat
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1756
expireat(key, unixTimeSeconds, gt, callback)
expireat(
key
,unixTimeSeconds
,gt
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• unixTimeSeconds: string
| number
• gt: "GT"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expireat
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1757
expireat(key, unixTimeSeconds, lt, callback)
expireat(
key
,unixTimeSeconds
,lt
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• unixTimeSeconds: string
| number
• lt: "LT"
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expireat
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1758
expiretime()
expiretime(
key
,callback
?):Promise
<number
>
Get the expiration Unix timestamp for a key
- group: generic
- complexity: O(1)
- since: 7.0.0
Parameters
• key: RedisKey
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.expiretime
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1765
failover()
failover(callback)
failover(
callback
?):Promise
<"OK"
>
Start a coordinated failover between this server and one of its replicas.
- group: server
- complexity: O(1)
- since: 6.2.0
Parameters
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1772
failover(millisecondsToken, milliseconds, callback)
failover(
millisecondsToken
,milliseconds
,callback
?):Promise
<"OK"
>
Parameters
• millisecondsToken: "TIMEOUT"
• milliseconds: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1773
failover(abort, callback)
failover(
abort
,callback
?):Promise
<"OK"
>
Parameters
• abort: "ABORT"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1774
failover(abort, millisecondsToken, milliseconds, callback)
failover(
abort
,millisecondsToken
,milliseconds
,callback
?):Promise
<"OK"
>
Parameters
• abort: "ABORT"
• millisecondsToken: "TIMEOUT"
• milliseconds: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1775
failover(targetToken, host, port, callback)
failover(
targetToken
,host
,port
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1776
failover(targetToken, host, port, millisecondsToken, milliseconds, callback)
failover(
targetToken
,host
,port
,millisecondsToken
,milliseconds
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• millisecondsToken: "TIMEOUT"
• milliseconds: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1777
failover(targetToken, host, port, abort, callback)
failover(
targetToken
,host
,port
,abort
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• abort: "ABORT"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1778
failover(targetToken, host, port, abort, millisecondsToken, milliseconds, callback)
failover(
targetToken
,host
,port
,abort
,millisecondsToken
,milliseconds
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• abort: "ABORT"
• millisecondsToken: "TIMEOUT"
• milliseconds: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1779
failover(targetToken, host, port, force, callback)
failover(
targetToken
,host
,port
,force
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• force: "FORCE"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1780
failover(targetToken, host, port, force, millisecondsToken, milliseconds, callback)
failover(
targetToken
,host
,port
,force
,millisecondsToken
,milliseconds
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• force: "FORCE"
• millisecondsToken: "TIMEOUT"
• milliseconds: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1781
failover(targetToken, host, port, force, abort, callback)
failover(
targetToken
,host
,port
,force
,abort
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• force: "FORCE"
• abort: "ABORT"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1782
failover(targetToken, host, port, force, abort, millisecondsToken, milliseconds, callback)
failover(
targetToken
,host
,port
,force
,abort
,millisecondsToken
,milliseconds
,callback
?):Promise
<"OK"
>
Parameters
• targetToken: "TO"
• host: string
| Buffer
• port: string
| number
• force: "FORCE"
• abort: "ABORT"
• millisecondsToken: "TIMEOUT"
• milliseconds: string
| number
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.failover
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1783
fcall()
fcall(args)
fcall(...
args
):Promise
<unknown
>
Invoke a function
- group: scripting
- complexity: Depends on the function that is executed.
- since: 7.0.0
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.fcall
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1790
fcall(args)
fcall(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.fcall
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1796
fcall_ro()
fcall_ro(args)
fcall_ro(...
args
):Promise
<unknown
>
Invoke a read-only function
- group: scripting
- complexity: Depends on the function that is executed.
- since: 7.0.0
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.fcall_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1807
fcall_ro(args)
fcall_ro(...
args
):Promise
<unknown
>
Parameters
• ...args: [string
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.fcall_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1813
flushall()
flushall(callback)
flushall(
callback
?):Promise
<"OK"
>
Remove all keys from all databases
- group: server
- complexity: O(N) where N is the total number of keys in all databases
- since: 1.0.0
Parameters
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.flushall
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1824
flushall(async, callback)
flushall(
async
,callback
?):Promise
<"OK"
>
Parameters
• async: "ASYNC"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.flushall
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1825
flushall(sync, callback)
flushall(
sync
,callback
?):Promise
<"OK"
>
Parameters
• sync: "SYNC"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.flushall
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1826
flushdb()
flushdb(callback)
flushdb(
callback
?):Promise
<"OK"
>
Remove all keys from the current database
- group: server
- complexity: O(N) where N is the number of keys in the selected database
- since: 1.0.0
Parameters
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.flushdb
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1833
flushdb(async, callback)
flushdb(
async
,callback
?):Promise
<"OK"
>
Parameters
• async: "ASYNC"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.flushdb
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1834
flushdb(sync, callback)
flushdb(
sync
,callback
?):Promise
<"OK"
>
Parameters
• sync: "SYNC"
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.flushdb
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1835
function()
function(subcommand, libraryName, callback)
function(
subcommand
,libraryName
,callback
?):Promise
<string
>
Delete a function by name
- group: scripting
- complexity: O(1)
- since: 7.0.0
Parameters
• subcommand: "DELETE"
• libraryName: string
| Buffer
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1842
function(subcommand, callback)
function(
subcommand
,callback
?):Promise
<string
>
Dump all functions into a serialized binary payload
- group: scripting
- complexity: O(N) where N is the number of functions
- since: 7.0.0
Parameters
• subcommand: "DUMP"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1850
function(subcommand, callback)
function(
subcommand
,callback
?):Promise
<string
>
Deleting all functions
- group: scripting
- complexity: O(N) where N is the number of functions deleted
- since: 7.0.0
Parameters
• subcommand: "FLUSH"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1858
function(subcommand, async, callback)
function(
subcommand
,async
,callback
?):Promise
<string
>
Parameters
• subcommand: "FLUSH"
• async: "ASYNC"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1860
function(subcommand, sync, callback)
function(
subcommand
,sync
,callback
?):Promise
<string
>
Parameters
• subcommand: "FLUSH"
• sync: "SYNC"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1862
function(subcommand, callback)
function(
subcommand
,callback
?):Promise
<unknown
>
Show helpful text about the different subcommands
- group: scripting
- complexity: O(1)
- since: 7.0.0
Parameters
• subcommand: "HELP"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1870
function(subcommand, callback)
function(
subcommand
,callback
?):Promise
<string
>
Kill the function currently in execution.
- group: scripting
- complexity: O(1)
- since: 7.0.0
Parameters
• subcommand: "KILL"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1877
function(subcommand, callback)
function(
subcommand
,callback
?):Promise
<unknown
[]>
List information about all the functions
- group: scripting
- complexity: O(N) where N is the number of functions
- since: 7.0.0
Parameters
• subcommand: "LIST"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1885
function(subcommand, withcode, callback)
function(
subcommand
,withcode
,callback
?):Promise
<unknown
[]>
Parameters
• subcommand: "LIST"
• withcode: "WITHCODE"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1886
function(subcommand, libraryNamePatternToken, libraryNamePattern, callback)
function(
subcommand
,libraryNamePatternToken
,libraryNamePattern
,callback
?):Promise
<unknown
[]>
Parameters
• subcommand: "LIST"
• libraryNamePatternToken: "LIBRARYNAME"
• libraryNamePattern: string
| Buffer
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1887
function(subcommand, libraryNamePatternToken, libraryNamePattern, withcode, callback)
function(
subcommand
,libraryNamePatternToken
,libraryNamePattern
,withcode
,callback
?):Promise
<unknown
[]>
Parameters
• subcommand: "LIST"
• libraryNamePatternToken: "LIBRARYNAME"
• libraryNamePattern: string
| Buffer
• withcode: "WITHCODE"
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1888
function(subcommand, functionCode, callback)
function(
subcommand
,functionCode
,callback
?):Promise
<string
>
Create a function with the given arguments (name, code, description)
- group: scripting
- complexity: O(1) (considering compilation time is redundant)
- since: 7.0.0
Parameters
• subcommand: "LOAD"
• functionCode: string
| Buffer
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1895
function(subcommand, replace, functionCode, callback)
function(
subcommand
,replace
,functionCode
,callback
?):Promise
<string
>
Parameters
• subcommand: "LOAD"
• replace: "REPLACE"
• functionCode: string
| Buffer
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1897
function(subcommand, serializedValue, callback)
function(
subcommand
,serializedValue
,callback
?):Promise
<string
>
Restore all the functions on the given payload
- group: scripting
- complexity: O(N) where N is the number of functions on the payload
- since: 7.0.0
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1905
function(subcommand, serializedValue, flush, callback)
function(
subcommand
,serializedValue
,flush
,callback
?):Promise
<string
>
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• flush: "FLUSH"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1907
function(subcommand, serializedValue, append, callback)
function(
subcommand
,serializedValue
,append
,callback
?):Promise
<string
>
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• append: "APPEND"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1909
function(subcommand, serializedValue, replace, callback)
function(
subcommand
,serializedValue
,replace
,callback
?):Promise
<string
>
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• replace: "REPLACE"
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1911
function(subcommand, callback)
function(
subcommand
,callback
?):Promise
<unknown
>
Return information about the function currently running (name, description, duration)
- group: scripting
- complexity: O(1)
- since: 7.0.0
Parameters
• subcommand: "STATS"
• callback?: Callback
<unknown
>
Returns
Promise
<unknown
>
Inherited from
Redis.function
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1919
functionBuffer()
functionBuffer(subcommand, libraryName, callback)
functionBuffer(
subcommand
,libraryName
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "DELETE"
• libraryName: string
| Buffer
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1843
functionBuffer(subcommand, callback)
functionBuffer(
subcommand
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "DUMP"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1851
functionBuffer(subcommand, callback)
functionBuffer(
subcommand
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "FLUSH"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1859
functionBuffer(subcommand, async, callback)
functionBuffer(
subcommand
,async
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "FLUSH"
• async: "ASYNC"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1861
functionBuffer(subcommand, sync, callback)
functionBuffer(
subcommand
,sync
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "FLUSH"
• sync: "SYNC"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1863
functionBuffer(subcommand, callback)
functionBuffer(
subcommand
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "KILL"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1878
functionBuffer(subcommand, functionCode, callback)
functionBuffer(
subcommand
,functionCode
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "LOAD"
• functionCode: string
| Buffer
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1896
functionBuffer(subcommand, replace, functionCode, callback)
functionBuffer(
subcommand
,replace
,functionCode
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "LOAD"
• replace: "REPLACE"
• functionCode: string
| Buffer
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1898
functionBuffer(subcommand, serializedValue, callback)
functionBuffer(
subcommand
,serializedValue
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1906
functionBuffer(subcommand, serializedValue, flush, callback)
functionBuffer(
subcommand
,serializedValue
,flush
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• flush: "FLUSH"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1908
functionBuffer(subcommand, serializedValue, append, callback)
functionBuffer(
subcommand
,serializedValue
,append
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• append: "APPEND"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1910
functionBuffer(subcommand, serializedValue, replace, callback)
functionBuffer(
subcommand
,serializedValue
,replace
,callback
?):Promise
<Buffer
>
Parameters
• subcommand: "RESTORE"
• serializedValue: string
| number
| Buffer
• replace: "REPLACE"
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.functionBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1912
geoadd()
geoadd(args)
geoadd(...
args
):Promise
<number
>
Add one or more geospatial items in the geospatial index represented using a sorted set
- group: geo
- complexity: O(log(N)) for each item added, where N is the number of elements in the sorted set.
- since: 3.2.0
Parameters
• ...args: [RedisKey
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1926
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1931
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "CH"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1935
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "CH"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1941
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "NX"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1946
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "NX"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1952
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "NX"
, "CH"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1957
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "NX"
, "CH"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1964
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "XX"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1970
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "XX"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1976
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "XX"
, "CH"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1981
geoadd(args)
geoadd(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, "XX"
, "CH"
, ...longitudeLatitudeMembers: (string | number | Buffer)[]
]
Returns
Promise
<number
>
Inherited from
Redis.geoadd
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:1988
geodist()
geodist(key, member1, member2, callback)
geodist(
key
,member1
,member2
,callback
?):Promise
<null
|string
>
Returns the distance between two members of a geospatial index
- group: geo
- complexity: O(log(N))
- since: 3.2.0
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.geodist
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2000
geodist(key, member1, member2, m, callback)
geodist(
key
,member1
,member2
,m
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• m: "M"
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.geodist
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2002
geodist(key, member1, member2, km, callback)
geodist(
key
,member1
,member2
,km
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• km: "KM"
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.geodist
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2004
geodist(key, member1, member2, ft, callback)
geodist(
key
,member1
,member2
,ft
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• ft: "FT"
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.geodist
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2006
geodist(key, member1, member2, mi, callback)
geodist(
key
,member1
,member2
,mi
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• mi: "MI"
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.geodist
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2008
geodistBuffer()
geodistBuffer(key, member1, member2, callback)
geodistBuffer(
key
,member1
,member2
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.geodistBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2001
geodistBuffer(key, member1, member2, m, callback)
geodistBuffer(
key
,member1
,member2
,m
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• m: "M"
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.geodistBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2003
geodistBuffer(key, member1, member2, km, callback)
geodistBuffer(
key
,member1
,member2
,km
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• km: "KM"
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.geodistBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2005
geodistBuffer(key, member1, member2, ft, callback)
geodistBuffer(
key
,member1
,member2
,ft
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• ft: "FT"
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.geodistBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2007
geodistBuffer(key, member1, member2, mi, callback)
geodistBuffer(
key
,member1
,member2
,mi
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• member1: string
| number
| Buffer
• member2: string
| number
| Buffer
• mi: "MI"
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.geodistBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2009
geohash()
geohash(args)
geohash(...
args
):Promise
<string
[]>
Returns members of a geospatial index as standard geohash strings
- group: geo
- complexity: O(log(N)) for each member requested, where N is the number of elements in the sorted set.
- since: 3.2.0
Parameters
• ...args: [RedisKey
, ...members: (string | number | Buffer)[]
, Callback
<string
[]>]
Returns
Promise
<string
[]>
Inherited from
Redis.geohash
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2016
geohash(args)
geohash(...
args
):Promise
<string
[]>
Parameters
• ...args: [RedisKey
, (string
| number
| Buffer
)[], Callback
<string
[]>]
Returns
Promise
<string
[]>
Inherited from
Redis.geohash
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2026
geohash(args)
geohash(...
args
):Promise
<string
[]>
Parameters
• ...args: [RedisKey
, ...members: (string | number | Buffer)[]
]
Returns
Promise
<string
[]>
Inherited from
Redis.geohash
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2036
geohash(args)
geohash(...
args
):Promise
<string
[]>
Parameters
• ...args: [RedisKey
, (string
| number
| Buffer
)[]]
Returns
Promise
<string
[]>
Inherited from
Redis.geohash
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2038
geohashBuffer()
geohashBuffer(args)
geohashBuffer(...
args
):Promise
<Buffer
[]>
Parameters
• ...args: [RedisKey
, ...members: (string | number | Buffer)[]
, Callback
<Buffer
[]>]
Returns
Promise
<Buffer
[]>
Inherited from
Redis.geohashBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2021
geohashBuffer(args)
geohashBuffer(...
args
):Promise
<Buffer
[]>
Parameters
• ...args: [RedisKey
, (string
| number
| Buffer
)[], Callback
<Buffer
[]>]
Returns
Promise
<Buffer
[]>
Inherited from
Redis.geohashBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2031
geohashBuffer(args)
geohashBuffer(...
args
):Promise
<Buffer
[]>
Parameters
• ...args: [RedisKey
, ...members: (string | number | Buffer)[]
]
Returns
Promise
<Buffer
[]>
Inherited from
Redis.geohashBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2037
geohashBuffer(args)
geohashBuffer(...
args
):Promise
<Buffer
[]>
Parameters
• ...args: [RedisKey
, (string
| number
| Buffer
)[]]
Returns
Promise
<Buffer
[]>
Inherited from
Redis.geohashBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2039
geopos()
geopos(args)
geopos(...
args
):Promise
<(null
| [string
,string
])[]>
Returns longitude and latitude of members of a geospatial index
- group: geo
- complexity: O(N) where N is the number of members requested.
- since: 3.2.0
Parameters
• ...args: [RedisKey
, ...members: (string | number | Buffer)[]
, Callback
<(null
| [string
, string
])[]>]
Returns
Promise
<(null
| [string
, string
])[]>
Inherited from
Redis.geopos
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2046
geopos(args)
geopos(...
args
):Promise
<(null
| [string
,string
])[]>
Parameters
• ...args: [RedisKey
, (string
| number
| Buffer
)[], Callback
<(null
| [string
, string
])[]>]
Returns
Promise
<(null
| [string
, string
])[]>
Inherited from
Redis.geopos
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2051
geopos(args)
geopos(...
args
):Promise
<(null
| [string
,string
])[]>
Parameters
• ...args: [RedisKey
, ...members: (string | number | Buffer)[]
]
Returns
Promise
<(null
| [string
, string
])[]>
Inherited from
Redis.geopos
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2056
geopos(args)
geopos(...
args
):Promise
<(null
| [string
,string
])[]>
Parameters
• ...args: [RedisKey
, (string
| number
| Buffer
)[]]
Returns
Promise
<(null
| [string
, string
])[]>
Inherited from
Redis.geopos
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2057
georadius()
georadius(args)
georadius(...
args
):Promise
<unknown
[]>
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a point
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.0
Parameters
• ...args: [RedisKey
, string
| number
, string
| number
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
[]>]
Returns
Promise
<unknown
[]>
Inherited from
Redis.georadius
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2064
georadius(args)
georadius(...
args
):Promise
<unknown
[]>
Parameters
• ...args: [RedisKey
, string
| number
, string
| number
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
[]>
Inherited from
Redis.georadius
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2072
georadius_ro()
georadius_ro(args)
georadius_ro(...
args
):Promise
<unknown
>
A read-only variant for GEORADIUS
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.10
Parameters
• ...args: [RedisKey
, string
| number
, string
| number
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.georadius_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2085
georadius_ro(args)
georadius_ro(...
args
):Promise
<unknown
>
Parameters
• ...args: [RedisKey
, string
| number
, string
| number
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.georadius_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2093
georadiusbymember()
georadiusbymember(args)
georadiusbymember(...
args
):Promise
<unknown
>
Query a sorted set representing a geospatial index to fetch members matching a given maximum distance from a member
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.0
Parameters
• ...args: [RedisKey
, string
| number
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.georadiusbymember
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2106
georadiusbymember(args)
georadiusbymember(...
args
):Promise
<unknown
>
Parameters
• ...args: [RedisKey
, string
| number
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.georadiusbymember
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2113
georadiusbymember_ro()
georadiusbymember_ro(args)
georadiusbymember_ro(...
args
):Promise
<unknown
>
A read-only variant for GEORADIUSBYMEMBER
- group: geo
- complexity: O(N+log(M)) where N is the number of elements inside the bounding box of the circular area delimited by center and radius and M is the number of items inside the index.
- since: 3.2.10
Parameters
• ...args: [RedisKey
, string
| number
| Buffer
, string
| number
, ...args: RedisValue[]
, Callback
<unknown
>]
Returns
Promise
<unknown
>
Inherited from
Redis.georadiusbymember_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2125
georadiusbymember_ro(args)
georadiusbymember_ro(...
args
):Promise
<unknown
>
Parameters
• ...args: [RedisKey
, string
| number
| Buffer
, string
| number
, ...args: RedisValue[]
]
Returns
Promise
<unknown
>
Inherited from
Redis.georadiusbymember_ro
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2132
geosearch()
geosearch(args)
geosearch(...
args
):Promise
<unknown
[]>
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
- since: 6.2.0
Parameters
• ...args: [RedisKey
, ...args: RedisValue[]
, Callback
<unknown
[]>]
Returns
Promise
<unknown
[]>
Inherited from
Redis.geosearch
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2144
geosearch(args)
geosearch(...
args
):Promise
<unknown
[]>
Parameters
• ...args: [RedisKey
, ...args: RedisValue[]
]
Returns
Promise
<unknown
[]>
Inherited from
Redis.geosearch
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2149
geosearchstore()
geosearchstore(args)
geosearchstore(...
args
):Promise
<number
>
Query a sorted set representing a geospatial index to fetch members inside an area of a box or a circle, and store the result in another key.
- group: geo
- complexity: O(N+log(M)) where N is the number of elements in the grid-aligned bounding box area around the shape provided as the filter and M is the number of items inside the shape
- since: 6.2.0
Parameters
• ...args: [RedisKey
, RedisKey
, ...args: RedisValue[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.geosearchstore
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2156
geosearchstore(args)
geosearchstore(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, RedisKey
, ...args: RedisValue[]
]
Returns
Promise
<number
>
Inherited from
Redis.geosearchstore
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2162
get()
get(
key
,callback
?):Promise
<null
|string
>
Get the value of a key
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
• key: RedisKey
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.get
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2169
getBuffer()
getBuffer(
key
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2170
getBuiltinCommands()
getBuiltinCommands():
string
[]
Return supported builtin commands
Returns
string
[]
Inherited from
Redis.getBuiltinCommands
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/Commander.d.ts:23
getMaxListeners()
getMaxListeners():
number
Returns the current max listener value for the EventEmitter
which is either set by emitter.setMaxListeners(n)
or defaults to defaultMaxListeners.
Returns
number
Inherited from
Redis.getMaxListeners
Since
v1.0.0
Source
node_modules/.pnpm/@types+node@18.19.50/node_modules/@types/node/events.d.ts:663
getbit()
getbit(
key
,offset
,callback
?):Promise
<number
>
Returns the bit value at offset in the string value stored at key
- group: bitmap
- complexity: O(1)
- since: 2.2.0
Parameters
• key: RedisKey
• offset: string
| number
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.getbit
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2177
getdel()
getdel(
key
,callback
?):Promise
<null
|string
>
Get the value of a key and delete the key
- group: string
- complexity: O(1)
- since: 6.2.0
Parameters
• key: RedisKey
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getdel
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2184
getdelBuffer()
getdelBuffer(
key
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getdelBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2185
getex()
getex(key, callback)
getex(
key
,callback
?):Promise
<null
|string
>
Get the value of a key and optionally set its expiration
- group: string
- complexity: O(1)
- since: 6.2.0
Parameters
• key: RedisKey
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getex
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2192
getex(key, secondsToken, seconds, callback)
getex(
key
,secondsToken
,seconds
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• secondsToken: "EX"
• seconds: string
| number
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getex
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2194
getex(key, millisecondsToken, milliseconds, callback)
getex(
key
,millisecondsToken
,milliseconds
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• millisecondsToken: "PX"
• milliseconds: string
| number
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getex
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2196
getex(key, unixTimeSecondsToken, unixTimeSeconds, callback)
getex(
key
,unixTimeSecondsToken
,unixTimeSeconds
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• unixTimeSecondsToken: "EXAT"
• unixTimeSeconds: string
| number
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getex
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2198
getex(key, unixTimeMillisecondsToken, unixTimeMilliseconds, callback)
getex(
key
,unixTimeMillisecondsToken
,unixTimeMilliseconds
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• unixTimeMillisecondsToken: "PXAT"
• unixTimeMilliseconds: string
| number
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getex
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2200
getex(key, persist, callback)
getex(
key
,persist
,callback
?):Promise
<null
|string
>
Parameters
• key: RedisKey
• persist: "PERSIST"
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getex
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2202
getexBuffer()
getexBuffer(key, callback)
getexBuffer(
key
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getexBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2193
getexBuffer(key, secondsToken, seconds, callback)
getexBuffer(
key
,secondsToken
,seconds
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• secondsToken: "EX"
• seconds: string
| number
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getexBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2195
getexBuffer(key, millisecondsToken, milliseconds, callback)
getexBuffer(
key
,millisecondsToken
,milliseconds
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• millisecondsToken: "PX"
• milliseconds: string
| number
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getexBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2197
getexBuffer(key, unixTimeSecondsToken, unixTimeSeconds, callback)
getexBuffer(
key
,unixTimeSecondsToken
,unixTimeSeconds
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• unixTimeSecondsToken: "EXAT"
• unixTimeSeconds: string
| number
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getexBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2199
getexBuffer(key, unixTimeMillisecondsToken, unixTimeMilliseconds, callback)
getexBuffer(
key
,unixTimeMillisecondsToken
,unixTimeMilliseconds
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• unixTimeMillisecondsToken: "PXAT"
• unixTimeMilliseconds: string
| number
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getexBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2201
getexBuffer(key, persist, callback)
getexBuffer(
key
,persist
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• persist: "PERSIST"
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getexBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2203
getrange()
getrange(
key
,start
,end
,callback
?):Promise
<string
>
Get a substring of the string stored at a key
- group: string
- complexity: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
- since: 2.4.0
Parameters
• key: RedisKey
• start: string
| number
• end: string
| number
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.getrange
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2210
getrangeBuffer()
getrangeBuffer(
key
,start
,end
,callback
?):Promise
<Buffer
>
Parameters
• key: RedisKey
• start: string
| number
• end: string
| number
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.getrangeBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2211
getset()
getset(
key
,value
,callback
?):Promise
<null
|string
>
Set the string value of a key and return its old value
- group: string
- complexity: O(1)
- since: 1.0.0
Parameters
• key: RedisKey
• value: string
| number
| Buffer
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.getset
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2218
getsetBuffer()
getsetBuffer(
key
,value
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• value: string
| number
| Buffer
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.getsetBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2219
hdel()
hdel(args)
hdel(...
args
):Promise
<number
>
Delete one or more hash fields
- group: hash
- complexity: O(N) where N is the number of fields to be removed.
- since: 2.0.0
Parameters
• ...args: [RedisKey
, ...fields: (string | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.hdel
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2226
hdel(args)
hdel(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, ...fields: (string | Buffer)[]
]
Returns
Promise
<number
>
Inherited from
Redis.hdel
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2231
hello()
hello(callback)
hello(
callback
?):Promise
<unknown
[]>
Handshake with Redis
- group: connection
- complexity: O(1)
- since: 6.0.0
Parameters
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.hello
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2238
hello(protover, callback)
hello(
protover
,callback
?):Promise
<unknown
[]>
Parameters
• protover: string
| number
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.hello
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2239
hello(protover, clientnameToken, clientname, callback)
hello(
protover
,clientnameToken
,clientname
,callback
?):Promise
<unknown
[]>
Parameters
• protover: string
| number
• clientnameToken: "SETNAME"
• clientname: string
| Buffer
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.hello
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2240
hello(protover, usernamePasswordToken, username, password, callback)
hello(
protover
,usernamePasswordToken
,username
,password
,callback
?):Promise
<unknown
[]>
Parameters
• protover: string
| number
• usernamePasswordToken: "AUTH"
• username: string
| Buffer
• password: string
| Buffer
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.hello
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2241
hello(protover, usernamePasswordToken, username, password, clientnameToken, clientname, callback)
hello(
protover
,usernamePasswordToken
,username
,password
,clientnameToken
,clientname
,callback
?):Promise
<unknown
[]>
Parameters
• protover: string
| number
• usernamePasswordToken: "AUTH"
• username: string
| Buffer
• password: string
| Buffer
• clientnameToken: "SETNAME"
• clientname: string
| Buffer
• callback?: Callback
<unknown
[]>
Returns
Promise
<unknown
[]>
Inherited from
Redis.hello
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2242
hexists()
hexists(
key
,field
,callback
?):Promise
<number
>
Determine if a hash field exists
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
• key: RedisKey
• field: string
| Buffer
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.hexists
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2249
hget()
hget(
key
,field
,callback
?):Promise
<null
|string
>
Get the value of a hash field
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
• key: RedisKey
• field: string
| Buffer
• callback?: Callback
<null
| string
>
Returns
Promise
<null
| string
>
Inherited from
Redis.hget
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2256
hgetBuffer()
hgetBuffer(
key
,field
,callback
?):Promise
<null
|Buffer
>
Parameters
• key: RedisKey
• field: string
| Buffer
• callback?: Callback
<null
| Buffer
>
Returns
Promise
<null
| Buffer
>
Inherited from
Redis.hgetBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2257
hgetall()
hgetall(
key
,callback
?):Promise
<Record
<string
,string
>>
Get all the fields and values in a hash
- group: hash
- complexity: O(N) where N is the size of the hash.
- since: 2.0.0
Parameters
• key: RedisKey
• callback?: Callback
<Record
<string
, string
>>
Returns
Promise
<Record
<string
, string
>>
Inherited from
Redis.hgetall
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2264
hgetallBuffer()
hgetallBuffer(
key
,callback
?):Promise
<Record
<string
,Buffer
>>
Parameters
• key: RedisKey
• callback?: Callback
<Record
<string
, Buffer
>>
Returns
Promise
<Record
<string
, Buffer
>>
Inherited from
Redis.hgetallBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2265
hincrby()
hincrby(
key
,field
,increment
,callback
?):Promise
<number
>
Increment the integer value of a hash field by the given number
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
• key: RedisKey
• field: string
| Buffer
• increment: string
| number
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.hincrby
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2272
hincrbyfloat()
hincrbyfloat(
key
,field
,increment
,callback
?):Promise
<string
>
Increment the float value of a hash field by the given amount
- group: hash
- complexity: O(1)
- since: 2.6.0
Parameters
• key: RedisKey
• field: string
| Buffer
• increment: string
| number
• callback?: Callback
<string
>
Returns
Promise
<string
>
Inherited from
Redis.hincrbyfloat
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2279
hincrbyfloatBuffer()
hincrbyfloatBuffer(
key
,field
,increment
,callback
?):Promise
<Buffer
>
Parameters
• key: RedisKey
• field: string
| Buffer
• increment: string
| number
• callback?: Callback
<Buffer
>
Returns
Promise
<Buffer
>
Inherited from
Redis.hincrbyfloatBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2280
hkeys()
hkeys(
key
,callback
?):Promise
<string
[]>
Get all the fields in a hash
- group: hash
- complexity: O(N) where N is the size of the hash.
- since: 2.0.0
Parameters
• key: RedisKey
• callback?: Callback
<string
[]>
Returns
Promise
<string
[]>
Inherited from
Redis.hkeys
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2287
hkeysBuffer()
hkeysBuffer(
key
,callback
?):Promise
<Buffer
[]>
Parameters
• key: RedisKey
• callback?: Callback
<Buffer
[]>
Returns
Promise
<Buffer
[]>
Inherited from
Redis.hkeysBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2288
hlen()
hlen(
key
,callback
?):Promise
<number
>
Get the number of fields in a hash
- group: hash
- complexity: O(1)
- since: 2.0.0
Parameters
• key: RedisKey
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.hlen
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2295
hmget()
hmget(args)
hmget(...
args
):Promise
<(null
|string
)[]>
Get the values of all the given hash fields
- group: hash
- complexity: O(N) where N is the number of fields being requested.
- since: 2.0.0
Parameters
• ...args: [RedisKey
, ...fields: (string | Buffer)[]
, Callback
<(null
| string
)[]>]
Returns
Promise
<(null
| string
)[]>
Inherited from
Redis.hmget
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2302
hmget(args)
hmget(...
args
):Promise
<(null
|string
)[]>
Parameters
• ...args: [RedisKey
, ...fields: (string | Buffer)[]
]
Returns
Promise
<(null
| string
)[]>
Inherited from
Redis.hmget
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2312
hmgetBuffer()
hmgetBuffer(args)
hmgetBuffer(...
args
):Promise
<(null
|Buffer
)[]>
Parameters
• ...args: [RedisKey
, ...fields: (string | Buffer)[]
, Callback
<(null
| Buffer
)[]>]
Returns
Promise
<(null
| Buffer
)[]>
Inherited from
Redis.hmgetBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2307
hmgetBuffer(args)
hmgetBuffer(...
args
):Promise
<(null
|Buffer
)[]>
Parameters
• ...args: [RedisKey
, ...fields: (string | Buffer)[]
]
Returns
Promise
<(null
| Buffer
)[]>
Inherited from
Redis.hmgetBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2313
hmset()
hmset(key, object, callback)
hmset(
key
,object
,callback
?):Promise
<"OK"
>
Set multiple hash fields to multiple values
- group: hash
- complexity: O(N) where N is the number of fields being set.
- since: 2.0.0
Parameters
• key: RedisKey
• object: object
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.hmset
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2320
hmset(key, map, callback)
hmset(
key
,map
,callback
?):Promise
<"OK"
>
Parameters
• key: RedisKey
• map: Map
<string
| number
| Buffer
, string
| number
| Buffer
>
• callback?: Callback
<"OK"
>
Returns
Promise
<"OK"
>
Inherited from
Redis.hmset
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2321
hmset(args)
hmset(...
args
):Promise
<"OK"
>
Parameters
• ...args: [RedisKey
, ...fieldValues: (string | number | Buffer)[]
, Callback
<"OK"
>]
Returns
Promise
<"OK"
>
Inherited from
Redis.hmset
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2322
hmset(args)
hmset(...
args
):Promise
<"OK"
>
Parameters
• ...args: [RedisKey
, ...fieldValues: (string | number | Buffer)[]
]
Returns
Promise
<"OK"
>
Inherited from
Redis.hmset
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2327
hrandfield()
hrandfield(key, callback)
hrandfield(
key
,callback
?):Promise
<null
|string
|unknown
[]>
Get one or multiple random fields from a hash
- group: hash
- complexity: O(N) where N is the number of fields returned
- since: 6.2.0
Parameters
• key: RedisKey
• callback?: Callback
<null
| string
| unknown
[]>
Returns
Promise
<null
| string
| unknown
[]>
Inherited from
Redis.hrandfield
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2334
hrandfield(key, count, callback)
hrandfield(
key
,count
,callback
?):Promise
<null
|string
|unknown
[]>
Parameters
• key: RedisKey
• count: string
| number
• callback?: Callback
<null
| string
| unknown
[]>
Returns
Promise
<null
| string
| unknown
[]>
Inherited from
Redis.hrandfield
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2336
hrandfield(key, count, withvalues, callback)
hrandfield(
key
,count
,withvalues
,callback
?):Promise
<null
|string
|unknown
[]>
Parameters
• key: RedisKey
• count: string
| number
• withvalues: "WITHVALUES"
• callback?: Callback
<null
| string
| unknown
[]>
Returns
Promise
<null
| string
| unknown
[]>
Inherited from
Redis.hrandfield
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2338
hrandfieldBuffer()
hrandfieldBuffer(key, callback)
hrandfieldBuffer(
key
,callback
?):Promise
<null
|Buffer
|unknown
[]>
Parameters
• key: RedisKey
• callback?: Callback
<null
| Buffer
| unknown
[]>
Returns
Promise
<null
| Buffer
| unknown
[]>
Inherited from
Redis.hrandfieldBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2335
hrandfieldBuffer(key, count, callback)
hrandfieldBuffer(
key
,count
,callback
?):Promise
<null
|Buffer
|unknown
[]>
Parameters
• key: RedisKey
• count: string
| number
• callback?: Callback
<null
| Buffer
| unknown
[]>
Returns
Promise
<null
| Buffer
| unknown
[]>
Inherited from
Redis.hrandfieldBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2337
hrandfieldBuffer(key, count, withvalues, callback)
hrandfieldBuffer(
key
,count
,withvalues
,callback
?):Promise
<null
|Buffer
|unknown
[]>
Parameters
• key: RedisKey
• count: string
| number
• withvalues: "WITHVALUES"
• callback?: Callback
<null
| Buffer
| unknown
[]>
Returns
Promise
<null
| Buffer
| unknown
[]>
Inherited from
Redis.hrandfieldBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2339
hscan()
hscan(key, cursor, callback)
hscan(
key
,cursor
,callback
?):Promise
<[string
,string
[]]>
Incrementally iterate hash fields and associated values
- group: hash
- complexity: O(1) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection..
- since: 2.8.0
Parameters
• key: RedisKey
• cursor: string
| number
• callback?: Callback
<[string
, string
[]]>
Returns
Promise
<[string
, string
[]]>
Inherited from
Redis.hscan
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2346
hscan(key, cursor, countToken, count, callback)
hscan(
key
,cursor
,countToken
,count
,callback
?):Promise
<[string
,string
[]]>
Parameters
• key: RedisKey
• cursor: string
| number
• countToken: "COUNT"
• count: string
| number
• callback?: Callback
<[string
, string
[]]>
Returns
Promise
<[string
, string
[]]>
Inherited from
Redis.hscan
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2348
hscan(key, cursor, patternToken, pattern, callback)
hscan(
key
,cursor
,patternToken
,pattern
,callback
?):Promise
<[string
,string
[]]>
Parameters
• key: RedisKey
• cursor: string
| number
• patternToken: "MATCH"
• pattern: string
• callback?: Callback
<[string
, string
[]]>
Returns
Promise
<[string
, string
[]]>
Inherited from
Redis.hscan
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2350
hscan(key, cursor, patternToken, pattern, countToken, count, callback)
hscan(
key
,cursor
,patternToken
,pattern
,countToken
,count
,callback
?):Promise
<[string
,string
[]]>
Parameters
• key: RedisKey
• cursor: string
| number
• patternToken: "MATCH"
• pattern: string
• countToken: "COUNT"
• count: string
| number
• callback?: Callback
<[string
, string
[]]>
Returns
Promise
<[string
, string
[]]>
Inherited from
Redis.hscan
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2352
hscanBuffer()
hscanBuffer(key, cursor, callback)
hscanBuffer(
key
,cursor
,callback
?):Promise
<[Buffer
,Buffer
[]]>
Parameters
• key: RedisKey
• cursor: string
| number
• callback?: Callback
<[Buffer
, Buffer
[]]>
Returns
Promise
<[Buffer
, Buffer
[]]>
Inherited from
Redis.hscanBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2347
hscanBuffer(key, cursor, countToken, count, callback)
hscanBuffer(
key
,cursor
,countToken
,count
,callback
?):Promise
<[Buffer
,Buffer
[]]>
Parameters
• key: RedisKey
• cursor: string
| number
• countToken: "COUNT"
• count: string
| number
• callback?: Callback
<[Buffer
, Buffer
[]]>
Returns
Promise
<[Buffer
, Buffer
[]]>
Inherited from
Redis.hscanBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2349
hscanBuffer(key, cursor, patternToken, pattern, callback)
hscanBuffer(
key
,cursor
,patternToken
,pattern
,callback
?):Promise
<[Buffer
,Buffer
[]]>
Parameters
• key: RedisKey
• cursor: string
| number
• patternToken: "MATCH"
• pattern: string
• callback?: Callback
<[Buffer
, Buffer
[]]>
Returns
Promise
<[Buffer
, Buffer
[]]>
Inherited from
Redis.hscanBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2351
hscanBuffer(key, cursor, patternToken, pattern, countToken, count, callback)
hscanBuffer(
key
,cursor
,patternToken
,pattern
,countToken
,count
,callback
?):Promise
<[Buffer
,Buffer
[]]>
Parameters
• key: RedisKey
• cursor: string
| number
• patternToken: "MATCH"
• pattern: string
• countToken: "COUNT"
• count: string
| number
• callback?: Callback
<[Buffer
, Buffer
[]]>
Returns
Promise
<[Buffer
, Buffer
[]]>
Inherited from
Redis.hscanBuffer
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2353
hscanBufferStream()
hscanBufferStream(
key
,options
?):default
Parameters
• key: string
• options?: ScanStreamOptions
Returns
default
Inherited from
Redis.hscanBufferStream
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:169
hscanStream()
hscanStream(
key
,options
?):default
Parameters
• key: string
• options?: ScanStreamOptions
Returns
default
Inherited from
Redis.hscanStream
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/Redis.d.ts:168
hset()
hset(key, object, callback)
hset(
key
,object
,callback
?):Promise
<number
>
Set the string value of a hash field
- group: hash
- complexity: O(1) for each field/value pair added, so O(N) to add N field/value pairs when the command is called with multiple field/value pairs.
- since: 2.0.0
Parameters
• key: RedisKey
• object: object
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.hset
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2360
hset(key, map, callback)
hset(
key
,map
,callback
?):Promise
<number
>
Parameters
• key: RedisKey
• map: Map
<string
| number
| Buffer
, string
| number
| Buffer
>
• callback?: Callback
<number
>
Returns
Promise
<number
>
Inherited from
Redis.hset
Source
node_modules/.pnpm/ioredis@5.4.1/node_modules/ioredis/built/utils/RedisCommander.d.ts:2361
hset(args)
hset(...
args
):Promise
<number
>
Parameters
• ...args: [RedisKey
, ...fieldValues: (string | number | Buffer)[]
, Callback
<number
>]
Returns
Promise
<number
>
Inherited from
Redis.hset