Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClientOptions<M, S>
Returns default<M, S>
Properties
Private Readonly #isolation
Private Optional Readonly #options
Private Readonly #queue
Private #selectedDB
Private Readonly #socket
Private Readonly #v4
command
Type declaration
Type parameters
T: ClientCommandOptions
Parameters
options: T
Returns CommandOptions<T>
p
Type declaration
Type parameters
T: boolean = false
Parameters
patterns: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
p
Type declaration
Type parameters
T: boolean = false
Parameters
Optional patterns: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
quit
Type declaration
Returns Promise<void>
select
Type declaration
Parameters
db: number
Returns Promise<void>
Parameters
options: CommandOptions<ClientCommandOptions>
db: number
Returns Promise<void>
subscribe
Type declaration
Type parameters
T: boolean = false
Parameters
channels: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
unsubscribe
Type declaration
Type parameters
T: boolean = false
Parameters
Optional channels: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
Static Readonly capture
Static capture
Sets or gets the default captureRejection value for all emitters.
Static default
Static Readonly error
This symbol shall be used to install a listener for only monitoring
'error'@@ -7,10 +7,10 @@ events. Listeners installed using this symbol are called before the regularInstalling a listener using this symbol does not change the behavior once an
-'error'event is emitted, therefore the process will still crash if no regular'error'listener is installed.Accessors
is
Returns boolean
options
Returns undefined | RedisClientOptions<M, S>
v4
Returns Record<string, any>
Methods
Private #define
Parameters
name: string
Returns void
Private #destroy
Returns Promise<void>
Private #initiate
Parameters
Optional options: RedisClientOptions<M, S>
Returns undefined | RedisClientOptions<M, S>
Private #initiate
Returns default
Private #initiate
Returns default
Private #legacy
Returns void
Private #send
Type parameters
T = RedisCommandRawReply
Parameters
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<T>
Private #subscribe
Type parameters
T: boolean
Parameters
command: PubSubSubscribeCommands
channels: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
Private #tick
Parameters
force: boolean = false
Returns void
Private #unsubscribe
Type parameters
T: boolean
Parameters
command: PubSubUnsubscribeCommands
Optional channels: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
PSUBSCRIBE
Type parameters
T: boolean = false
Parameters
patterns: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
PUNSUBSCRIBE
Type parameters
T: boolean = false
Parameters
Optional patterns: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
QUIT
Returns Promise<void>
SELECT
Parameters
db: number
Returns Promise<void>
Parameters
options: CommandOptions<ClientCommandOptions>
db: number
Returns Promise<void>
SUBSCRIBE
Type parameters
T: boolean = false
Parameters
channels: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
UNSUBSCRIBE
Type parameters
T: boolean = false
Parameters
Optional channels: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
add
Accessors
is
Returns boolean
options
Returns undefined | RedisClientOptions<M, S>
v4
Returns Record<string, any>
Methods
Private #define
Parameters
name: string
Returns void
Private #destroy
Returns Promise<void>
Private #initiate
Parameters
Optional options: RedisClientOptions<M, S>
Returns undefined | RedisClientOptions<M, S>
Private #initiate
Returns default
Private #initiate
Returns default
Private #legacy
Returns void
Private #send
Type parameters
T = RedisCommandRawReply
Parameters
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<T>
Private #subscribe
Type parameters
T: boolean
Parameters
command: PubSubSubscribeCommands
channels: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
Private #tick
Parameters
force: boolean = false
Returns void
Private #unsubscribe
Type parameters
T: boolean
Parameters
command: PubSubUnsubscribeCommands
Optional channels: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
PSUBSCRIBE
Type parameters
T: boolean = false
Parameters
patterns: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
PUNSUBSCRIBE
Type parameters
T: boolean = false
Parameters
Optional patterns: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
QUIT
Returns Promise<void>
SELECT
Parameters
db: number
Returns Promise<void>
Parameters
options: CommandOptions<ClientCommandOptions>
db: number
Returns Promise<void>
SUBSCRIBE
Type parameters
T: boolean = false
Parameters
channels: string | string[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
UNSUBSCRIBE
Type parameters
T: boolean = false
Parameters
Optional channels: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional bufferMode: T
Returns Promise<void>
add
Alias for
emitter.on(eventName, listener).v0.1.26
-Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
commands
Parameters
command: RedisCommand
args: unknown[]
Returns Promise<RedisCommandRawReply>
connect
Returns Promise<void>
disconnect
Returns Promise<void>
duplicate
Parameters
Optional overrides: Partial<RedisClientOptions<M, S>>
Returns RedisClientType<M, S>
emit
Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
commands
Parameters
command: RedisCommand
args: unknown[]
Returns Promise<RedisCommandRawReply>
connect
Returns Promise<void>
disconnect
Returns Promise<void>
duplicate
Parameters
Optional overrides: Partial<RedisClientOptions<M, S>>
Returns RedisClientType<M, S>
emit
Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments to each.Returns
@@ -23,11 +23,11 @@ listeners. The values in the array are strings ortrueif the event had listeners,falseotherwise.Symbols.v6.0.0
-Returns (string | symbol)[]
execute
Type parameters
T
Parameters
fn: (client: RedisClientType<M, S>) => T | Promise<T>
Parameters
client: RedisClientType<M, S>
Returns T | Promise<T>
Returns Promise<T>
execute
Parameters
script: RedisScript
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<RedisCommandRawReply>
get
Returns (string | symbol)[]
execute
Type parameters
T
Parameters
fn: (client: RedisClientType<M, S>) => T | Promise<T>
Parameters
client: RedisClientType<M, S>
Returns T | Promise<T>
Returns Promise<T>
execute
Parameters
script: RedisScript
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<RedisCommandRawReply>
get
Returns the current max listener value for the
EventEmitterwhich is either set byemitter.setMaxListeners(n)or defaults to defaultMaxListeners.v1.0.0
-Returns number
h
Parameters
key: string
Optional options: ScanOptions
Returns AsyncIterable<{ field: string; value: string }>
listener
Returns number
h
Parameters
key: string
Optional options: ScanOptions
Returns AsyncIterable<{ field: string; value: string }>
listener
Returns the number of listeners listening to the event named
eventName.v3.2.0
Parameters
eventName: string | symbol
emitter.setMaxListeners(n)or defaults to server.on('connection', (stream) => {console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
v0.1.26
-Parameters
eventName: string | symbol
Returns Function[]
multi
Returns RedisClientMultiCommandType<M, S>
multi
Parameters
commands: RedisMultiQueuedCommand[]
Optional chainId: symbol
Returns Promise<RedisCommandRawReply[]>
off
Parameters
eventName: string | symbol
Returns Function[]
multi
Returns RedisClientMultiCommandType<M, S>
multi
Parameters
commands: RedisMultiQueuedCommand[]
Optional chainId: symbol
Returns Promise<RedisCommandRawReply[]>
off
Alias for
emitter.removeListener().v10.0.0
Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
on
once('ping')lisReturns a reference to the
EventEmitter, so that calls can be chained.v0.1.26
-Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
s
Parameters
key: string
Optional options: ScanOptions
Returns AsyncIterable<string>
scan
Parameters
Optional options: ScanCommandOptions
Returns AsyncIterable<string>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns Promise<RedisCommandRawReply>
send
Type parameters
T = RedisCommandRawReply
Parameters
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<T>
set
Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
s
Parameters
key: string
Optional options: ScanOptions
Returns AsyncIterable<string>
scan
Parameters
Optional options: ScanCommandOptions
Returns AsyncIterable<string>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns Promise<RedisCommandRawReply>
send
Type parameters
T = RedisCommandRawReply
Parameters
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<T>
set
By default
EventEmitters will print a warning if more than10listeners are added for a particular event. This is a useful default that helps finding memory leaks. Theemitter.setMaxListeners()method allows the limit to be modified for this specificEventEmitterinstance. The value can be set toInfinity(or0) to indicate an unlimited number of listeners.Returns a reference to the
EventEmitter, so that calls can be chained.v0.3.5
-Parameters
n: number
Returns default<M, S>
z
Parameters
key: string
Optional options: ScanOptions
Returns AsyncIterable<{ score: number; value: string }>
Static command
Type parameters
T: ClientCommandOptions
Parameters
options: T
Returns CommandOptions<T>
Static create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClientOptions<M, S>
Returns RedisClientType<M, S>
Static extend
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional plugins: RedisPlugins<M, S>
Returns InstantiableRedisClient<M, S>
Static get
Parameters
n: number
Returns default<M, S>
z
Parameters
key: string
Optional options: ScanOptions
Returns AsyncIterable<{ score: number; value: string }>
Static command
Type parameters
T: ClientCommandOptions
Parameters
options: T
Returns CommandOptions<T>
Static create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClientOptions<M, S>
Returns RedisClientType<M, S>
Static extend
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional plugins: RedisPlugins<M, S>
Returns InstantiableRedisClient<M, S>
Static get
Returns a copy of the array of listeners for the event named
eventName.For
@@ -202,4 +202,4 @@ special handling:EventEmitters this behaves exactly the same as calling.listenerson the emitter.v11.13.0, v10.16.0
-Parameters
emitter: NodeEventTarget
eventName: string | symbol
Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Parameters
emitter: DOMEventTarget
eventName: string
Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Static parseURL
Parameters
url: string
Returns RedisClientOptions<Record<string, never>, Record<string, never>>
Generated using TypeDoc
Parameters
emitter: NodeEventTarget
eventName: string | symbol
Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Parameters
emitter: DOMEventTarget
eventName: string
Optional options: StaticEventEmitterOptions
Returns Promise<any[]>
Static parseURL
Parameters
url: string
Returns RedisClientOptions<Record<string, never>, Record<string, never>>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
maxLength: undefined | null | number
Returns default
Properties
Private #chain
Private Readonly #max
Private Readonly #parser
Private #pub
Private Readonly #waiting
Private Readonly #waiting
Static Private Readonly #PUB_
Type declaration
message: Buffer
p
p
p
subscribe: Buffer
unsubscribe: Buffer
Methods
Private #initiate
Returns PubSubState
Private #push
Parameters
command: PubSubSubscribeCommands | PubSubUnsubscribeCommands
channels: number | RedisCommandArgument[]
Returns Promise<void>
Private #set
Returns void
Private #shift
Returns CommandWaitingForReply
add
Type parameters
T = RedisCommandRawReply
Parameters
args: RedisCommandArguments
Optional options: QueueCommandOptions
Returns Promise<T>
flush
Parameters
err: Error
Returns void
flush
Parameters
err: Error
Returns void
get
Returns undefined | RedisCommandArguments
parse
Parameters
data: Buffer
Returns void
resubscribe
Returns undefined | Promise<any>
subscribe
Type parameters
T: boolean
Parameters
command: PubSubSubscribeCommands
channels: RedisCommandArgument | RedisCommandArgument[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional returnBuffers: T
Returns Promise<void>
unsubscribe
Type parameters
T: boolean
Parameters
command: PubSubUnsubscribeCommands
Optional channels: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional returnBuffers: T
Returns Promise<void>
Static Private #emit
Parameters
listenersMap: PubSubListenersMap
message: Buffer
channel: Buffer
Optional pattern: Buffer
Returns void
Static Private #flush
Type parameters
T: CommandWaitingForReply
Parameters
queue: Yallist<T>
err: Error
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
maxLength: undefined | null | number
Returns default
Properties
Private #chain
Private Readonly #max
Private Readonly #parser
Private #pub
Private Readonly #waiting
Private Readonly #waiting
Static Private Readonly #PUB_
Type declaration
message: Buffer
p
p
p
subscribe: Buffer
unsubscribe: Buffer
Methods
Private #initiate
Returns PubSubState
Private #push
Parameters
command: PubSubSubscribeCommands | PubSubUnsubscribeCommands
channels: number | RedisCommandArgument[]
Returns Promise<void>
Private #set
Returns void
Private #shift
Returns CommandWaitingForReply
add
Type parameters
T = RedisCommandRawReply
Parameters
args: RedisCommandArguments
Optional options: QueueCommandOptions
Returns Promise<T>
flush
Parameters
err: Error
Returns void
flush
Parameters
err: Error
Returns void
get
Returns undefined | RedisCommandArguments
parse
Parameters
data: Buffer
Returns void
resubscribe
Returns undefined | Promise<any>
subscribe
Type parameters
T: boolean
Parameters
command: PubSubSubscribeCommands
channels: RedisCommandArgument | RedisCommandArgument[]
listener: PubSubListener<T, T extends true ? Buffer : string>
Optional returnBuffers: T
Returns Promise<void>
unsubscribe
Type parameters
T: boolean
Parameters
command: PubSubUnsubscribeCommands
Optional channels: string | string[]
Optional listener: PubSubListener<T, T extends true ? Buffer : string>
Optional returnBuffers: T
Returns Promise<void>
Static Private #emit
Parameters
listenersMap: PubSubListenersMap
message: Buffer
channel: Buffer
Optional pattern: Buffer
Returns void
Static Private #flush
Type parameters
T: CommandWaitingForReply
Parameters
queue: Yallist<T>
err: Error
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
executor: RedisClientMultiExecutor
legacyMode: boolean = false
Returns default
Properties
Private Readonly #executor
Private Readonly #multi
EXEC
Type declaration
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
Readonly v4
Methods
Private #define
Parameters
name: string
Returns void
Private #legacy
Returns void
add
Parameters
args: RedisCommandArguments
Optional transformReply: (reply: any, preserved?: any) => any
Parameters
reply: any
Optional preserved: any
Returns any
Returns default
commands
Parameters
command: RedisCommand
args: unknown[]
Returns default
exec
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
exec
Returns Promise<RedisCommandRawReply[]>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns default
Static extend
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional plugins: RedisPlugins<M, S>
Returns new (...args: []) => RedisClientMultiCommandType<M, S>
Parameters
Rest ...args: []
Returns RedisClientMultiCommandType<M, S>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
executor: RedisClientMultiExecutor
legacyMode: boolean = false
Returns default
Properties
Private Readonly #executor
Private Readonly #multi
EXEC
Type declaration
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
Readonly v4
Methods
Private #define
Parameters
name: string
Returns void
Private #legacy
Returns void
add
Parameters
args: RedisCommandArguments
Optional transformReply: (reply: any, preserved?: any) => any
Parameters
reply: any
Optional preserved: any
Returns any
Returns default
commands
Parameters
command: RedisCommand
args: unknown[]
Returns default
exec
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
exec
Returns Promise<RedisCommandRawReply[]>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns default
Static extend
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional plugins: RedisPlugins<M, S>
Returns new (...args: []) => RedisClientMultiCommandType<M, S>
Parameters
Rest ...args: []
Returns RedisClientMultiCommandType<M, S>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional initiator: RedisSocketInitiator
Optional options: RedisSocketOptions
Returns default
Properties
Private Optional Readonly #initiator
Private #is
Private #is
Private #is
Private Readonly #options
Private Optional #socket
Private #writable
Static Readonly capture
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
Parameters
Optional initiator: RedisSocketInitiator
Optional options: RedisSocketOptions
Returns default
Properties
Private Optional Readonly #initiator
Private #is
Private #is
Private #is
Private Readonly #options
Private Optional #socket
Private #writable
Static Readonly capture
Static capture
Sets or gets the default captureRejection value for all emitters.
Static default
Static Readonly error
This symbol shall be used to install a listener for only monitoring
'error'@@ -7,10 +7,10 @@ events. Listeners installed using this symbol are called before the regularInstalling a listener using this symbol does not change the behavior once an
-'error'event is emitted, therefore the process will still crash if no regular'error'listener is installed.Accessors
is
Returns boolean
is
Returns boolean
writable
Returns boolean
Methods
Private #connect
Parameters
Optional hadError: boolean
Returns Promise<void>
Private #create
Returns CreateSocketReturn<Socket>
Private #create
Returns Promise<Socket | TLSSocket>
Private #create
Returns CreateSocketReturn<TLSSocket>
Private #on
Parameters
err: Error
Returns void
Private #retry
Parameters
retries: number
Optional hadError: boolean
Returns Promise<Socket | TLSSocket>
add
Accessors
is
Returns boolean
is
Returns boolean
writable
Returns boolean
Methods
Private #connect
Parameters
Optional hadError: boolean
Returns Promise<void>
Private #create
Returns CreateSocketReturn<Socket>
Private #create
Returns Promise<Socket | TLSSocket>
Private #create
Returns CreateSocketReturn<TLSSocket>
Private #on
Parameters
err: Error
Returns void
Private #retry
Parameters
retries: number
Optional hadError: boolean
Returns Promise<Socket | TLSSocket>
add
Alias for
emitter.on(eventName, listener).v0.1.26
-Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default
connect
Returns Promise<void>
cork
Returns void
disconnect
Returns void
emit
Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default
connect
Returns Promise<void>
cork
Returns void
disconnect
Returns void
emit
Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments to each.Returns
@@ -96,7 +96,7 @@ listener is removed, and then invoked.trueif the event had listeners,falseotherwise.The name of the event.
listener: (...args: any[]) => void
The callback function
-Parameters
Rest ...args: any[]
Returns void
Returns default
quit
Parameters
fn: () => Promise<unknown>
Returns Promise<unknown>
Returns Promise<void>
raw
Parameters
Rest ...args: any[]
Returns void
Returns default
quit
Parameters
fn: () => Promise<unknown>
Returns Promise<unknown>
Returns Promise<void>
raw
Returns a copy of the array of listeners for the event named
eventName, including any wrappers (such as those created by.once()).Returns a reference to the
EventEmitter, so that calls can be chained.v0.3.5
-Parameters
n: number
Returns default
write
Parameters
args: RedisCommandArguments
Returns void
Static Private #default
Parameters
retries: number
Returns number
Static Private #initiate
Parameters
Optional options: RedisSocketOptions
Returns RedisSocketOptions
Static Private #is
Parameters
options: RedisSocketOptions
Returns options is RedisTlsSocketOptions
Static get
Parameters
n: number
Returns default
write
Parameters
args: RedisCommandArguments
Returns void
Static Private #default
Parameters
retries: number
Returns number
Static Private #initiate
Parameters
Optional options: RedisSocketOptions
Returns RedisSocketOptions
Static Private #is
Parameters
options: RedisSocketOptions
Returns options is RedisTlsSocketOptions
Static get
Returns a copy of the array of listeners for the event named
eventName.For
diff --git a/documentation/client/classes/lib_cluster.default.html b/documentation/client/classes/lib_cluster.default.html index de2567943c..1c73376d30 100644 --- a/documentation/client/classes/lib_cluster.default.html +++ b/documentation/client/classes/lib_cluster.default.html @@ -1,4 +1,4 @@ -EventEmitters this behaves exactly the same as calling.listenerson the emitter.- Preparing search index...
- The search index is not available
@node-redis/clientClass default<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type parameters
M: RedisModules
S: RedisScripts
Parameters
options: RedisClusterOptions<M, S>
Returns default<M, S>
Properties
Private Readonly #
Type declaration
Parameters
Rest ...args: [executor: RedisClusterMultiExecutor, firstKey?: RedisCommandArgument]
Returns RedisClusterMultiCommandType<M, S>
Private Readonly #options
Private Readonly #slots
Static Readonly capture
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass default<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type parameters
M: RedisModules
S: RedisScripts
Parameters
options: RedisClusterOptions<M, S>
Returns default<M, S>
Properties
Private Readonly #
Type declaration
Parameters
Rest ...args: [executor: RedisClusterMultiExecutor, firstKey?: RedisCommandArgument]
Returns RedisClusterMultiCommandType<M, S>
Private Readonly #options
Private Readonly #slots
Static Readonly capture
Static capture
Sets or gets the default captureRejection value for all emitters.
Static default
Static Readonly error
This symbol shall be used to install a listener for only monitoring
'error'@@ -7,10 +7,10 @@ events. Listeners installed using this symbol are called before the regularInstalling a listener using this symbol does not change the behavior once an
-'error'event is emitted, therefore the process will still crash if no regular'error'listener is installed.Methods
Private #execute
Type parameters
Reply
Parameters
firstKey: undefined | RedisCommandArgument
isReadonly: undefined | boolean
executor: (client: RedisClientType<M, S>) => Promise<Reply>
Parameters
client: RedisClientType<M, S>
Returns Promise<Reply>
Returns Promise<Reply>
add
Methods
Private #execute
Type parameters
Reply
Parameters
firstKey: undefined | RedisCommandArgument
isReadonly: undefined | boolean
executor: (client: RedisClientType<M, S>) => Promise<Reply>
Parameters
client: RedisClientType<M, S>
Returns Promise<Reply>
Returns Promise<Reply>
add
Alias for
emitter.on(eventName, listener).v0.1.26
-Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
commands
Parameters
command: RedisCommand
args: unknown[]
Returns Promise<RedisCommandRawReply>
connect
Returns Promise<void>
disconnect
Returns Promise<void>
duplicate
Parameters
Optional overrides: Partial<RedisClusterOptions<M, S>>
Returns RedisClusterType<M, S>
emit
Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
commands
Parameters
command: RedisCommand
args: unknown[]
Returns Promise<RedisCommandRawReply>
connect
Returns Promise<void>
disconnect
Returns Promise<void>
duplicate
Parameters
Optional overrides: Partial<RedisClusterOptions<M, S>>
Returns RedisClusterType<M, S>
emit
Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments to each.Returns
@@ -23,11 +23,11 @@ listeners. The values in the array are strings ortrueif the event had listeners,falseotherwise.Symbols.v6.0.0
-Returns (string | symbol)[]
execute
Parameters
script: RedisScript
originalArgs: unknown[]
redisArgs: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<RedisCommandRawReply>
get
Returns ClusterNode<M, S>[]
get
Returns (string | symbol)[]
execute
Parameters
script: RedisScript
originalArgs: unknown[]
redisArgs: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<RedisCommandRawReply>
get
Returns ClusterNode<M, S>[]
get
Returns the current max listener value for the
EventEmitterwhich is either set byemitter.setMaxListeners(n)or defaults to defaultMaxListeners.v1.0.0
-Returns number
get
Parameters
slot: number
Returns ClusterNode<M, S>
listener
Returns number
get
Parameters
slot: number
Returns ClusterNode<M, S>
listener
Returns the number of listeners listening to the event named
eventName.v3.2.0
Parameters
eventName: string | symbol
emitter.setMaxListeners(n)or defaults to server.on('connection', (stream) => {console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
v0.1.26
-Parameters
eventName: string | symbol
Returns Function[]
multi
Parameters
Optional routing: RedisCommandArgument
Returns RedisClusterMultiCommandType<M, S>
off
Parameters
eventName: string | symbol
Returns Function[]
multi
Parameters
Optional routing: RedisCommandArgument
Returns RedisClusterMultiCommandType<M, S>
off
Alias for
emitter.removeListener().v10.0.0
Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
on
once('ping')lisReturns a reference to the
EventEmitter, so that calls can be chained.v0.1.26
-Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns Promise<RedisCommandRawReply>
send
Type parameters
T = RedisCommandRawReply
Parameters
firstKey: undefined | RedisCommandArgument
isReadonly: undefined | boolean
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<T>
set
Parameters
eventName: string | symbol
listener: (...args: any[]) => void
Parameters
Rest ...args: any[]
Returns void
Returns default<M, S>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns Promise<RedisCommandRawReply>
send
Type parameters
T = RedisCommandRawReply
Parameters
firstKey: undefined | RedisCommandArgument
isReadonly: undefined | boolean
args: RedisCommandArguments
Optional options: ClientCommandOptions
Returns Promise<T>
set
By default
EventEmitters will print a warning if more than10listeners are added for a particular event. This is a useful default that helps finding memory leaks. Theemitter.setMaxListeners()method allows the limit to be modified for this specificEventEmitterinstance. The value can be set toInfinity(or0) to indicate an unlimited number of listeners.Returns a reference to the
EventEmitter, so that calls can be chained.v0.3.5
-Parameters
n: number
Returns default<M, S>
Static create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClusterOptions<M, S>
Returns RedisClusterType<M, S>
Static extract
Parameters
command: RedisCommand
originalArgs: unknown[]
redisArgs: RedisCommandArguments
Returns undefined | RedisCommandArgument
Static get
Parameters
n: number
Returns default<M, S>
Static create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClusterOptions<M, S>
Returns RedisClusterType<M, S>
Static extract
Parameters
command: RedisCommand
originalArgs: unknown[]
redisArgs: RedisCommandArguments
Returns undefined | RedisCommandArgument
Static get
Returns a copy of the array of listeners for the event named
eventName.For
diff --git a/documentation/client/classes/lib_cluster_cluster_slots.default.html b/documentation/client/classes/lib_cluster_cluster_slots.default.html index 5dc9fa15c2..2c09d67660 100644 --- a/documentation/client/classes/lib_cluster_cluster_slots.default.html +++ b/documentation/client/classes/lib_cluster_cluster_slots.default.html @@ -1 +1 @@ -EventEmitters this behaves exactly the same as calling.listenerson the emitter.- Preparing search index...
- The search index is not available
@node-redis/clientClass default<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type parameters
M: RedisModules
S: RedisScripts
Parameters
options: RedisClusterOptions<M, S>
onError: OnError
Returns default<M, S>
Properties
Private Readonly #
Private Readonly #node
Private Readonly #on
Private Readonly #options
Private Optional #random
Private Optional #running
Private Readonly #slots
Methods
Private #client
Parameters
Optional options: RedisClusterClientOptions
Returns undefined | RedisClusterClientOptions
Private #discover
Parameters
Optional clientOptions: RedisClusterClientOptions
Returns Promise<boolean>
Private #get
Returns RedisClientType<M, S>
Private #get
Parameters
slotNumber: number
Returns RedisClientType<M, S>
Private #initiate
Parameters
Optional options: RedisClusterClientOptions
Returns RedisClientType<M, S>
Private #initiate
Parameters
nodeData: RedisClusterMasterNode | RedisClusterReplicaNode
readonly: boolean
clientsInUse: Set<string>
promises: Promise<void>[]
Returns ClusterNode<M, S>
Private #rediscover
Parameters
startWith: RedisClientType<M, S>
Returns Promise<void>
Private #reset
Parameters
masters: RedisClusterMasterNode[]
Returns Promise<void>
Private #slot
Parameters
slotNumber: number
Returns IterableIterator<RedisClientType<M, S>>
connect
Returns Promise<void>
disconnect
Returns Promise<void>
get
Parameters
Optional firstKey: RedisCommandArgument
Optional isReadonly: boolean
Returns RedisClientType<M, S>
get
Returns ClusterNode<M, S>[]
get
Parameters
url: string
Returns undefined | ClusterNode<M, S>
get
Parameters
slot: number
Returns ClusterNode<M, S>
rediscover
Parameters
startWith: RedisClientType<M, S>
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Type parameters
M: RedisModules
S: RedisScripts
Parameters
options: RedisClusterOptions<M, S>
onError: OnError
Returns default<M, S>
Properties
Private Readonly #
Private Readonly #node
Private Readonly #on
Private Readonly #options
Private Optional #random
Private Optional #running
Private Readonly #slots
Methods
Private #client
Parameters
Optional options: RedisClusterClientOptions
Returns undefined | RedisClusterClientOptions
Private #discover
Parameters
Optional clientOptions: RedisClusterClientOptions
Returns Promise<boolean>
Private #get
Returns RedisClientType<M, S>
Private #get
Parameters
slotNumber: number
Returns RedisClientType<M, S>
Private #initiate
Parameters
Optional options: RedisClusterClientOptions
Returns RedisClientType<M, S>
Private #initiate
Parameters
nodeData: RedisClusterMasterNode | RedisClusterReplicaNode
readonly: boolean
clientsInUse: Set<string>
promises: Promise<void>[]
Returns ClusterNode<M, S>
Private #rediscover
Parameters
startWith: RedisClientType<M, S>
Returns Promise<void>
Private #reset
Parameters
masters: RedisClusterMasterNode[]
Returns Promise<void>
Private #slot
Parameters
slotNumber: number
Returns IterableIterator<RedisClientType<M, S>>
connect
Returns Promise<void>
disconnect
Returns Promise<void>
get
Parameters
Optional firstKey: RedisCommandArgument
Optional isReadonly: boolean
Returns RedisClientType<M, S>
get
Returns ClusterNode<M, S>[]
get
Parameters
url: string
Returns undefined | ClusterNode<M, S>
get
Parameters
slot: number
Returns ClusterNode<M, S>
rediscover
Parameters
startWith: RedisClientType<M, S>
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
executor: RedisClusterMultiExecutor
Optional firstKey: RedisCommandArgument
Returns default
Properties
Private Readonly #executor
Private #first
Private Readonly #multi
EXEC
Type declaration
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
Methods
add
Parameters
firstKey: undefined | RedisCommandArgument
args: RedisCommandArguments
Optional transformReply: (reply: any, preserved?: any) => any
Parameters
reply: any
Optional preserved: any
Returns any
Returns default
commands
Parameters
command: RedisCommand
args: unknown[]
Returns default
exec
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
exec
Returns Promise<RedisCommandRawReply[]>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns default
Static extend
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional plugins: RedisPlugins<M, S>
Returns new (...args: []) => RedisClusterMultiCommandType<M, S>
Parameters
Rest ...args: []
Returns RedisClusterMultiCommandType<M, S>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
executor: RedisClusterMultiExecutor
Optional firstKey: RedisCommandArgument
Returns default
Properties
Private Readonly #executor
Private #first
Private Readonly #multi
EXEC
Type declaration
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
Methods
add
Parameters
firstKey: undefined | RedisCommandArgument
args: RedisCommandArguments
Optional transformReply: (reply: any, preserved?: any) => any
Parameters
reply: any
Optional preserved: any
Returns any
Returns default
commands
Parameters
command: RedisCommand
args: unknown[]
Returns default
exec
Parameters
execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>
exec
Returns Promise<RedisCommandRawReply[]>
scripts
Parameters
script: RedisScript
args: unknown[]
Returns default
Static extend
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional plugins: RedisPlugins<M, S>
Returns new (...args: []) => RedisClusterMultiCommandType<M, S>
Parameters
Rest ...args: []
Returns RedisClusterMultiCommandType<M, S>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass AbortError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns AbortError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass AbortError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns AbortError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass AuthError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Returns AuthError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass AuthError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
message: string
Returns AuthError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass ClientClosedError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns ClientClosedError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass ClientClosedError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns ClientClosedError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass ConnectionTimeoutError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns ConnectionTimeoutError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass ConnectionTimeoutError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns ConnectionTimeoutError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass DisconnectsClientError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns DisconnectsClientError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass DisconnectsClientError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns DisconnectsClientError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass ReconnectStrategyError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
originalError: Error
socketError: unknown
Returns ReconnectStrategyError
Properties
message
name
original
socket
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass ReconnectStrategyError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
originalError: Error
socketError: unknown
Returns ReconnectStrategyError
Properties
message
name
original
socket
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass RootNodesUnavailableError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns RootNodesUnavailableError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass RootNodesUnavailableError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns RootNodesUnavailableError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass SocketClosedUnexpectedlyError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns SocketClosedUnexpectedlyError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
- Preparing search index...
- The search index is not available
@node-redis/clientClass SocketClosedUnexpectedlyError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns SocketClosedUnexpectedlyError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration
Optional override for formatting stack traces
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Methods
Static capture
- Preparing search index...
- The search index is not available
@node-redis/clientClass WatchError
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns WatchError
Properties
message
name
Optional stack
Static Optional prepare
Type declaration