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 0511a97ceb..7453e562ff 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 #handle
Parameters
err: Error
client: RedisClientType<M, S>
redirections: number
Returns Promise<boolean | RedisClientType<M, S>>
add
Methods
Private #handle
Parameters
err: Error
client: RedisClientType<M, S>
redirections: number
Returns Promise<boolean | RedisClientType<M, S>>
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
redirections: number = 0
Returns Promise<RedisCommandRawReply>
get
Returns ClusterNode<M, S>[]
get
Returns (string | symbol)[]
execute
Parameters
script: RedisScript
originalArgs: unknown[]
redisArgs: RedisCommandArguments
Optional options: ClientCommandOptions
redirections: number = 0
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
C: RedisCommand
Parameters
firstKey: undefined | RedisCommandArgument
isReadonly: undefined | boolean
args: RedisCommandArguments
Optional options: ClientCommandOptions
redirections: number = 0
Returns Promise<RedisCommandReply<C>>
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
C: RedisCommand
Parameters
firstKey: undefined | RedisCommandArgument
isReadonly: undefined | boolean
args: RedisCommandArguments
Optional options: ClientCommandOptions
redirections: number = 0
Returns Promise<RedisCommandReply<C>>
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 8a75a42817..20886433a3 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 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
- 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
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 default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Readonly queue
Readonly scripts
Methods
add
Parameters
args: RedisCommandArguments
Optional transformReply: (reply: any, preserved?: any) => any
Parameters
reply: any
Optional preserved: any
Returns any
Returns void
add
Parameters
script: RedisScript
args: unknown[]
Returns RedisCommandArguments
exec
Returns undefined | RedisMultiQueuedCommand[]
handle
Parameters
rawReplies: RedisCommandRawReply[]
Returns RedisCommandRawReply[]
transform
Parameters
rawReplies: RedisCommandRawReply[]
Returns RedisCommandRawReply[]
Static generate
Returns symbol
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Readonly queue
Readonly scripts
Methods
add
Parameters
args: RedisCommandArguments
Optional transformReply: (reply: any, preserved?: any) => any
Parameters
reply: any
Optional preserved: any
Returns any
Returns void
add
Parameters
script: RedisScript
args: unknown[]
Returns RedisCommandArguments
exec
Returns undefined | RedisMultiQueuedCommand[]
handle
Parameters
rawReplies: RedisCommandRawReply[]
Returns RedisCommandRawReply[]
transform
Parameters
rawReplies: RedisCommandRawReply[]
Returns RedisCommandRawReply[]
Static generate
Returns symbol
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration PubSubSubscribeCommands
Index
Enumeration members
Enumeration members
PSUBSCRIBE
SUBSCRIBE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration PubSubSubscribeCommands
Index
Enumeration members
Enumeration members
PSUBSCRIBE
SUBSCRIBE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration PubSubUnsubscribeCommands
Index
Enumeration members
Enumeration members
PUNSUBSCRIBE
UNSUBSCRIBE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration PubSubUnsubscribeCommands
Index
Enumeration members
Enumeration members
PUNSUBSCRIBE
UNSUBSCRIBE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration ClientKillFilters
Index
Enumeration members
Enumeration members
ADDRESS
ID
LOCAL_
SKIP_
TYPE
USER
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration ClientKillFilters
Index
Enumeration members
Enumeration members
ADDRESS
ID
LOCAL_
SKIP_
TYPE
USER
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration RedisClusterNodeLinkStates
Index
Enumeration members
Enumeration members
CONNECTED
DISCONNECTED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration RedisClusterNodeLinkStates
Index
Enumeration members
Enumeration members
CONNECTED
DISCONNECTED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration ClusterSlotStates
Index
Enumeration members
Enumeration members
IMPORTING
MIGRATING
NODE
STABLE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration ClusterSlotStates
Index
Enumeration members
Enumeration members
IMPORTING
MIGRATING
NODE
STABLE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration RedisFlushModes
Index
Enumeration members
Enumeration members
ASYNC
SYNC
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration RedisFlushModes
Index
Enumeration members
Enumeration members
ASYNC
SYNC
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration CommandCategories
Index
Enumeration members
Enumeration members
ADMIN
BITMAP
BLOCKING
CONNECTION
DANGEROUS
FAST
GEO
HASH
HYPERLOGLOG
KEYSPACE
LIST
PUBSUB
READ
SCRIPTING
SET
SLOW
SORTEDSET
STREAM
STRING
TRANSACTION
WRITE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration CommandCategories
Index
Enumeration members
Enumeration members
ADMIN
BITMAP
BLOCKING
CONNECTION
DANGEROUS
FAST
GEO
HASH
HYPERLOGLOG
KEYSPACE
LIST
PUBSUB
READ
SCRIPTING
SET
SLOW
SORTEDSET
STREAM
STRING
TRANSACTION
WRITE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration CommandFlags
Index
Enumeration members
Enumeration members
ADMIN
ASKING
DENYOOM
FAST
LOADING
MOVABLEKEYS
NOSCRIPT
PUBSUB
RANDOM
READONLY
SKIP_
SORT_
STALE
WRITE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration CommandFlags
Index
Enumeration members
Enumeration members
ADMIN
ASKING
DENYOOM
FAST
LOADING
MOVABLEKEYS
NOSCRIPT
PUBSUB
RANDOM
READONLY
SKIP_
SORT_
STALE
WRITE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration GeoReplyWith
Index
Enumeration members
Enumeration members
COORDINATES
DISTANCE
HASH
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientEnumeration GeoReplyWith
Index
Enumeration members
Enumeration members
COORDINATES
DISTANCE
HASH
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ClientCommandOptions
Hierarchy
Index
Properties
Properties
Optional asap
Optional chain
Optional ignore
Optional isolated
Optional return
Optional signal
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ClientCommandOptions
Hierarchy
Index
Properties
Properties
Optional asap
Optional chain
Optional ignore
Optional isolated
Optional return
Optional signal
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClientOptions<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
Optional commands
Optional database
Optional isolation
Optional legacy
Optional modules
Optional name
Optional password
Optional readonly
Optional scripts
Optional socket
Optional url
Optional username
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClientOptions<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
Optional commands
Optional database
Optional isolation
Optional legacy
Optional modules
Optional name
Optional password
Optional readonly
Optional scripts
Optional socket
Optional url
Optional username
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface QueueCommandOptions
Hierarchy
Index
Properties
Properties
Optional asap
Optional chain
Optional ignore
Optional return
Optional signal
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface QueueCommandOptions
Hierarchy
Index
Properties
Properties
Optional asap
Optional chain
Optional ignore
Optional return
Optional signal
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisSocketCommonOptions
Hierarchy
Index
Properties
Methods
Properties
Optional connect
Optional keep
Optional no
Methods
Optional reconnect
Parameters
retries: number
Returns number | Error
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisSocketCommonOptions
Hierarchy
Index
Properties
Methods
Properties
Optional connect
Optional keep
Optional no
Methods
Optional reconnect
Parameters
retries: number
Returns number | Error
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisTlsSocketOptions
Hierarchy
Index
Properties
Methods
Properties
Optional ALPNProtocols
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisTlsSocketOptions
Hierarchy
Index
Properties
Methods
Properties
Optional ALPNProtocols
An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
-Optional SNICallback
Type declaration
Optional SNICallback
Type declaration
SNICallback(servername, cb) A function that will be
called if the client supports SNI TLS extension. Two arguments
will be passed when called: servername and cb. SNICallback should
@@ -9,11 +9,11 @@ invoke cb(null, ctx), where ctx is a SecureContext instance.
(tls.createSecureContext(...) can be used to get a proper
SecureContext.) If SNICallback wasn't provided the default callback
with high-level API will be used (see below).
-Parameters
servername: string
cb: (err: null | Error, ctx?: SecureContext) => void
Parameters
err: null | Error
Optional ctx: SecureContext
Returns void
Returns void
Optional ca
Parameters
servername: string
cb: (err: null | Error, ctx?: SecureContext) => void
Parameters
err: null | Error
Optional ctx: SecureContext
Returns void
Returns void
Optional ca
Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.
-Optional cert
Optional cert
Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM @@ -23,7 +23,7 @@ replaced when CAs are explicitly specified using this option.
be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail. -Optional check
Type declaration
Optional check
Type declaration
Verifies the certificate
certis issued tohostname.Returns Error object, populating it with
@@ -38,23 +38,23 @@ being issued by trusted CA (reason,host, andcerton failure. On success, returns undefined.options.ca).The host name or IP address to verify the certificate against.
cert: PeerCertificate
A
-certificate objectrepresenting the peer's certificate.Returns Error | undefined
Optional ciphers
Returns Error | undefined
Optional ciphers
Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.
-Optional client
Optional client
Name of an OpenSSL engine which can provide the client certificate.
-Optional connect
Optional crl
Optional connect
Optional crl
PEM formatted CRLs (Certificate Revocation Lists).
-Optional dhparam
Optional dhparam
Diffie Hellman parameters, required for Perfect Forward Secrecy. Use openssl dhparam to create the parameters. The key length must be greater than or equal to 1024 bits or else an error will be thrown. Although 1024 bits is permissible, use 2048 bits or larger for stronger security. If omitted or invalid, the parameters are silently discarded and DHE ciphers will not be available.
-Optional ecdh
Optional ecdh
A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use @@ -62,15 +62,15 @@ crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.
-Optional enable
Optional enable
When enabled, TLS packet trace information is written to
stderr. This can be used to debug TLS connection problems.false
-Optional honor
Optional honor
Attempt to use the server's cipher suite preferences instead of the client's. When true, causes SSL_OP_CIPHER_SERVER_PREFERENCE to be set in secureOptions
-Optional host
Optional keep
Optional key
Optional host
Optional keep
Optional key
Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be @@ -79,14 +79,14 @@ or an array of objects in the form {pem: <string|buffer>[, passphrase:]}. The object form can only occur in an array.
object.passphrase is optional. Encrypted keys will be decrypted with
object.passphrase if provided, or options.passphrase if it is not.
-Optional lookup
Optional max
Optional lookup
Optional max
Optionally set the maximum TLS version to allow. One of
-'TLSv1.3','TLSv1.2','TLSv1.1', or'TLSv1'. Cannot be specified along with thesecureProtocoloption, use one or the other. Default:'TLSv1.3', unless changed using CLI options. Using--tls-max-v1.2sets the default to'TLSv1.2'. Using--tls-max-v1.3sets the default to'TLSv1.3'. If multiple of the options are provided, the highest maximum is used.Optional minDHSize
Optional min
Optional minDHSize
Optional min
Optionally set the minimum TLS version to allow. One of
-'TLSv1.3','TLSv1.2','TLSv1.1', or'TLSv1'. Cannot be specified along with thesecureProtocoloption, use one or the other. It is not recommended to use @@ -95,9 +95,9 @@ less than TLSv1.2, but it may be required for interoperability.--tls-v1.0sets the default to'TLSv1'. Using--tls-v1.1sets the default to'TLSv1.1'. Using--tls-min-v1.3sets the default to 'TLSv1.3'. If multiple of the options are provided, the lowest minimum is used.Optional no
Optional passphrase
Optional no
Optional passphrase
Shared passphrase used for a single private key and/or a PFX.
-Optional path
Optional pfx
Optional path
Optional pfx
PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple @@ -106,29 +106,29 @@ or an array of objects in the form {buf: <string|buffer>[, passphrase:]}. The object form can only occur in an array.
object.passphrase is optional. Encrypted PFX will be decrypted with
object.passphrase if provided, or options.passphrase if it is not.
-Optional port
Optional private
Optional port
Optional private
Name of an OpenSSL engine to get private key from. Should be used together with privateKeyIdentifier.
-Optional private
Optional private
Identifier of a private key managed by an OpenSSL engine. Should be used together with privateKeyEngine. Should not be set together with key, because both options define a private key in different ways.
-Optional reject
Optional reject
If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.
true
-Optional request
Optional request
If true the server will request a certificate from clients that connect and attempt to verify that certificate. Defaults to false.
-Optional secure
Optional secure
An optional TLS context object from tls.createSecureContext()
-Optional secure
Optional secure
Optionally affect the OpenSSL protocol behavior, which is not usually necessary. This should be used carefully if at all! Value is a numeric bitmask of the SSL_OP_* options from OpenSSL Options
-Optional secure
Optional secure
Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use @@ -138,22 +138,22 @@ SSL_METHODS, use the function names as strings. For example, use any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.
-Optional servername
Optional session
Optional session
Optional servername
Optional session
Optional session
Opaque identifier used by servers to ensure session state is not shared between applications. Unused by clients.
-Optional session
Optional session
The number of seconds after which a TLS session created by the server will no longer be resumable. See Session Resumption for more information. Default: 300.
-Optional sigalgs
Optional sigalgs
Colon-separated list of supported signature algorithms. The list can contain digest algorithms (SHA256, MD5 etc.), public key algorithms (RSA-PSS, ECDSA etc.), combination of both (e.g 'RSA+SHA384') or TLS v1.3 scheme names (e.g. rsa_pss_pss_sha512).
-Optional socket
Optional ticket
Optional socket
Optional ticket
48-bytes of cryptographically strong pseudo-random data. See Session Resumption for more information.
-Optional timeout
tls
Methods
Optional psk
Optional timeout
tls
Methods
Optional psk
When negotiating TLS-PSK (pre-shared keys), this function is called with optional identity
hintprovided by the server ornullin case of TLS 1.3 wherehintwas removed. @@ -169,4 +169,4 @@ Alwaysnullif TLS 1.3 is used.Returns null | PSKCallbackNegotation
Return
-nullto stop the negotiation process.pskmust be compatible with the selected cipher's digest.identitymust use UTF-8 encoding.Optional reconnect
Parameters
retries: number
Returns number | Error
Generated using TypeDoc
Optional reconnect
Parameters
retries: number
Returns number | Error
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClusterOptions<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
Optional defaults
Optional max
Optional modules
root
Optional scripts
Optional use
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClusterOptions<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
Optional defaults
Optional max
Optional modules
root
Optional scripts
Optional use
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ClusterNode<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
client
id
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ClusterNode<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
client
id
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisCommand
Hierarchy
Index
Properties
Methods
Properties
Optional FIRST_
Optional IS_
Methods
transform
Parameters
Rest ...args: any[]
Returns RedisCommandArguments
Optional transform
Parameters
reply: any
Optional preserved: any
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisCommand
Hierarchy
Index
Properties
Methods
Properties
Optional FIRST_
Optional IS_
Methods
transform
Parameters
Rest ...args: any[]
Returns RedisCommandArguments
Optional transform
Parameters
reply: any
Optional preserved: any
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisPlugins<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
Optional modules
Optional scripts
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisPlugins<M, S>
Type parameters
M: RedisModules
S: RedisScripts
Hierarchy
Index
Properties
Properties
Optional modules
Optional scripts
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface AuthOptions
Hierarchy
Index
Properties
Properties
password
Optional username
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface AuthOptions
Hierarchy
Index
Properties
Properties
password
Optional username
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClusterMasterNode
Hierarchy
Index
Properties
Properties
config
cport
flags
host
id
link
ping
pong
port
replicas
slots
url
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClusterMasterNode
Hierarchy
Index
Properties
Properties
config
cport
flags
host
id
link
ping
pong
port
replicas
slots
url
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClusterReplicaNode
Hierarchy
Index
Properties
Properties
config
cport
flags
host
id
link
ping
pong
port
url
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisClusterReplicaNode
Hierarchy
Index
Properties
Properties
config
cport
flags
host
id
link
ping
pong
port
url
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface HScanTuple
Hierarchy
Index
Properties
Properties
field
value
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface HScanTuple
Hierarchy
Index
Properties
Properties
field
value
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface LPosOptions
Hierarchy
Index
Properties
Properties
Optional MAXLEN
Optional RANK
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface LPosOptions
Hierarchy
Index
Properties
Properties
Optional MAXLEN
Optional RANK
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ScanCommandOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Optional MATCH
Optional TYPE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ScanCommandOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Optional MATCH
Optional TYPE
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ScanReply
Hierarchy
Index
Properties
Properties
cursor
keys
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ScanReply
Hierarchy
Index
Properties
Properties
cursor
keys
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XAutoClaimOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XAutoClaimOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XClaimOptions
Hierarchy
Index
Properties
Properties
Optional FORCE
Optional IDLE
Optional RETRYCOUNT
Optional TIME
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XClaimOptions
Hierarchy
Index
Properties
Properties
Optional FORCE
Optional IDLE
Optional RETRYCOUNT
Optional TIME
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XReadGroupOptions
Hierarchy
Index
Properties
Properties
Optional BLOCK
Optional COUNT
Optional NOACK
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XReadGroupOptions
Hierarchy
Index
Properties
Properties
Optional BLOCK
Optional COUNT
Optional NOACK
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XReadGroupStream
Hierarchy
Index
Properties
Properties
id
key
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface XReadGroupStream
Hierarchy
Index
Properties
Properties
id
key
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ZRangeByLexOptions
Hierarchy
Index
Properties
Properties
Optional LIMIT
Type declaration
count: number
offset: number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ZRangeByLexOptions
Hierarchy
Index
Properties
Properties
Optional LIMIT
Type declaration
count: number
offset: number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ZRangeByScoreOptions
Hierarchy
Index
Properties
Properties
Optional LIMIT
Type declaration
count: number
offset: number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ZRangeByScoreOptions
Hierarchy
Index
Properties
Properties
Optional LIMIT
Type declaration
count: number
offset: number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface EvalOptions
Hierarchy
Index
Properties
Properties
Optional arguments
Optional keys
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface EvalOptions
Hierarchy
Index
Properties
Properties
Optional arguments
Optional keys
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface GeoCoordinates
Hierarchy
Index
Properties
Properties
latitude
longitude
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface GeoCoordinates
Hierarchy
Index
Properties
Properties
latitude
longitude
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface GeoReplyWithMember
Hierarchy
Index
Properties
Properties
Optional coordinates
Type declaration
latitude: string
longitude: string
Optional distance
Optional hash
member
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface GeoReplyWithMember
Hierarchy
Index
Properties
Properties
Optional coordinates
Type declaration
latitude: string
longitude: string
Optional distance
Optional hash
member
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface GeoSearchOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Optional SORT
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface GeoSearchOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Optional SORT
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ScanOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Optional MATCH
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ScanOptions
Hierarchy
Index
Properties
Properties
Optional COUNT
Optional MATCH
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface StreamMessageReply
Hierarchy
Index
Properties
Properties
id
message
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface StreamMessageReply
Hierarchy
Index
Properties
Properties
id
message
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ZMember
Hierarchy
Index
Properties
Properties
score
value
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface ZMember
Hierarchy
Index
Properties
Properties
score
value
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisScriptConfig
Hierarchy
Index
Properties
Methods
Properties
Optional FIRST_
Optional IS_
NUMBER_
SCRIPT
Methods
transform
Parameters
Rest ...args: any[]
Returns RedisCommandArguments
Optional transform
Parameters
reply: any
Optional preserved: any
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisScriptConfig
Hierarchy
Index
Properties
Methods
Properties
Optional FIRST_
Optional IS_
NUMBER_
SCRIPT
Methods
transform
Parameters
Rest ...args: any[]
Returns RedisCommandArguments
Optional transform
Parameters
reply: any
Optional preserved: any
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface SHA1
Hierarchy
Index
Properties
Properties
SHA1
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface SHA1
Hierarchy
Index
Properties
Properties
SHA1
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisMultiQueuedCommand
Hierarchy
Index
Properties
Properties
args
Optional transform
Type declaration
Parameters
reply: any
Optional preserved: any
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientInterface RedisMultiQueuedCommand
Hierarchy
Index
Properties
Properties
args
Optional transform
Type declaration
Parameters
reply: any
Optional preserved: any
Returns any
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule index
Index
References
Functions
References
Abort
Re-exports AbortErrorAuth
Re-exports AuthErrorClient
Re-exports ClientClosedErrorConnection
Re-exports ConnectionTimeoutErrorDisconnects
Re-exports DisconnectsClientErrorRedis
Re-exports RedisClientOptionsRedis
Re-exports RedisClientTypeRedis
Re-exports RedisClusterOptionsRedis
Re-exports RedisClusterTypeRedis
Re-exports RedisModulesRedis
Re-exports RedisScriptsSocket
Re-exports SocketClosedUnexpectedlyErrorWatch
Re-exports WatchErrordefine
Re-exports defineScriptFunctions
Const command
Type parameters
T: ClientCommandOptions
Parameters
options: T
Returns CommandOptions<T>
Const create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClientOptions<M, S>
Returns RedisClientType<M, S>
Const create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClusterOptions<M, S>
Returns RedisClusterType<M, S>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule index
Index
References
Functions
References
Abort
Re-exports AbortErrorAuth
Re-exports AuthErrorClient
Re-exports ClientClosedErrorConnection
Re-exports ConnectionTimeoutErrorDisconnects
Re-exports DisconnectsClientErrorRedis
Re-exports RedisClientOptionsRedis
Re-exports RedisClientTypeRedis
Re-exports RedisClusterOptionsRedis
Re-exports RedisClusterTypeRedis
Re-exports RedisModulesRedis
Re-exports RedisScriptsSocket
Re-exports SocketClosedUnexpectedlyErrorWatch
Re-exports WatchErrordefine
Re-exports defineScriptFunctions
Const command
Type parameters
T: ClientCommandOptions
Parameters
options: T
Returns CommandOptions<T>
Const create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClientOptions<M, S>
Returns RedisClientType<M, S>
Const create
Type parameters
M: RedisModules
S: RedisScripts
Parameters
Optional options: RedisClusterOptions<M, S>
Returns RedisClusterType<M, S>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client
Index
Classes
Interfaces
Type aliases
Type aliases
Client
Exclude
Type parameters
S
Instantiable
Type parameters
M: RedisModules
S: RedisScripts
Type declaration
Parameters
Optional options: RedisClientOptions<M, S>
Returns RedisClientType<M, S>
Redis
Type parameters
Command: RedisCommand
Params: unknown[] = Parameters<Command["transformArguments"]>
Type declaration
Type parameters
Options: CommandOptions<ClientCommandOptions>
Parameters
Rest ...args: Params | [options: Options, rest: Params]
Returns Promise<ConvertArgumentType<RedisCommandReply<Command>, Options["returnBuffers"] extends true ? Buffer : string>>
Redis
Type parameters
M: RedisModules
S: RedisScripts
With
Type parameters
M: RedisModules
With
Type parameters
S: RedisScripts
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client
Index
Classes
Interfaces
Type aliases
Type aliases
Client
Exclude
Type parameters
S
Instantiable
Type parameters
M: RedisModules
S: RedisScripts
Type declaration
Parameters
Optional options: RedisClientOptions<M, S>
Returns RedisClientType<M, S>
Redis
Type parameters
Command: RedisCommand
Params: unknown[] = Parameters<Command["transformArguments"]>
Type declaration
Type parameters
Options: CommandOptions<ClientCommandOptions>
Parameters
Rest ...args: Params | [options: Options, rest: Params]
Returns Promise<ConvertArgumentType<RedisCommandReply<Command>, Options["returnBuffers"] extends true ? Buffer : string>>
Redis
Type parameters
M: RedisModules
S: RedisScripts
With
Type parameters
M: RedisModules
With
Type parameters
S: RedisScripts
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client/commands-queue
Index
Enumerations
Classes
Interfaces
Type aliases
Type aliases
Pub
Type parameters
RETURN_BUFFERS: boolean = false
T = RETURN_BUFFERS extends true ? Buffer : string
Type declaration
Parameters
message: T
channel: T
Returns unknown
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client/commands-queue
Index
Enumerations
Classes
Interfaces
Type aliases
Type aliases
Pub
Type parameters
RETURN_BUFFERS: boolean = false
T = RETURN_BUFFERS extends true ? Buffer : string
Type declaration
Parameters
message: T
channel: T
Returns unknown
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client/multi-command
Index
Classes
Type aliases
Type aliases
Redis
Type parameters
M: RedisModules
S: RedisScripts
Redis
Type declaration
Parameters
queue: RedisMultiQueuedCommand[]
Optional chainId: symbol
Returns Promise<RedisCommandRawReply[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client/multi-command
Index
Classes
Type aliases
Type aliases
Redis
Type parameters
M: RedisModules
S: RedisScripts
Redis
Type declaration
Parameters
queue: RedisMultiQueuedCommand[]
Optional chainId: symbol
Returns Promise<RedisCommandRawReply[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client/socket
Index
Classes
Interfaces
Type aliases
Type aliases
Redis
Redis
Type declaration
Returns Promise<void>
Redis
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/client/socket
Index
Classes
Interfaces
Type aliases
Type aliases
Redis
Redis
Type declaration
Returns Promise<void>
Redis
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/cluster
Index
Classes
Interfaces
Type aliases
Type aliases
Redis
Redis
Type parameters
M: RedisModules
S: RedisScripts
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/cluster
Index
Classes
Interfaces
Type aliases
Type aliases
Redis
Redis
Type parameters
M: RedisModules
S: RedisScripts
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/cluster/multi-command
Index
Classes
Type aliases
Type aliases
Redis
Type parameters
M: RedisModules
S: RedisScripts
Redis
Type declaration
Parameters
queue: RedisMultiQueuedCommand[]
Optional firstKey: RedisCommandArgument
Optional chainId: symbol
Returns Promise<RedisCommandRawReply[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/cluster/multi-command
Index
Classes
Type aliases
Type aliases
Redis
Type parameters
M: RedisModules
S: RedisScripts
Redis
Type declaration
Parameters
queue: RedisMultiQueuedCommand[]
Optional firstKey: RedisCommandArgument
Optional chainId: symbol
Returns Promise<RedisCommandRawReply[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/command-options
Index
Type aliases
Functions
Type aliases
Command
Type parameters
T
Functions
command
Type parameters
T
Parameters
options: T
Returns CommandOptions<T>
is
Type parameters
T
Parameters
options: any
Returns options is CommandOptions<T>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/command-options
Index
Type aliases
Functions
Type aliases
Command
Type parameters
T
Functions
command
Type parameters
T
Parameters
options: T
Returns CommandOptions<T>
is
Type parameters
T
Parameters
options: any
Returns options is CommandOptions<T>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commander
Index
Type aliases
Functions
Type aliases
Legacy
Functions
encode
Parameters
args: RedisCommandArguments
Returns IterableIterator<RedisCommandArgument>
extend
Type parameters
T: Instantiable<any>
Parameters
__namedParameters: ExtendWithCommandsConfig<T>
Returns void
extend
Type parameters
T: Instantiable<any>
Parameters
config: ExtendWithModulesAndScriptsConfig<T>
Returns T
transform
Type parameters
T
Parameters
command: RedisCommand
args: unknown[]
Returns { args: RedisCommandArguments; options: CommandOptions<T> | undefined }
args: RedisCommandArguments
options: CommandOptions<T> | undefined
transform
Parameters
command: RedisCommand
rawReply: RedisCommandRawReply
preserved: unknown
Returns RedisCommandReply<typeof command>
transform
Parameters
args: LegacyCommandArguments
flat: RedisCommandArguments = []
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commander
Index
Type aliases
Functions
Type aliases
Legacy
Functions
encode
Parameters
args: RedisCommandArguments
Returns IterableIterator<RedisCommandArgument>
extend
Type parameters
T: Instantiable<any>
Parameters
__namedParameters: ExtendWithCommandsConfig<T>
Returns void
extend
Type parameters
T: Instantiable<any>
Parameters
config: ExtendWithModulesAndScriptsConfig<T>
Returns T
transform
Type parameters
T
Parameters
command: RedisCommand
args: unknown[]
Returns { args: RedisCommandArguments; options: CommandOptions<T> | undefined }
args: RedisCommandArguments
options: CommandOptions<T> | undefined
transform
Parameters
command: RedisCommand
rawReply: RedisCommandRawReply
preserved: unknown
Returns RedisCommandReply<typeof command>
transform
Parameters
args: LegacyCommandArguments
flat: RedisCommandArguments = []
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands
Index
Interfaces
Type aliases
Type aliases
Redis
Redis
Redis
Redis
Type parameters
C: RedisCommand
Redis
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands
Index
Interfaces
Type aliases
Type aliases
Redis
Redis
Redis
Redis
Type parameters
C: RedisCommand
Redis
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_CAT
Index
Functions
Functions
transform
Parameters
Optional categoryName: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_CAT
Index
Functions
Functions
transform
Parameters
Optional categoryName: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_DELUSER
Index
Functions
Functions
transform
Parameters
username: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_DELUSER
Index
Functions
Functions
transform
Parameters
username: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_GENPASS
Index
Functions
Functions
transform
Parameters
Optional bits: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_GENPASS
Index
Functions
Functions
transform
Parameters
Optional bits: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_GETUSER
Index
Functions
Functions
transform
Parameters
username: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
reply: AclGetUserRawReply
Returns AclUser
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_GETUSER
Index
Functions
Functions
transform
Parameters
username: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
reply: AclGetUserRawReply
Returns AclUser
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LIST
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LIST
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LOAD
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LOAD
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LOG
Index
Functions
Functions
transform
Parameters
Optional count: number
Returns RedisCommandArguments
transform
Parameters
reply: AclLogRawReply[]
Returns AclLog[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LOG
Index
Functions
Functions
transform
Parameters
Optional count: number
Returns RedisCommandArguments
transform
Parameters
reply: AclLogRawReply[]
Returns AclLog[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LOG_RESET
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_LOG_RESET
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_SAVE
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_SAVE
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_SETUSER
Index
Functions
Functions
transform
Parameters
username: RedisCommandArgument
rule: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_SETUSER
Index
Functions
Functions
transform
Parameters
username: RedisCommandArgument
rule: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_USERS
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_USERS
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_WHOAMI
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ACL_WHOAMI
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/APPEND
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/APPEND
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ASKING
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ASKING
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/AUTH
Index
Interfaces
Functions
Functions
transform
Parameters
__namedParameters: AuthOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/AUTH
Index
Interfaces
Functions
Functions
transform
Parameters
__namedParameters: AuthOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BGREWRITEAOF
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BGREWRITEAOF
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BGSAVE
Index
Functions
Functions
transform
Parameters
Optional options: BgSaveOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BGSAVE
Index
Functions
Functions
transform
Parameters
Optional options: BgSaveOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITCOUNT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Optional range: BitCountRange
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITCOUNT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Optional range: BitCountRange
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITFIELD
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
operations: BitFieldOperations
Returns string[]
transform
Returns (number | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITFIELD
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
operations: BitFieldOperations
Returns string[]
transform
Returns (number | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
operation: BitOperations
destKey: RedisCommandArgument
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
operation: BitOperations
destKey: RedisCommandArgument
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITPOS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
bit: BitValue
Optional start: number
Optional end: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BITPOS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
bit: BitValue
Optional start: number
Optional end: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BLMOVE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
sourceDirection: LMoveSide
destinationDirection: LMoveSide
timeout: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BLMOVE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
sourceDirection: LMoveSide
destinationDirection: LMoveSide
timeout: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BLPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
transform
Parameters
reply: BLPopRawReply
Returns BLPopReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BLPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
transform
Parameters
reply: BLPopRawReply
Returns BLPopReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BRPOP
Index
References
Variables
Functions
References
transform
Re-exports transformReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BRPOP
Index
References
Variables
Functions
References
transform
Re-exports transformReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BRPOPLPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
timeout: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BRPOPLPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
timeout: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BZPOPMAX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
transform
Parameters
reply: ZMemberRawReply
Returns BZPopMaxReply | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BZPOPMAX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
transform
Parameters
reply: ZMemberRawReply
Returns BZPopMaxReply | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BZPOPMIN
Index
References
Variables
Functions
References
transform
Re-exports transformReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/BZPOPMIN
Index
References
Variables
Functions
References
transform
Re-exports transformReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
timeout: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_CACHING
Index
Functions
Functions
transform
Parameters
value: boolean
Returns RedisCommandArguments
transform
Returns "OK" | Buffer
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_CACHING
Index
Functions
Functions
transform
Parameters
value: boolean
Returns RedisCommandArguments
transform
Returns "OK" | Buffer
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_GETNAME
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns string | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_GETNAME
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns string | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_GETREDIR
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_GETREDIR
Index
Functions
Functions
transform
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_ID
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_ID
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_INFO
Index
Functions
Functions
transform
Returns string[]
transform
Parameters
reply: string
Returns ClientInfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_INFO
Index
Functions
Functions
transform
Returns string[]
transform
Parameters
reply: string
Returns ClientInfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_KILL
Index
Enumerations
Functions
Functions
transform
Parameters
filters: KillFilters | KillFilters[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_KILL
Index
Enumerations
Functions
Functions
transform
Parameters
filters: KillFilters | KillFilters[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_SETNAME
Index
Functions
Functions
transform
Parameters
name: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLIENT_SETNAME
Index
Functions
Functions
transform
Parameters
name: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_ADDSLOTS
Index
Functions
Functions
transform
Parameters
slots: number | number[]
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_ADDSLOTS
Index
Functions
Functions
transform
Parameters
slots: number | number[]
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_FLUSHSLOTS
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_FLUSHSLOTS
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_GETKEYSINSLOT
Index
Functions
Functions
transform
Parameters
slot: number
count: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_GETKEYSINSLOT
Index
Functions
Functions
transform
Parameters
slot: number
count: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_INFO
Index
Functions
Functions
extract
Parameters
line: string
Returns string
transform
Returns string[]
transform
Parameters
reply: string
Returns ClusterInfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_INFO
Index
Functions
Functions
extract
Parameters
line: string
Returns string
transform
Returns string[]
transform
Parameters
reply: string
Returns ClusterInfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_MEET
Index
Functions
Functions
transform
Parameters
ip: string
port: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_MEET
Index
Functions
Functions
transform
Parameters
ip: string
port: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_NODES
Index
Enumerations
Interfaces
Functions
Functions
transform
Returns string[]
transform
Parameters
reply: string
Returns RedisClusterMasterNode[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_NODES
Index
Enumerations
Interfaces
Functions
Functions
transform
Returns string[]
transform
Parameters
reply: string
Returns RedisClusterMasterNode[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_RESET
Index
Type aliases
Functions
Type aliases
Cluster
Functions
transform
Parameters
Optional mode: ClusterResetModes
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_RESET
Index
Type aliases
Functions
Type aliases
Cluster
Functions
transform
Parameters
Optional mode: ClusterResetModes
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_SETSLOT
Index
Enumerations
Functions
Functions
transform
Parameters
slot: number
state: ClusterSlotStates
Optional nodeId: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_SETSLOT
Index
Enumerations
Functions
Functions
transform
Parameters
slot: number
state: ClusterSlotStates
Optional nodeId: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_SLOTS
Index
Type aliases
Functions
Type aliases
Cluster
Functions
transform
Returns RedisCommandArguments
transform
Parameters
reply: ClusterSlotsRawReply
Returns ClusterSlotsReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CLUSTER_SLOTS
Index
Type aliases
Functions
Type aliases
Cluster
Functions
transform
Returns RedisCommandArguments
transform
Parameters
reply: ClusterSlotsRawReply
Returns ClusterSlotsReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns RedisCommandArguments
transform
Parameters
reply: CommandRawReply[]
Returns CommandReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns RedisCommandArguments
transform
Parameters
reply: CommandRawReply[]
Returns CommandReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND_COUNT
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND_COUNT
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND_GETKEYS
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
args: RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND_GETKEYS
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
args: RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND_INFO
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
commands: string[]
Returns RedisCommandArguments
transform
Parameters
reply: (null | CommandRawReply)[]
Returns (CommandReply | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COMMAND_INFO
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
commands: string[]
Returns RedisCommandArguments
transform
Parameters
reply: (null | CommandRawReply)[]
Returns (CommandReply | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_GET
Index
References
Functions
References
transform
Renames and re-exports transformTuplesReplyFunctions
transform
Parameters
parameter: string
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_GET
Index
References
Functions
References
transform
Renames and re-exports transformTuplesReplyFunctions
transform
Parameters
parameter: string
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_RESETSTAT
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_RESETSTAT
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_REWRITE
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_REWRITE
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_SET
Index
Functions
Functions
transform
Parameters
parameter: string
value: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/CONFIG_SET
Index
Functions
Functions
transform
Parameters
parameter: string
value: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COPY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
Optional options: CopyCommandOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/COPY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
Optional options: CopyCommandOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DBSIZE
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DBSIZE
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DECR
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DECR
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DECRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
decrement: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DECRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
decrement: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DEL
Index
Functions
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DEL
Index
Functions
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DISCARD
Index
Functions
Functions
transform
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DISCARD
Index
Functions
Functions
transform
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DUMP
Index
Functions
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/DUMP
Index
Functions
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ECHO
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
message: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ECHO
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
message: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EVAL
Index
Functions
Functions
transform
Parameters
script: string
Optional options: EvalOptions
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EVAL
Index
Functions
Functions
transform
Parameters
script: string
Optional options: EvalOptions
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EVALSHA
Index
Functions
Functions
transform
Parameters
sha1: string
Optional options: EvalOptions
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EVALSHA
Index
Functions
Functions
transform
Parameters
sha1: string
Optional options: EvalOptions
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EXISTS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EXISTS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EXPIRE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
seconds: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EXPIRE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
seconds: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EXPIREAT
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
timestamp: number | Date
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/EXPIREAT
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
timestamp: number | Date
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/FAILOVER
Index
Functions
Functions
transform
Parameters
Optional options: FailoverOptions
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/FAILOVER
Index
Functions
Functions
transform
Parameters
Optional options: FailoverOptions
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/FLUSHALL
Index
Enumerations
Functions
Functions
transform
Parameters
Optional mode: RedisFlushModes
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/FLUSHALL
Index
Enumerations
Functions
Functions
transform
Parameters
Optional mode: RedisFlushModes
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/FLUSHDB
Index
Functions
Functions
transform
Parameters
Optional mode: RedisFlushModes
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/FLUSHDB
Index
Functions
Functions
transform
Parameters
Optional mode: RedisFlushModes
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
toAdd: GeoMember | GeoMember[]
Optional options: GeoAddOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
toAdd: GeoMember | GeoMember[]
Optional options: GeoAddOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEODIST
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member1: RedisCommandArgument
member2: RedisCommandArgument
Optional unit: GeoUnits
Returns RedisCommandArguments
transform
Parameters
reply: null | RedisCommandArgument
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEODIST
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member1: RedisCommandArgument
member2: RedisCommandArgument
Optional unit: GeoUnits
Returns RedisCommandArguments
transform
Parameters
reply: null | RedisCommandArgument
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOHASH
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOHASH
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOPOS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Parameters
reply: GeoCoordinatesRawReply
Returns (GeoCoordinates | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOPOS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Parameters
reply: GeoCoordinatesRawReply
Returns (GeoCoordinates | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOSEARCH
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
Optional options: GeoSearchOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOSEARCH
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
Optional options: GeoSearchOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOSEARCHSTORE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
destination: RedisCommandArgument
source: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
Optional options: GeoSearchStoreOptions
Returns RedisCommandArguments
transform
Parameters
reply: number
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOSEARCHSTORE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
destination: RedisCommandArgument
source: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
Optional options: GeoSearchStoreOptions
Returns RedisCommandArguments
transform
Parameters
reply: number
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOSEARCH_WITH
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformGeoMembersWithReplyFunctions
transform
Parameters
key: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
replyWith: GeoReplyWith[]
Optional options: GeoSearchOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GEOSEARCH_WITH
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformGeoMembersWithReplyFunctions
transform
Parameters
key: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
replyWith: GeoReplyWith[]
Optional options: GeoSearchOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETBIT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
offset: number
Returns RedisCommandArguments
transform
Returns BitValue
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETBIT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
offset: number
Returns RedisCommandArguments
transform
Returns BitValue
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETDEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETDEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
mode: GetExModes
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
mode: GetExModes
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
end: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
end: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETSET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/GETSET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HDEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HDEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HELLO
Index
Functions
Functions
transform
Parameters
Optional options: HelloOptions
Returns RedisCommandArguments
transform
Parameters
reply: HelloRawReply
Returns HelloTransformedReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HELLO
Index
Functions
Functions
transform
Parameters
Optional options: HelloOptions
Returns RedisCommandArguments
transform
Parameters
reply: HelloRawReply
Returns HelloTransformedReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HEXISTS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HEXISTS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HGET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | undefined
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HGET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | undefined
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HGETALL
Index
References
Variables
Functions
References
transform
Renames and re-exports transformTuplesReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HGETALL
Index
References
Variables
Functions
References
transform
Renames and re-exports transformTuplesReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HINCRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HINCRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HINCRBYFLOAT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HINCRBYFLOAT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HKEYS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HKEYS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HLEN
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HLEN
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HMGET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
fields: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HMGET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
fields: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HRANDFIELD
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HRANDFIELD
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HRANDFIELD_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HRANDFIELD_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HRANDFIELD_COUNT_WITHVALUES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformTuplesReplyFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HRANDFIELD_COUNT_WITHVALUES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformTuplesReplyFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSCAN
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: HScanRawReply
Returns HScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSCAN
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: HScanRawReply
Returns HScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
Rest ...__namedParameters: [key: RedisCommandArgument, field: Types, value: Types] | [key: RedisCommandArgument, value: HSETObject | HSETMap | HSETTuples]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
Rest ...__namedParameters: [key: RedisCommandArgument, field: Types, value: Types] | [key: RedisCommandArgument, value: HSETObject | HSETMap | HSETTuples]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSETNX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSETNX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSTRLEN
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HSTRLEN
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
field: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HVALS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/HVALS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INCR
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INCR
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INCRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INCRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INCRBYFLOAT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INCRBYFLOAT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
increment: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INFO
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional section: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/INFO
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional section: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/KEYS
Index
Functions
Functions
transform
Parameters
pattern: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/KEYS
Index
Functions
Functions
transform
Parameters
pattern: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LASTSAVE
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Parameters
reply: number
Returns Date
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LASTSAVE
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Parameters
reply: number
Returns Date
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LINDEX
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
key: RedisCommandArgument
index: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LINDEX
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
key: RedisCommandArgument
index: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LINSERT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
position: LInsertPosition
pivot: RedisCommandArgument
element: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LINSERT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
position: LInsertPosition
pivot: RedisCommandArgument
element: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LMOVE
Index
Type aliases
Variables
Functions
Type aliases
LMove
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
sourceSide: LMoveSide
destinationSide: LMoveSide
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LMOVE
Index
Type aliases
Variables
Functions
Type aliases
LMove
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
sourceSide: LMoveSide
destinationSide: LMoveSide
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LOLWUT
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional version: number
Rest ...optionalArguments: number[]
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LOLWUT
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional version: number
Rest ...optionalArguments: number[]
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOP_COUNT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOP_COUNT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOS
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument
Optional options: LPosOptions
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOS
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument
Optional options: LPosOptions
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOS_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument
count: number
Optional options: LPosOptions
Returns RedisCommandArguments
transform
Returns number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPOS_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument
count: number
Optional options: LPosOptions
Returns RedisCommandArguments
transform
Returns number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
elements: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
elements: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPUSHX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LPUSHX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
stop: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
stop: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LREM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
count: number
element: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LREM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
count: number
element: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LSET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
index: number
element: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LSET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
index: number
element: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LTRIM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
stop: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/LTRIM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
stop: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_DOCTOR
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_DOCTOR
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_MALLOC-STATS
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_MALLOC-STATS
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_PURGE
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_PURGE
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_STATS
Index
Functions
Functions
transform
Returns string[]
transform
Parameters
rawReply: (string | number | (string | number)[])[]
Returns MemoryStatsReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_STATS
Index
Functions
Functions
transform
Returns string[]
transform
Parameters
rawReply: (string | number | (string | number)[])[]
Returns MemoryStatsReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_USAGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional options: MemoryUsageOptions
Returns string[]
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MEMORY_USAGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional options: MemoryUsageOptions
Returns string[]
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MGET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns (RedisCommandArgument | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MGET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns (RedisCommandArgument | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MIGRATE
Index
Functions
Functions
transform
Parameters
host: RedisCommandArgument
port: number
key: RedisCommandArgument | RedisCommandArgument[]
destinationDb: number
timeout: number
Optional options: MigrateOptions
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MIGRATE
Index
Functions
Functions
transform
Parameters
host: RedisCommandArgument
port: number
key: RedisCommandArgument | RedisCommandArgument[]
destinationDb: number
timeout: number
Optional options: MigrateOptions
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MODULE_LIST
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MODULE_LIST
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MODULE_LOAD
Index
Functions
Functions
transform
Parameters
path: string
Optional moduleArgs: string[]
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MODULE_LOAD
Index
Functions
Functions
transform
Parameters
path: string
Optional moduleArgs: string[]
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MODULE_UNLOAD
Index
Functions
Functions
transform
Parameters
name: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MODULE_UNLOAD
Index
Functions
Functions
transform
Parameters
name: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MOVE
Index
References
Functions
References
transform
Renames and re-exports transformBooleanReplyFunctions
transform
Parameters
key: string
db: number
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MOVE
Index
References
Functions
References
transform
Renames and re-exports transformBooleanReplyFunctions
transform
Parameters
key: string
db: number
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MSET
Index
Type aliases
Variables
Functions
Type aliases
MSet
Variables
FIRST_
Functions
transform
Parameters
toSet: MSetArguments
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MSET
Index
Type aliases
Variables
Functions
Type aliases
MSet
Variables
FIRST_
Functions
transform
Parameters
toSet: MSetArguments
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MSETNX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
toSet: MSetArguments
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/MSETNX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
toSet: MSetArguments
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PERSIST
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PERSIST
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PEXPIRE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
milliseconds: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PEXPIRE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
milliseconds: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PEXPIREAT
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
millisecondsTimestamp: number | Date
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PEXPIREAT
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
millisecondsTimestamp: number | Date
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PFADD
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PFADD
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PFCOUNT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PFCOUNT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PFMERGE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: string
source: string | string[]
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PFMERGE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: string
source: string | string[]
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PING
Index
Functions
Functions
transform
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PING
Index
Functions
Functions
transform
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PSETEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
milliseconds: number
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PSETEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
milliseconds: number
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PTTL
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PTTL
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBLISH
Index
Functions
Functions
transform
Parameters
channel: RedisCommandArgument
message: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBLISH
Index
Functions
Functions
transform
Parameters
channel: RedisCommandArgument
message: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBSUB_CHANNELS
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional pattern: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBSUB_CHANNELS
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional pattern: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBSUB_NUMPAT
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBSUB_NUMPAT
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBSUB_NUMSUB
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional channels: string | string[]
Returns string[]
transform
Parameters
rawReply: (string | number)[]
Returns Record<string, number>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/PUBSUB_NUMSUB
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
Optional channels: string | string[]
Returns string[]
transform
Parameters
rawReply: (string | number)[]
Returns Record<string, number>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RANDOMKEY
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RANDOMKEY
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/READONLY
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/READONLY
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/READWRITE
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/READWRITE
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RENAME
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
newKey: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RENAME
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
newKey: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RENAMENX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
newKey: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RENAMENX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
newKey: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/REPLICAOF
Index
Functions
Functions
transform
Parameters
host: string
port: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/REPLICAOF
Index
Functions
Functions
transform
Parameters
host: string
port: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RESTORE-ASKING
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RESTORE-ASKING
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ROLE
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Parameters
reply: RoleRawReply
Returns RoleReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ROLE
Index
Variables
Functions
Variables
IS_
Functions
transform
Returns string[]
transform
Parameters
reply: RoleRawReply
Returns RoleReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPOPLPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPOPLPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPOP_COUNT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPOP_COUNT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPUSH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPUSHX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/RPUSHX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
element: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SAVE
Index
Functions
Functions
transform
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SAVE
Index
Functions
Functions
transform
Returns string[]
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCAN
Index
Interfaces
Variables
Functions
Variables
IS_
Functions
transform
Parameters
cursor: number
Optional options: ScanCommandOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: ScanRawReply
Returns ScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCAN
Index
Interfaces
Variables
Functions
Variables
IS_
Functions
transform
Parameters
cursor: number
Optional options: ScanCommandOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: ScanRawReply
Returns ScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCARD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCARD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_DEBUG
Index
Functions
Functions
transform
Parameters
mode: "YES" | "SYNC" | "NO"
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_DEBUG
Index
Functions
Functions
transform
Parameters
mode: "YES" | "SYNC" | "NO"
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_EXISTS
Index
References
Functions
References
transform
Renames and re-exports transformBooleanArrayReplyFunctions
transform
Parameters
sha1: string | string[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_EXISTS
Index
References
Functions
References
transform
Renames and re-exports transformBooleanArrayReplyFunctions
transform
Parameters
sha1: string | string[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_FLUSH
Index
Functions
Functions
transform
Parameters
Optional mode: "SYNC" | "ASYNC"
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_FLUSH
Index
Functions
Functions
transform
Parameters
Optional mode: "SYNC" | "ASYNC"
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_KILL
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_KILL
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_LOAD
Index
Functions
Functions
transform
Parameters
script: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SCRIPT_LOAD
Index
Functions
Functions
transform
Parameters
script: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SDIFF
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SDIFF
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SDIFFSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SDIFFSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: number | RedisCommandArgument
Optional options: SetOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: number | RedisCommandArgument
Optional options: SetOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETBIT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
offset: number
value: BitValue
Returns RedisCommandArguments
transform
Returns BitValue
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETBIT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
offset: number
value: BitValue
Returns RedisCommandArguments
transform
Returns BitValue
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
seconds: number
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
seconds: number
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETNX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETNX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
value: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETRANGE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
offset: number
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SETRANGE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
offset: number
value: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SHUTDOWN
Index
Functions
Functions
transform
Parameters
Optional mode: "SAVE" | "NOSAVE"
Returns string[]
transform
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SHUTDOWN
Index
Functions
Functions
transform
Parameters
Optional mode: "SAVE" | "NOSAVE"
Returns string[]
transform
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SINTER
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SINTER
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SINTERSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SINTERSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SISMEMBER
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SISMEMBER
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SMEMBERS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SMEMBERS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SMISMEMBER
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanArrayReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SMISMEMBER
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanArrayReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SMOVE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SMOVE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
source: RedisCommandArgument
destination: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SORT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional options: SortOptions
Returns string[]
transform
Parameters
reply: number | string[]
Returns string[] | number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SORT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional options: SortOptions
Returns string[]
transform
Parameters
reply: number | string[]
Returns string[] | number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Optional count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Optional count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SRANDMEMBER
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SRANDMEMBER
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SRANDMEMBER_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SRANDMEMBER_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SREM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SREM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SSCAN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: SScanRawReply
Returns SScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SSCAN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: SScanRawReply
Returns SScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/STRLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/STRLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SUNION
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SUNION
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SUNIONSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SUNIONSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SWAPDB
Index
Functions
Functions
transform
Parameters
index1: number
index2: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/SWAPDB
Index
Functions
Functions
transform
Parameters
index1: number
index2: number
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TIME
Index
Functions
Functions
transform
Returns string[]
transform
Parameters
reply: [string, string]
Returns TimeReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TIME
Index
Functions
Functions
transform
Returns string[]
transform
Parameters
reply: [string, string]
Returns TimeReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TOUCH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TOUCH
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TTL
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TTL
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TYPE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/TYPE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/UNLINK
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/UNLINK
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/UNWATCH
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/UNWATCH
Index
Functions
Functions
transform
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/WAIT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
numberOfReplicas: number
timeout: number
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/WAIT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
numberOfReplicas: number
timeout: number
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/WATCH
Index
Functions
Functions
transform
Parameters
key: string | string[]
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/WATCH
Index
Functions
Functions
transform
Parameters
key: string | string[]
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XACK
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
id: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XACK
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
id: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
id: RedisCommandArgument
message: Record<string, RedisCommandArgument>
Optional options: XAddOptions
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
id: RedisCommandArgument
message: Record<string, RedisCommandArgument>
Optional options: XAddOptions
Returns RedisCommandArguments
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XAUTOCLAIM
Index
Interfaces
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
minIdleTime: number
start: string
Optional options: XAutoClaimOptions
Returns RedisCommandArguments
transform
Parameters
reply: XAutoClaimRawReply
Returns XAutoClaimReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XAUTOCLAIM
Index
Interfaces
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
minIdleTime: number
start: string
Optional options: XAutoClaimOptions
Returns RedisCommandArguments
transform
Parameters
reply: XAutoClaimRawReply
Returns XAutoClaimReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XAUTOCLAIM_JUSTID
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, group: RedisCommandArgument, consumer: RedisCommandArgument, minIdleTime: number, start: string, options?: XAutoClaimOptions]
Returns RedisCommandArguments
transform
Parameters
reply: XAutoClaimJustIdRawReply
Returns XAutoClaimJustIdReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XAUTOCLAIM_JUSTID
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, group: RedisCommandArgument, consumer: RedisCommandArgument, minIdleTime: number, start: string, options?: XAutoClaimOptions]
Returns RedisCommandArguments
transform
Parameters
reply: XAutoClaimJustIdRawReply
Returns XAutoClaimJustIdReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XCLAIM
Index
References
Interfaces
Variables
Functions
References
transform
Renames and re-exports transformStreamMessagesReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
minIdleTime: number
id: RedisCommandArgument | RedisCommandArgument[]
Optional options: XClaimOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XCLAIM
Index
References
Interfaces
Variables
Functions
References
transform
Renames and re-exports transformStreamMessagesReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
minIdleTime: number
id: RedisCommandArgument | RedisCommandArgument[]
Optional options: XClaimOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XCLAIM_JUSTID
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, group: RedisCommandArgument, consumer: RedisCommandArgument, minIdleTime: number, id: RedisCommandArgument | RedisCommandArgument[], options?: XClaimOptions]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XCLAIM_JUSTID
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, group: RedisCommandArgument, consumer: RedisCommandArgument, minIdleTime: number, id: RedisCommandArgument | RedisCommandArgument[], options?: XClaimOptions]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XDEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
id: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XDEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
id: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_CREATE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
id: RedisCommandArgument
Optional options: XGroupCreateOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_CREATE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
id: RedisCommandArgument
Optional options: XGroupCreateOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_CREATECONSUMER
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_CREATECONSUMER
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_DELCONSUMER
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_DELCONSUMER
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
consumer: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_DESTROY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_DESTROY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformBooleanReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_SETID
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
id: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XGROUP_SETID
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
id: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XINFO_CONSUMERS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
rawReply: any[]
Returns XInfoConsumersReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XINFO_CONSUMERS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
rawReply: any[]
Returns XInfoConsumersReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XINFO_GROUPS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
rawReply: any[]
Returns XInfoGroupsReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XINFO_GROUPS
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
rawReply: any[]
Returns XInfoGroupsReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XINFO_STREAM
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
rawReply: any[]
Returns XInfoStreamReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XINFO_STREAM
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
rawReply: any[]
Returns XInfoStreamReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XPENDING
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
reply: XPendingRawReply
Returns XPendingReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XPENDING
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
Returns RedisCommandArguments
transform
Parameters
reply: XPendingRawReply
Returns XPendingReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XPENDING_RANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
start: string
end: string
count: number
Optional options: XPendingRangeOptions
Returns RedisCommandArguments
transform
Parameters
reply: XPendingRangeRawReply
Returns XPendingRangeReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XPENDING_RANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
group: RedisCommandArgument
start: string
end: string
count: number
Optional options: XPendingRangeOptions
Returns RedisCommandArguments
transform
Parameters
reply: XPendingRangeRawReply
Returns XPendingRangeReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformStreamMessagesReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: RedisCommandArgument
end: RedisCommandArgument
Optional options: XRangeOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformStreamMessagesReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: RedisCommandArgument
end: RedisCommandArgument
Optional options: XRangeOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XREAD
Index
References
Variables
Functions
References
transform
Renames and re-exports transformStreamsMessagesReplyVariables
IS_
Functions
Const FIRST_
Parameters
streams: XReadStream | XReadStream[]
Returns RedisCommandArgument
transform
Parameters
streams: XReadStream | XReadStream[]
Optional options: XReadOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XREAD
Index
References
Variables
Functions
References
transform
Renames and re-exports transformStreamsMessagesReplyVariables
IS_
Functions
Const FIRST_
Parameters
streams: XReadStream | XReadStream[]
Returns RedisCommandArgument
transform
Parameters
streams: XReadStream | XReadStream[]
Optional options: XReadOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XREADGROUP
Index
References
Interfaces
Variables
Functions
References
transform
Renames and re-exports transformStreamsMessagesReplyVariables
IS_
Functions
Const FIRST_
Parameters
_group: RedisCommandArgument
_consumer: RedisCommandArgument
streams: XReadGroupStream | XReadGroupStream[]
Returns RedisCommandArgument
transform
Parameters
group: RedisCommandArgument
consumer: RedisCommandArgument
streams: XReadGroupStream | XReadGroupStream[]
Optional options: XReadGroupOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XREADGROUP
Index
References
Interfaces
Variables
Functions
References
transform
Renames and re-exports transformStreamsMessagesReplyVariables
IS_
Functions
Const FIRST_
Parameters
_group: RedisCommandArgument
_consumer: RedisCommandArgument
streams: XReadGroupStream | XReadGroupStream[]
Returns RedisCommandArgument
transform
Parameters
group: RedisCommandArgument
consumer: RedisCommandArgument
streams: XReadGroupStream | XReadGroupStream[]
Optional options: XReadGroupOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XREVRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformStreamMessagesReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: RedisCommandArgument
end: RedisCommandArgument
Optional options: XRangeRevOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XREVRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformStreamMessagesReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
start: RedisCommandArgument
end: RedisCommandArgument
Optional options: XRangeRevOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XTRIM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
strategy: "MAXLEN" | "MINID"
threshold: number
Optional options: XTrimOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/XTRIM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
strategy: "MAXLEN" | "MINID"
threshold: number
Optional options: XTrimOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZADD
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: ZMember | ZMember[]
Optional options: ZAddOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZADD
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
members: ZMember | ZMember[]
Optional options: ZAddOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZCARD
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZCARD
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZCOUNT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZCOUNT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZDIFF
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZDIFF
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZDIFFSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZDIFFSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZDIFF_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [keys: RedisCommandArgument | RedisCommandArgument[]]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZDIFF_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [keys: RedisCommandArgument | RedisCommandArgument[]]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINCRBY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
increment: number
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINCRBY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
increment: number
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINTER
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZInterOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINTER
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZInterOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINTERSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZInterStoreOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINTERSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZInterStoreOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINTER_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [keys: RedisCommandArgument | RedisCommandArgument[], options?: ZInterOptions]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZINTER_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [keys: RedisCommandArgument | RedisCommandArgument[], options?: ZInterOptions]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZLEXCOUNT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: RedisCommandArgument
max: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZLEXCOUNT
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: RedisCommandArgument
max: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZMSCORE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityNullArrayReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZMSCORE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityNullArrayReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMAX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformSortedSetMemberNullReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMAX
Index
References
Variables
Functions
References
transform
Renames and re-exports transformSortedSetMemberNullReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMAX_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMAX_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMIN
Index
References
Variables
Functions
References
transform
Renames and re-exports transformSortedSetMemberNullReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMIN
Index
References
Variables
Functions
References
transform
Renames and re-exports transformSortedSetMemberNullReplyVariables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMIN_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZPOPMIN_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANDMEMBER
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANDMEMBER
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns RedisCommandArgument | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANDMEMBER_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANDMEMBER_COUNT
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: RedisCommandArgument
count: number
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANDMEMBER_COUNT_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, count: number]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANDMEMBER_COUNT_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, count: number]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Optional options: ZRangeOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Optional options: ZRangeOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGEBYLEX
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: RedisCommandArgument
max: RedisCommandArgument
Optional options: ZRangeByLexOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGEBYLEX
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: RedisCommandArgument
max: RedisCommandArgument
Optional options: ZRangeByLexOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGEBYSCORE
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: string | number
max: string | number
Optional options: ZRangeByScoreOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGEBYSCORE
Index
Interfaces
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
min: string | number
max: string | number
Optional options: ZRangeByScoreOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGEBYSCORE_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
key: RedisCommandArgument
min: string | number
max: string | number
Optional options: ZRangeByScoreOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGEBYSCORE_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
key: RedisCommandArgument
min: string | number
max: string | number
Optional options: ZRangeByScoreOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGESTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
dst: RedisCommandArgument
src: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Optional options: ZRangeStoreOptions
Returns RedisCommandArguments
transform
Parameters
reply: number
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGESTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
dst: RedisCommandArgument
src: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Optional options: ZRangeStoreOptions
Returns RedisCommandArguments
transform
Parameters
reply: number
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGE_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, min: number | RedisCommandArgument, max: number | RedisCommandArgument, options?: ZRangeOptions]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANGE_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [key: RedisCommandArgument, min: number | RedisCommandArgument, max: number | RedisCommandArgument, options?: ZRangeOptions]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANK
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZRANK
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREMRANGEBYLEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREMRANGEBYLEX
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREMRANGEBYRANK
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
stop: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREMRANGEBYRANK
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
start: number
stop: number
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREMRANGEBYSCORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREMRANGEBYSCORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: RedisCommandArgument
min: number | RedisCommandArgument
max: number | RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREVRANK
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZREVRANK
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
transform
Returns number | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZSCAN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: ZScanRawReply
Returns ZScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZSCAN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
transform
Parameters
__namedParameters: ZScanRawReply
Returns ZScanReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZSCORE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityNullReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZSCORE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumberInfinityNullReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: RedisCommandArgument
member: RedisCommandArgument
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZUNION
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZUnionOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZUNION
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZUnionOptions
Returns RedisCommandArguments
transform
Returns RedisCommandArgument[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZUNIONSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZUnionOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZUNIONSTORE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
destination: RedisCommandArgument
keys: RedisCommandArgument | RedisCommandArgument[]
Optional options: ZUnionOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZUNION_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [keys: RedisCommandArgument | RedisCommandArgument[], options?: ZUnionOptions]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/ZUNION_WITHSCORES
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYtransform
Renames and re-exports transformSortedSetWithScoresReplyFunctions
transform
Parameters
Rest ...args: [keys: RedisCommandArgument | RedisCommandArgument[], options?: ZUnionOptions]
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/generic-transformers
Index
Enumerations
Interfaces
Type aliases
Functions
Type aliases
Bit
Command
Command
Type declaration
arity: number
categories: Set<CommandCategories>
first
flags: Set<CommandFlags>
last
name: string
step: number
Geo
Geo
Geo
Stream
Streams
Functions
push
Parameters
args: string[]
Optional options: EvalOptions
Returns string[]
push
Parameters
args: RedisCommandArguments
count: undefined | GeoCountArgument
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
key: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
Optional options: GeoSearchOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
name: RedisCommandArgument
value: undefined | RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
value: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
value: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Parameters
reply: number[]
Returns boolean[]
transform
Parameters
reply: number
Returns boolean
transform
Parameters
__namedParameters: CommandRawReply
Returns CommandReply
transformEXAT
Parameters
EXAT: number | Date
Returns string
transform
Parameters
reply: any[][]
replyWith: GeoReplyWith[]
Returns GeoReplyWithMember[]
transform
Parameters
num: number
Returns string
transform
Parameters
reply: (null | RedisCommandArgument)[]
Returns (number | null)[]
transform
Parameters
reply: null | RedisCommandArgument
Returns number | null
transform
Parameters
reply: RedisCommandArgument
Returns number
transformPXAT
Parameters
PXAT: number | Date
Returns string
transform
Parameters
reply: [] | [RedisCommandArgument, RedisCommandArgument]
Returns ZMember | null
transform
Parameters
reply: RedisCommandArgument[]
Returns ZMember[]
transform
Parameters
reply: any[]
Returns StreamMessagesReply
transform
Parameters
reply: null | any[]
Returns StreamsMessagesReply | null
transform
Parameters
num: number | RedisCommandArgument
Returns RedisCommandArgument
transform
Parameters
reply: RedisCommandArgument[]
Returns Record<string, RedisCommandArgument>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/commands/generic-transformers
Index
Enumerations
Interfaces
Type aliases
Functions
Type aliases
Bit
Command
Command
Type declaration
arity: number
categories: Set<CommandCategories>
first
flags: Set<CommandFlags>
last
name: string
step: number
Geo
Geo
Geo
Stream
Streams
Functions
push
Parameters
args: string[]
Optional options: EvalOptions
Returns string[]
push
Parameters
args: RedisCommandArguments
count: undefined | GeoCountArgument
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
key: RedisCommandArgument
from: GeoSearchFrom
by: GeoSearchBy
Optional options: GeoSearchOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
name: RedisCommandArgument
value: undefined | RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
cursor: number
Optional options: ScanOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
value: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
value: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments
transform
Parameters
reply: number[]
Returns boolean[]
transform
Parameters
reply: number
Returns boolean
transform
Parameters
__namedParameters: CommandRawReply
Returns CommandReply
transformEXAT
Parameters
EXAT: number | Date
Returns string
transform
Parameters
reply: any[][]
replyWith: GeoReplyWith[]
Returns GeoReplyWithMember[]
transform
Parameters
num: number
Returns string
transform
Parameters
reply: (null | RedisCommandArgument)[]
Returns (number | null)[]
transform
Parameters
reply: null | RedisCommandArgument
Returns number | null
transform
Parameters
reply: RedisCommandArgument
Returns number
transformPXAT
Parameters
PXAT: number | Date
Returns string
transform
Parameters
reply: [] | [RedisCommandArgument, RedisCommandArgument]
Returns ZMember | null
transform
Parameters
reply: RedisCommandArgument[]
Returns ZMember[]
transform
Parameters
reply: any[]
Returns StreamMessagesReply
transform
Parameters
reply: null | any[]
Returns StreamsMessagesReply | null
transform
Parameters
num: number | RedisCommandArgument
Returns RedisCommandArgument
transform
Parameters
reply: RedisCommandArgument[]
Returns Record<string, RedisCommandArgument>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/lua-script
Index
Interfaces
Functions
Functions
define
Type parameters
S: RedisScriptConfig
Parameters
script: S
Returns S & SHA1
script
Parameters
script: string
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/lua-script
Index
Interfaces
Functions
Functions
define
Type parameters
S: RedisScriptConfig
Parameters
script: S
Returns S & SHA1
script
Parameters
script: string
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/utils
Index
Functions
Functions
promise
Parameters
ms: number
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/clientModule lib/utils
Index
Functions
Functions
promise
Parameters
ms: number
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands
Index
Type aliases
Properties
Functions
Type aliases
RedisJSON
Properties
default
Type declaration
ARRAPPEND: commands/ARRAPPEND
ARRINDEX: commands/ARRINDEX
ARRINSERT: commands/ARRINSERT
ARRLEN: commands/ARRLEN
ARRPOP: commands/ARRPOP
ARRTRIM: commands/ARRTRIM
DEBUG_
DEL: commands/DEL
FORGET: commands/FORGET
GET: commands/GET
MGET: commands/MGET
NUMINCRBY: commands/NUMINCRBY
NUMMULTBY: commands/NUMMULTBY
OBJKEYS: commands/OBJKEYS
OBJLEN: commands/OBJLEN
RESP: commands/RESP
SET: commands/SET
STRAPPEND: commands/STRAPPEND
STRLEN: commands/STRLEN
TYPE: commands/TYPE
arr
arr
arr
arr
arr
arr
debug
del: commands/DEL
forget: commands/FORGET
get: commands/GET
m
num
num
obj
obj
resp: commands/RESP
set: commands/SET
str
str
type: commands/TYPE
Functions
transform
Parameters
reply: string
Returns number | number[]
transform
Parameters
json: RedisJSON
Returns string
transform
Parameters
json: null | string
Returns RedisJSON | null
transform
Parameters
json: string
Returns RedisJSON
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands
Index
Type aliases
Properties
Functions
Type aliases
RedisJSON
Properties
default
Type declaration
ARRAPPEND: commands/ARRAPPEND
ARRINDEX: commands/ARRINDEX
ARRINSERT: commands/ARRINSERT
ARRLEN: commands/ARRLEN
ARRPOP: commands/ARRPOP
ARRTRIM: commands/ARRTRIM
DEBUG_
DEL: commands/DEL
FORGET: commands/FORGET
GET: commands/GET
MGET: commands/MGET
NUMINCRBY: commands/NUMINCRBY
NUMMULTBY: commands/NUMMULTBY
OBJKEYS: commands/OBJKEYS
OBJLEN: commands/OBJLEN
RESP: commands/RESP
SET: commands/SET
STRAPPEND: commands/STRAPPEND
STRLEN: commands/STRLEN
TYPE: commands/TYPE
arr
arr
arr
arr
arr
arr
debug
del: commands/DEL
forget: commands/FORGET
get: commands/GET
m
num
num
obj
obj
resp: commands/RESP
set: commands/SET
str
str
type: commands/TYPE
Functions
transform
Parameters
reply: string
Returns number | number[]
transform
Parameters
json: RedisJSON
Returns string
transform
Parameters
json: null | string
Returns RedisJSON | null
transform
Parameters
json: string
Returns RedisJSON
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRAPPEND
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
Rest ...jsons: RedisJSON[]
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRAPPEND
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
Rest ...jsons: RedisJSON[]
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRINDEX
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
path: string
json: RedisJSON
Optional start: number
Optional stop: number
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRINDEX
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
path: string
json: RedisJSON
Optional start: number
Optional stop: number
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRINSERT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
index: number
Rest ...jsons: RedisJSON[]
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRINSERT
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
index: number
Rest ...jsons: RedisJSON[]
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Optional index: number
Returns string[]
transform
Parameters
reply: null | string | (null | string)[]
Returns null | RedisJSON | RedisJSON[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRPOP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Optional index: number
Returns string[]
transform
Parameters
reply: null | string | (null | string)[]
Returns null | RedisJSON | RedisJSON[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRTRIM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
start: number
stop: number
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/ARRTRIM
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
start: number
stop: number
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/DEBUG_MEMORY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/DEBUG_MEMORY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/DEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/DEL
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/FORGET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/FORGET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/GET
Index
References
Variables
Functions
References
transform
Renames and re-exports transformRedisJsonNullReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional options: GetOptions
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/GET
Index
References
Variables
Functions
References
transform
Renames and re-exports transformRedisJsonNullReplyVariables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional options: GetOptions
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/MGET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
keys: string[]
path: string
Returns string[]
transform
Parameters
reply: (null | string)[]
Returns (RedisJSON | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/MGET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
keys: string[]
path: string
Returns string[]
transform
Parameters
reply: (null | string)[]
Returns (RedisJSON | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/NUMINCRBY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumbersReplyVariables
FIRST_
Functions
transform
Parameters
key: string
path: string
by: number
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/NUMINCRBY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumbersReplyVariables
FIRST_
Functions
transform
Parameters
key: string
path: string
by: number
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/NUMMULTBY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumbersReplyVariables
FIRST_
Functions
transform
Parameters
key: string
path: string
by: number
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/NUMMULTBY
Index
References
Variables
Functions
References
transform
Renames and re-exports transformNumbersReplyVariables
FIRST_
Functions
transform
Parameters
key: string
path: string
by: number
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/OBJKEYS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns string[] | null | (string[] | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/OBJKEYS
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns string[] | null | (string[] | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/OBJLEN
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number | null | (number | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/OBJLEN
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number | null | (number | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/RESP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns RESPReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/RESP
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns RESPReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/SET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
json: RedisJSON
Optional options: NX | XX
Returns string[]
transform
Returns "OK" | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/SET
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
path: string
json: RedisJSON
Optional options: NX | XX
Returns string[]
transform
Returns "OK" | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/STRAPPEND
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
Rest ...__namedParameters: AppendArguments | AppendWithPathArguments
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/STRAPPEND
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
Rest ...__namedParameters: AppendArguments | AppendWithPathArguments
Returns string[]
transform
Returns number | number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/STRLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/STRLEN
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/TYPE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns string | null | (string | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/jsonModule commands/TYPE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional path: string
Returns string[]
transform
Returns string | null | (string | null)[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration RedisSearchLanguages
Index
Enumeration members
Enumeration members
ARABIC
BASQUE
CATALANA
CHINESE
DANISH
DUTCH
ENGLISH
FINNISH
FRENCH
GERMAN
GREEK
HUNGARIAN
INDONESAIN
IRISH
ITALIAN
LITHUANIAN
NEPALI
NORWEIGAN
PORTUGUESE
ROMANIAN
RUSSIAN
SPANISH
SWEDISH
TAMIL
TURKISH
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration RedisSearchLanguages
Index
Enumeration members
Enumeration members
ARABIC
BASQUE
CATALANA
CHINESE
DANISH
DUTCH
ENGLISH
FINNISH
FRENCH
GERMAN
GREEK
HUNGARIAN
INDONESAIN
IRISH
ITALIAN
LITHUANIAN
NEPALI
NORWEIGAN
PORTUGUESE
ROMANIAN
RUSSIAN
SPANISH
SWEDISH
TAMIL
TURKISH
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration SchemaFieldTypes
Index
Enumeration members
Enumeration members
GEO
NUMERIC
TAG
TEXT
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration SchemaFieldTypes
Index
Enumeration members
Enumeration members
GEO
NUMERIC
TAG
TEXT
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration SchemaTextFieldPhonetics
Index
Enumeration members
Enumeration members
DM_
DM_
DM_
FM_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration SchemaTextFieldPhonetics
Index
Enumeration members
Enumeration members
DM_
DM_
DM_
FM_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration AggregateGroupByReducers
Index
Enumeration members
Enumeration members
AVG
COUNT
COUNT_
COUNT_
FIRST_
MAX
MIN
QUANTILE
RANDOM_
STDDEV
SUM
TOLIST
TO_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration AggregateGroupByReducers
Index
Enumeration members
Enumeration members
AVG
COUNT
COUNT_
COUNT_
FIRST_
MAX
MIN
QUANTILE
RANDOM_
STDDEV
SUM
TOLIST
TO_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration AggregateSteps
Index
Enumeration members
Enumeration members
APPLY
FILTER
GROUPBY
LIMIT
SORTBY
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchEnumeration AggregateSteps
Index
Enumeration members
Enumeration members
APPLY
FILTER
GROUPBY
LIMIT
SORTBY
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface ProfileOptions
Hierarchy
Index
Properties
Properties
Optional LIMITED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface ProfileOptions
Hierarchy
Index
Properties
Properties
Optional LIMITED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface ProfileReply
Hierarchy
Index
Properties
Properties
profile
results
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface ProfileReply
Hierarchy
Index
Properties
Properties
profile
results
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SearchReply
Hierarchy
Index
Properties
Properties
documents
total
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SearchReply
Hierarchy
Index
Properties
Properties
documents
total
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface AggregateOptions
Hierarchy
Index
Properties
Properties
Optional LOAD
Optional STEPS
Optional VERBATIM
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface AggregateOptions
Hierarchy
Index
Properties
Properties
Optional LOAD
Optional STEPS
Optional VERBATIM
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface AggregateReply
Hierarchy
Index
Properties
Properties
results
total
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface AggregateReply
Hierarchy
Index
Properties
Properties
results
total
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SearchOptions
Hierarchy
Index
Properties
Properties
Optional EXPANDER
Optional HIGHLIGHT
Optional INFIELDS
Optional INKEYS
Optional INORDER
Optional LANGUAGE
Optional LIMIT
Type declaration
from: string | number
size: string | number
Optional NOSTOPWORDS
Optional RETURN
Optional SCORER
Optional SLOP
Optional SORTBY
Optional SUMMARIZE
Optional VERBATIM
Optional WITHSORTKEYS
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SearchOptions
Hierarchy
Index
Properties
Properties
Optional EXPANDER
Optional HIGHLIGHT
Optional INFIELDS
Optional INKEYS
Optional INORDER
Optional LANGUAGE
Optional LIMIT
Type declaration
from: string | number
size: string | number
Optional NOSTOPWORDS
Optional RETURN
Optional SCORER
Optional SLOP
Optional SORTBY
Optional SUMMARIZE
Optional VERBATIM
Optional WITHSORTKEYS
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SugGetOptions
Hierarchy
Index
Properties
Properties
Optional FUZZY
Optional MAX
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SugGetOptions
Hierarchy
Index
Properties
Properties
Optional FUZZY
Optional MAX
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SuggestionWithPayload
Hierarchy
Index
Properties
Properties
payload
suggestion
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SuggestionWithPayload
Hierarchy
Index
Properties
Properties
payload
suggestion
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SuggestionWithScores
Hierarchy
Index
Properties
Properties
score
suggestion
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchInterface SuggestionWithScores
Hierarchy
Index
Properties
Properties
score
suggestion
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands
Index
Enumerations
Interfaces
Type aliases
Properties
Functions
Type aliases
Profile
Type parameters
T
Property
Sort
Properties
default
Type declaration
AGGREGATE: commands/AGGREGATE
ALIASADD: commands/ALIASADD
ALIASDEL: commands/ALIASDEL
ALIASUPDATE: commands/ALIASUPDATE
ALTER: commands/ALTER
CONFIG_
CONFIG_
CREATE: commands/CREATE
DICTADD: commands/DICTADD
DICTDEL: commands/DICTDEL
DICTDUMP: commands/DICTDUMP
DROPINDEX: commands/DROPINDEX
EXPLAIN: commands/EXPLAIN
EXPLAINCLI: commands/EXPLAINCLI
INFO: commands/INFO
PROFILEAGGREGATE: commands/PROFILE_AGGREGATE
PROFILESEARCH: commands/PROFILE_SEARCH
SEARCH: commands/SEARCH
SPELLCHECK: commands/SPELLCHECK
SUGADD: commands/SUGADD
SUGDEL: commands/SUGDEL
SUGGET: commands/SUGGET
SUGGET_
SUGGET_
SUGGET_
SUGLEN: commands/SUGLEN
SYNDUMP: commands/SYNDUMP
SYNUPDATE: commands/SYNUPDATE
TAGVALS: commands/TAGVALS
_LIST: commands/_LIST
_list: commands/_LIST
aggregate: commands/AGGREGATE
alias
alias
alias
alter: commands/ALTER
config
config
create: commands/CREATE
dict
dict
dict
drop
explain: commands/EXPLAIN
explain
info: commands/INFO
profile
profile
search: commands/SEARCH
spell
sug
sug
sug
sug
sug
sug
sug
syn
syn
tag
Functions
push
Parameters
args: RedisCommandArguments
fn: (args: RedisCommandArguments) => void
Parameters
args: RedisCommandArguments
Returns void
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
schema: CreateSchema
Returns void
push
Parameters
args: RedisCommandArguments
Optional options: SearchOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
name: string
sortBy: SortByProperty | SortByProperty[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
sortBy: SortByProperty
Returns void
transform
Parameters
reply: any[]
Returns ProfileData
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands
Index
Enumerations
Interfaces
Type aliases
Properties
Functions
Type aliases
Profile
Type parameters
T
Property
Sort
Properties
default
Type declaration
AGGREGATE: commands/AGGREGATE
ALIASADD: commands/ALIASADD
ALIASDEL: commands/ALIASDEL
ALIASUPDATE: commands/ALIASUPDATE
ALTER: commands/ALTER
CONFIG_
CONFIG_
CREATE: commands/CREATE
DICTADD: commands/DICTADD
DICTDEL: commands/DICTDEL
DICTDUMP: commands/DICTDUMP
DROPINDEX: commands/DROPINDEX
EXPLAIN: commands/EXPLAIN
EXPLAINCLI: commands/EXPLAINCLI
INFO: commands/INFO
PROFILEAGGREGATE: commands/PROFILE_AGGREGATE
PROFILESEARCH: commands/PROFILE_SEARCH
SEARCH: commands/SEARCH
SPELLCHECK: commands/SPELLCHECK
SUGADD: commands/SUGADD
SUGDEL: commands/SUGDEL
SUGGET: commands/SUGGET
SUGGET_
SUGGET_
SUGGET_
SUGLEN: commands/SUGLEN
SYNDUMP: commands/SYNDUMP
SYNUPDATE: commands/SYNUPDATE
TAGVALS: commands/TAGVALS
_LIST: commands/_LIST
_list: commands/_LIST
aggregate: commands/AGGREGATE
alias
alias
alias
alter: commands/ALTER
config
config
create: commands/CREATE
dict
dict
dict
drop
explain: commands/EXPLAIN
explain
info: commands/INFO
profile
profile
search: commands/SEARCH
spell
sug
sug
sug
sug
sug
sug
sug
syn
syn
tag
Functions
push
Parameters
args: RedisCommandArguments
fn: (args: RedisCommandArguments) => void
Parameters
args: RedisCommandArguments
Returns void
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
schema: CreateSchema
Returns void
push
Parameters
args: RedisCommandArguments
Optional options: SearchOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
name: string
sortBy: SortByProperty | SortByProperty[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
sortBy: SortByProperty
Returns void
transform
Parameters
reply: any[]
Returns ProfileData
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/AGGREGATE
Index
Enumerations
Interfaces
Type aliases
Functions
Type aliases
Aggregate
Functions
push
Parameters
args: RedisCommandArguments
Optional options: AggregateOptions
Returns RedisCommandArguments
transform
Parameters
index: string
query: string
Optional options: AggregateOptions
Returns RedisCommandArguments
transform
Parameters
rawReply: [total: number, ...results: RedisCommandArgument[][]]
Returns AggregateReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/AGGREGATE
Index
Enumerations
Interfaces
Type aliases
Functions
Type aliases
Aggregate
Functions
push
Parameters
args: RedisCommandArguments
Optional options: AggregateOptions
Returns RedisCommandArguments
transform
Parameters
index: string
query: string
Optional options: AggregateOptions
Returns RedisCommandArguments
transform
Parameters
rawReply: [total: number, ...results: RedisCommandArgument[][]]
Returns AggregateReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALIASADD
Index
Functions
Functions
transform
Parameters
name: string
index: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALIASADD
Index
Functions
Functions
transform
Parameters
name: string
index: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALIASDEL
Index
Functions
Functions
transform
Parameters
name: string
index: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALIASDEL
Index
Functions
Functions
transform
Parameters
name: string
index: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALIASUPDATE
Index
Functions
Functions
transform
Parameters
name: string
index: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALIASUPDATE
Index
Functions
Functions
transform
Parameters
name: string
index: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALTER
Index
Functions
Functions
transform
Parameters
index: string
schema: CreateSchema
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/ALTER
Index
Functions
Functions
transform
Parameters
index: string
schema: CreateSchema
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/CONFIG_GET
Index
Functions
Functions
transform
Parameters
option: string
Returns string[]
transform
Parameters
rawReply: [string, null | string][]
Returns ConfigGetReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/CONFIG_GET
Index
Functions
Functions
transform
Parameters
option: string
Returns string[]
transform
Parameters
rawReply: [string, null | string][]
Returns ConfigGetReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/CONFIG_SET
Index
Functions
Functions
transform
Parameters
option: string
value: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/CONFIG_SET
Index
Functions
Functions
transform
Parameters
option: string
value: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/CREATE
Index
Functions
Functions
transform
Parameters
index: string
schema: CreateSchema
Optional options: CreateOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/CREATE
Index
Functions
Functions
transform
Parameters
index: string
schema: CreateSchema
Optional options: CreateOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DICTADD
Index
Functions
Functions
transform
Parameters
dictionary: string
term: string | string[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DICTADD
Index
Functions
Functions
transform
Parameters
dictionary: string
term: string | string[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DICTDEL
Index
Functions
Functions
transform
Parameters
dictionary: string
term: string | string[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DICTDEL
Index
Functions
Functions
transform
Parameters
dictionary: string
term: string | string[]
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DICTDUMP
Index
Functions
Functions
transform
Parameters
dictionary: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DICTDUMP
Index
Functions
Functions
transform
Parameters
dictionary: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DROPINDEX
Index
Functions
Functions
transform
Parameters
index: string
Optional options: DropIndexOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/DROPINDEX
Index
Functions
Functions
transform
Parameters
index: string
Optional options: DropIndexOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/EXPLAIN
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/EXPLAIN
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Returns string[]
transform
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/EXPLAINCLI
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/EXPLAINCLI
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/INFO
Index
Functions
Functions
transform
Parameters
index: string
Returns string[]
transform
Parameters
rawReply: InfoRawReply
Returns InfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/INFO
Index
Functions
Functions
transform
Parameters
index: string
Returns string[]
transform
Parameters
rawReply: InfoRawReply
Returns InfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/PROFILE_AGGREGATE
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Optional options: ProfileOptions & AggregateOptions
Returns string[]
transform
Parameters
reply: ProfileAggeregateRawReply
Returns ProfileReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/PROFILE_AGGREGATE
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Optional options: ProfileOptions & AggregateOptions
Returns string[]
transform
Parameters
reply: ProfileAggeregateRawReply
Returns ProfileReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/PROFILE_SEARCH
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Optional options: ProfileOptions & SearchOptions
Returns string[]
transform
Parameters
reply: ProfileSearchRawReply
Returns ProfileReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/PROFILE_SEARCH
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
index: string
query: string
Optional options: ProfileOptions & SearchOptions
Returns string[]
transform
Parameters
reply: ProfileSearchRawReply
Returns ProfileReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SEARCH
Index
Interfaces
Type aliases
Variables
Functions
Type aliases
Search
Variables
FIRST_
IS_
Functions
transform
Parameters
index: string
query: string
Optional options: SearchOptions
Returns RedisCommandArguments
transform
Parameters
reply: SearchRawReply
Returns SearchReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SEARCH
Index
Interfaces
Type aliases
Variables
Functions
Type aliases
Search
Variables
FIRST_
IS_
Functions
transform
Parameters
index: string
query: string
Optional options: SearchOptions
Returns RedisCommandArguments
transform
Parameters
reply: SearchRawReply
Returns SearchReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SPELLCHECK
Index
Functions
Functions
transform
Parameters
index: string
query: string
Optional options: SpellCheckOptions
Returns string[]
transform
Parameters
rawReply: SpellCheckRawReply
Returns SpellCheckReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SPELLCHECK
Index
Functions
Functions
transform
Parameters
index: string
query: string
Optional options: SpellCheckOptions
Returns string[]
transform
Parameters
rawReply: SpellCheckRawReply
Returns SpellCheckReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGADD
Index
Functions
Functions
transform
Parameters
key: string
string: string
score: number
Optional options: SugAddOptions
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGADD
Index
Functions
Functions
transform
Parameters
key: string
string: string
score: number
Optional options: SugAddOptions
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGDEL
Index
Functions
Functions
transform
Parameters
key: string
string: string
Returns string[]
transform
Parameters
reply: number
Returns boolean
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGDEL
Index
Functions
Functions
transform
Parameters
key: string
string: string
Returns string[]
transform
Parameters
reply: number
Returns boolean
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET
Index
Interfaces
Variables
Functions
Variables
IS_
Functions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Returns null | string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET
Index
Interfaces
Variables
Functions
Variables
IS_
Functions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Returns null | string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET_WITHPAYLOADS
Index
References
Interfaces
Functions
References
IS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Parameters
rawReply: null | (null | string)[]
Returns SuggestionWithPayload[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET_WITHPAYLOADS
Index
References
Interfaces
Functions
References
IS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Parameters
rawReply: null | (null | string)[]
Returns SuggestionWithPayload[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET_WITHSCORES
Index
References
Interfaces
Functions
References
IS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Parameters
rawReply: null | string[]
Returns SuggestionWithScores[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET_WITHSCORES
Index
References
Interfaces
Functions
References
IS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Parameters
rawReply: null | string[]
Returns SuggestionWithScores[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET_WITHSCORES_WITHPAYLOADS
Index
References
Functions
References
IS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Parameters
rawReply: null | (null | string)[]
Returns SuggestionWithScoresAndPayloads[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGGET_WITHSCORES_WITHPAYLOADS
Index
References
Functions
References
IS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
prefix: string
Optional options: SugGetOptions
Returns string[]
transform
Parameters
rawReply: null | (null | string)[]
Returns SuggestionWithScoresAndPayloads[] | null
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGLEN
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
key: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SUGLEN
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
key: string
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SYNDUMP
Index
Functions
Functions
transform
Parameters
index: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SYNDUMP
Index
Functions
Functions
transform
Parameters
index: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SYNUPDATE
Index
Functions
Functions
transform
Parameters
index: string
groupId: string
terms: string | string[]
Optional options: SynUpdateOptions
Returns RedisCommandArguments
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/SYNUPDATE
Index
Functions
Functions
transform
Parameters
index: string
groupId: string
terms: string | string[]
Optional options: SynUpdateOptions
Returns RedisCommandArguments
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/TAGVALS
Index
Functions
Functions
transform
Parameters
index: string
fieldName: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/TAGVALS
Index
Functions
Functions
transform
Parameters
index: string
fieldName: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/_LIST
Index
Functions
Functions
transform
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/searchModule commands/_LIST
Index
Functions
Functions
transform
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesAggregationType
Index
Enumeration members
Enumeration members
AVARAGE
COUNT
FIRST
LAST
MAXIMUM
MINIMUM
RANGE
STD_
STD_
SUM
VAR_
VAR_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesAggregationType
Index
Enumeration members
Enumeration members
AVARAGE
COUNT
FIRST
LAST
MAXIMUM
MINIMUM
RANGE
STD_
STD_
SUM
VAR_
VAR_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesDuplicatePolicies
Index
Enumeration members
Enumeration members
BLOCK
FIRST
LAST
MAX
MIN
SUM
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesDuplicatePolicies
Index
Enumeration members
Enumeration members
BLOCK
FIRST
LAST
MAX
MIN
SUM
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesEncoding
Index
Enumeration members
Enumeration members
COMPRESSED
UNCOMPRESSED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesEncoding
Index
Enumeration members
Enumeration members
COMPRESSED
UNCOMPRESSED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesReducers
Index
Enumeration members
Enumeration members
MAXIMUM
MINIMUM
SUM
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesEnumeration TimeSeriesReducers
Index
Enumeration members
Enumeration members
MAXIMUM
MINIMUM
SUM
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface IncrDecrOptions
Hierarchy
Index
Properties
Properties
Optional CHUNK_
Optional LABELS
Optional RETENTION
Optional TIMESTAMP
Optional UNCOMPRESSED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface IncrDecrOptions
Hierarchy
Index
Properties
Properties
Optional CHUNK_
Optional LABELS
Optional RETENTION
Optional TIMESTAMP
Optional UNCOMPRESSED
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MRangeOptions
Hierarchy
Index
Properties
Properties
Optional AGGREGATION
Type declaration
time
type: TimeSeriesAggregationType
Optional ALIGN
Optional COUNT
Optional FILTER_
Optional FILTER_
Type declaration
max: number
min: number
Optional GROUPBY
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MRangeOptions
Hierarchy
Index
Properties
Properties
Optional AGGREGATION
Type declaration
time
type: TimeSeriesAggregationType
Optional ALIGN
Optional COUNT
Optional FILTER_
Optional FILTER_
Type declaration
max: number
min: number
Optional GROUPBY
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MRangeWithLabelsOptions
Hierarchy
Index
Properties
Properties
Optional AGGREGATION
Type declaration
time
type: TimeSeriesAggregationType
Optional ALIGN
Optional COUNT
Optional FILTER_
Optional FILTER_
Type declaration
max: number
min: number
Optional GROUPBY
Optional SELECTED_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MRangeWithLabelsOptions
Hierarchy
Index
Properties
Properties
Optional AGGREGATION
Type declaration
time
type: TimeSeriesAggregationType
Optional ALIGN
Optional COUNT
Optional FILTER_
Optional FILTER_
Type declaration
max: number
min: number
Optional GROUPBY
Optional SELECTED_
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MRangeWithLabelsReplyItem
Hierarchy
Index
Properties
Properties
key
labels
samples
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MRangeWithLabelsReplyItem
Hierarchy
Index
Properties
Properties
key
labels
samples
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface RangeOptions
Hierarchy
Index
Properties
Properties
Optional AGGREGATION
Type declaration
time
type: TimeSeriesAggregationType
Optional ALIGN
Optional COUNT
Optional FILTER_
Optional FILTER_
Type declaration
max: number
min: number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface RangeOptions
Hierarchy
Index
Properties
Properties
Optional AGGREGATION
Type declaration
time
type: TimeSeriesAggregationType
Optional ALIGN
Optional COUNT
Optional FILTER_
Optional FILTER_
Type declaration
max: number
min: number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface SampleReply
Hierarchy
Index
Properties
Properties
timestamp
value
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface SampleReply
Hierarchy
Index
Properties
Properties
timestamp
value
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface InfoReply
Hierarchy
Index
Properties
Properties
chunk
chunk
chunk
duplicate
first
labels
last
memory
retention
rules
source
total
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface InfoReply
Hierarchy
Index
Properties
Properties
chunk
chunk
chunk
duplicate
first
labels
last
memory
retention
rules
source
total
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MGetReply
Hierarchy
Index
Properties
Properties
key
sample
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MGetReply
Hierarchy
Index
Properties
Properties
key
sample
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MGetWithLabelsReply
Hierarchy
Index
Properties
Properties
key
labels
sample
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesInterface MGetWithLabelsReply
Hierarchy
Index
Properties
Properties
key
labels
sample
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands
Index
Enumerations
Interfaces
Type aliases
Properties
Functions
Type aliases
Filter
Labels
Type declaration
[label: string]: string
Raw
Sample
Selected
Timestamp
Properties
default
Type declaration
ADD: commands/ADD
ALTER: commands/ALTER
CREATE: commands/CREATE
CREATERULE: commands/CREATERULE
DECRBY: commands/DECRBY
DEL: commands/DEL
DELETERULE: commands/DELETERULE
GET: commands/GET
INCRBY: commands/INCRBY
INFO: commands/INFO
INFO_
MADD: commands/MADD
MGET: commands/MGET
MGET_
MRANGE: commands/MRANGE
MRANGE_
MREVRANGE: commands/MREVRANGE
MREVRANGE_
QUERYINDEX: commands/QUERYINDEX
RANGE: commands/RANGE
REVRANGE: commands/REVRANGE
add: commands/ADD
alter: commands/ALTER
create: commands/CREATE
create
decr
del: commands/DEL
delete
get: commands/GET
incr
info: commands/INFO
info
m
m
m
m
m
m
m
query
range: commands/RANGE
rev
Functions
push
Parameters
args: RedisCommandArguments
Optional chunkSize: number
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional encoding: TimeSeriesEncoding
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
filter: string | string[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional labels: Labels
Returns RedisCommandArguments
pushMRange
Parameters
args: RedisCommandArguments
fromTimestamp: Timestamp
toTimestamp: Timestamp
filter: Filter
Optional options: MRangeOptions
Returns RedisCommandArguments
pushMRange
Parameters
args: RedisCommandArguments
Optional groupBy: MRangeGroupBy
Returns RedisCommandArguments
pushMRange
Parameters
args: RedisCommandArguments
fromTimestamp: Timestamp
toTimestamp: Timestamp
filter: Filter
Optional options: MRangeWithLabelsOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
fromTimestamp: Timestamp
toTimestamp: Timestamp
Optional options: RangeOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional retention: number
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional selectedLabels: SelectedLabels
Returns RedisCommandArguments
transform
Parameters
command: "TS.INCRBY" | "TS.DECRBY"
key: string
value: number
Optional options: IncrDecrOptions
Returns RedisCommandArguments
transform
Parameters
reply: RawLabels
Returns Labels
transformMRange
Parameters
reply: MRangeRawReply
Returns MRangeReplyItem[]
transformMRange
Parameters
reply: MRangeRawReply
Returns MRangeWithLabelsReplyItem[]
transform
Parameters
reply: SampleRawReply[]
Returns SampleReply[]
transform
Parameters
reply: SampleRawReply
Returns SampleReply
transform
Parameters
timestamp: Timestamp
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands
Index
Enumerations
Interfaces
Type aliases
Properties
Functions
Type aliases
Filter
Labels
Type declaration
[label: string]: string
Raw
Sample
Selected
Timestamp
Properties
default
Type declaration
ADD: commands/ADD
ALTER: commands/ALTER
CREATE: commands/CREATE
CREATERULE: commands/CREATERULE
DECRBY: commands/DECRBY
DEL: commands/DEL
DELETERULE: commands/DELETERULE
GET: commands/GET
INCRBY: commands/INCRBY
INFO: commands/INFO
INFO_
MADD: commands/MADD
MGET: commands/MGET
MGET_
MRANGE: commands/MRANGE
MRANGE_
MREVRANGE: commands/MREVRANGE
MREVRANGE_
QUERYINDEX: commands/QUERYINDEX
RANGE: commands/RANGE
REVRANGE: commands/REVRANGE
add: commands/ADD
alter: commands/ALTER
create: commands/CREATE
create
decr
del: commands/DEL
delete
get: commands/GET
incr
info: commands/INFO
info
m
m
m
m
m
m
m
query
range: commands/RANGE
rev
Functions
push
Parameters
args: RedisCommandArguments
Optional chunkSize: number
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional encoding: TimeSeriesEncoding
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
filter: string | string[]
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional labels: Labels
Returns RedisCommandArguments
pushMRange
Parameters
args: RedisCommandArguments
fromTimestamp: Timestamp
toTimestamp: Timestamp
filter: Filter
Optional options: MRangeOptions
Returns RedisCommandArguments
pushMRange
Parameters
args: RedisCommandArguments
Optional groupBy: MRangeGroupBy
Returns RedisCommandArguments
pushMRange
Parameters
args: RedisCommandArguments
fromTimestamp: Timestamp
toTimestamp: Timestamp
filter: Filter
Optional options: MRangeWithLabelsOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
fromTimestamp: Timestamp
toTimestamp: Timestamp
Optional options: RangeOptions
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional retention: number
Returns RedisCommandArguments
push
Parameters
args: RedisCommandArguments
Optional selectedLabels: SelectedLabels
Returns RedisCommandArguments
transform
Parameters
command: "TS.INCRBY" | "TS.DECRBY"
key: string
value: number
Optional options: IncrDecrOptions
Returns RedisCommandArguments
transform
Parameters
reply: RawLabels
Returns Labels
transformMRange
Parameters
reply: MRangeRawReply
Returns MRangeReplyItem[]
transformMRange
Parameters
reply: MRangeRawReply
Returns MRangeWithLabelsReplyItem[]
transform
Parameters
reply: SampleRawReply[]
Returns SampleReply[]
transform
Parameters
reply: SampleRawReply
Returns SampleReply
transform
Parameters
timestamp: Timestamp
Returns string
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/ADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
timestamp: Timestamp
value: number
Optional options: AddOptions
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/ADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
timestamp: Timestamp
value: number
Optional options: AddOptions
Returns string[]
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/ALTER
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional options: AlterOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/ALTER
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional options: AlterOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/CREATE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional options: CreateOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/CREATE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
Optional options: CreateOptions
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/CREATERULE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
sourceKey: string
destinationKey: string
aggregationType: TimeSeriesAggregationType
timeBucket: number
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/CREATERULE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
sourceKey: string
destinationKey: string
aggregationType: TimeSeriesAggregationType
timeBucket: number
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/DECRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
value: number
Optional options: IncrDecrOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/DECRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
value: number
Optional options: IncrDecrOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/DEL
Index
Variables
Functions
Variables
FIRTS_
Functions
transform
Parameters
key: string
fromTimestamp: Timestamp
toTimestamp: Timestamp
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/DEL
Index
Variables
Functions
Variables
FIRTS_
Functions
transform
Parameters
key: string
fromTimestamp: Timestamp
toTimestamp: Timestamp
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/DELETERULE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
sourceKey: string
destinationKey: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/DELETERULE
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
sourceKey: string
destinationKey: string
Returns string[]
transform
Returns "OK"
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/GET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Returns string[]
transform
Parameters
reply: [] | SampleRawReply
Returns null | SampleReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/GET
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Returns string[]
transform
Parameters
reply: [] | SampleRawReply
Returns null | SampleReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/INCRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
value: number
Optional options: IncrDecrOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/INCRBY
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
key: string
value: number
Optional options: IncrDecrOptions
Returns RedisCommandArguments
transform
Returns number
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/INFO
Index
Interfaces
Type aliases
Variables
Functions
Type aliases
Info
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Returns string[]
transform
Parameters
reply: InfoRawReply
Returns InfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/INFO
Index
Interfaces
Type aliases
Variables
Functions
Type aliases
Info
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
Returns string[]
transform
Parameters
reply: InfoRawReply
Returns InfoReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/INFO_DEBUG
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
Returns string[]
transform
Parameters
rawReply: [_: string, totalSamples: number, _: string, memoryUsage: number, _: string, firstTimestamp: number, _: string, lastTimestamp: number, _: string, retentionTime: number, _: string, chunkCount: number, _: string, chunkSize: number, _: string, chunkType: string, _: string, duplicatePolicy: null | TimeSeriesDuplicatePolicies, _: string, labels: [name: string, value: string][]]
Returns InfoDebugReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/INFO_DEBUG
Index
References
Functions
References
FIRST_
Re-exports FIRST_KEY_INDEXIS_
Re-exports IS_READ_ONLYFunctions
transform
Parameters
key: string
Returns string[]
transform
Parameters
rawReply: [_: string, totalSamples: number, _: string, memoryUsage: number, _: string, firstTimestamp: number, _: string, lastTimestamp: number, _: string, retentionTime: number, _: string, chunkCount: number, _: string, chunkSize: number, _: string, chunkType: string, _: string, duplicatePolicy: null | TimeSeriesDuplicatePolicies, _: string, labels: [name: string, value: string][]]
Returns InfoDebugReply
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
toAdd: MAddSample[]
Returns string[]
transform
Returns number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MADD
Index
Variables
Functions
Variables
FIRST_
Functions
transform
Parameters
toAdd: MAddSample[]
Returns string[]
transform
Returns number[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MGET
Index
Interfaces
Type aliases
Variables
Functions
Type aliases
MGet
Variables
IS_
Functions
transform
Parameters
filter: Filter
Returns RedisCommandArguments
transform
Parameters
reply: MGetRawReply
Returns MGetReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MGET
Index
Interfaces
Type aliases
Variables
Functions
Type aliases
MGet
Variables
IS_
Functions
transform
Parameters
filter: Filter
Returns RedisCommandArguments
transform
Parameters
reply: MGetRawReply
Returns MGetReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MGET_WITHLABELS
Index
Interfaces
Variables
Functions
Variables
IS_
Functions
transform
Parameters
filter: Filter
Optional options: MGetWithLabelsOptions
Returns string[]
transform
Parameters
reply: MGetRawReply
Returns MGetWithLabelsReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MGET_WITHLABELS
Index
Interfaces
Variables
Functions
Variables
IS_
Functions
transform
Parameters
filter: Filter
Optional options: MGetWithLabelsOptions
Returns string[]
transform
Parameters
reply: MGetRawReply
Returns MGetWithLabelsReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: Filter
Optional options: MRangeOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: Filter
Optional options: MRangeOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MRANGE_WITHLABELS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeWithLabelsReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: string | string[]
Optional options: MRangeWithLabelsOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MRANGE_WITHLABELS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeWithLabelsReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: string | string[]
Optional options: MRangeWithLabelsOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MREVRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: Filter
Optional options: MRangeOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MREVRANGE
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: Filter
Optional options: MRangeOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MREVRANGE_WITHLABELS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeWithLabelsReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: Filter
Optional options: MRangeWithLabelsOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/MREVRANGE_WITHLABELS
Index
References
Variables
Functions
References
transform
Renames and re-exports transformMRangeWithLabelsReplyVariables
IS_
Functions
transform
Parameters
fromTimestamp: Timestamp
toTimestamp: Timestamp
filters: Filter
Optional options: MRangeWithLabelsOptions
Returns RedisCommandArguments
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/QUERYINDEX
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
query: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/QUERYINDEX
Index
Variables
Functions
Variables
IS_
Functions
transform
Parameters
query: string
Returns string[]
transform
Returns string[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/RANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
fromTimestamp: Timestamp
toTimestamp: Timestamp
Optional options: RangeOptions
Returns RedisCommandArguments
transform
Parameters
reply: SampleRawReply[]
Returns SampleReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/RANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
fromTimestamp: Timestamp
toTimestamp: Timestamp
Optional options: RangeOptions
Returns RedisCommandArguments
transform
Parameters
reply: SampleRawReply[]
Returns SampleReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/REVRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
fromTimestamp: Timestamp
toTimestamp: Timestamp
Optional options: RangeOptions
Returns RedisCommandArguments
transform
Parameters
reply: SampleRawReply[]
Returns SampleReply[]
Generated using TypeDoc
- Preparing search index...
- The search index is not available
@node-redis/time-seriesModule commands/REVRANGE
Index
Variables
Functions
Variables
FIRST_
IS_
Functions
transform
Parameters
key: string
fromTimestamp: Timestamp
toTimestamp: Timestamp
Optional options: RangeOptions
Returns RedisCommandArguments
transform
Parameters
reply: SampleRawReply[]
Returns SampleReply[]
Generated using TypeDoc