Search
Preparing search index...
The search index is not available
@node-redis/client
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@node-redis/client
lib/client
Module lib/client
Index
Classes
default
Interfaces
Client
Command
Options
Redis
Client
Options
Type aliases
Client
Legacy
Command
Arguments
Exclude
Mapped
String
Instantiable
Redis
Client
Redis
Client
Command
Signature
Redis
Client
Type
With
Modules
With
Scripts
Type aliases
Client
Legacy
Command
Arguments
Client
Legacy
Command
Arguments
:
LegacyCommandArguments
|
[
...
LegacyCommandArguments
,
ClientLegacyCallback
]
Exclude
Mapped
String
Exclude
Mapped
String
<
S
>
:
string
extends
S
?
never
:
S
Type parameters
S
Instantiable
Redis
Client
Instantiable
Redis
Client
<
M
,
S
>
:
new
(
options
?:
RedisClientOptions
<
M
,
S
>
)
=>
RedisClientType
<
M
,
S
>
Type parameters
M
:
RedisModules
S
:
RedisScripts
Type declaration
new
(
options
?:
RedisClientOptions
<
M
,
S
>
)
:
RedisClientType
<
M
,
S
>
Parameters
Optional
options:
RedisClientOptions
<
M
,
S
>
Returns
RedisClientType
<
M
,
S
>
Redis
Client
Command
Signature
Redis
Client
Command
Signature
<
Command
,
Params
>
:
<
Options
>
(
...
args
:
Params
|
[
options
:
Options
,
rest
:
Params
]
)
=>
Promise
<
ConvertArgumentType
<
RedisCommandReply
<
Command
>
,
Options
[
"returnBuffers"
]
extends
true
?
Buffer
:
string
>
>
Type parameters
Command
:
RedisCommand
Params
:
unknown
[]
=
Parameters
<
Command
[
"transformArguments"
]
>
Type declaration
<
Options
>
(
...
args
:
Params
|
[
options
:
Options
,
rest
:
Params
]
)
:
Promise
<
ConvertArgumentType
<
RedisCommandReply
<
Command
>
,
Options
[
"returnBuffers"
]
extends
true
?
Buffer
:
string
>
>
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
Client
Type
Redis
Client
Type
<
M
,
S
>
:
default
<
M
,
S
>
&
WithCommands
&
WithModules
<
M
>
&
WithScripts
<
S
>
Type parameters
M
:
RedisModules
S
:
RedisScripts
With
Modules
With
Modules
<
M
>
:
{
[
P
in
keyof
M
as
ExcludeMappedString
<
P
>
]
:
{
[
C
in
keyof
M
[
P
]
as
ExcludeMappedString
<
C
>
]
:
RedisClientCommandSignature
<
M
[
P
]
[
C
]
>
}
}
Type parameters
M
:
RedisModules
With
Scripts
With
Scripts
<
S
>
:
{
[
P
in
keyof
S
as
ExcludeMappedString
<
P
>
]
:
RedisClientCommandSignature
<
S
[
P
]
>
}
Type parameters
S
:
RedisScripts
Modules
index
lib/client
lib/client/commands
lib/client/commands-
queue
lib/client/multi-
command
lib/client/socket
lib/cluster
lib/cluster/cluster-
slots
lib/cluster/commands
lib/cluster/multi-
command
lib/command-
options
lib/commander
lib/commands
lib/commands/ACL_
CAT
lib/commands/ACL_
DELUSER
lib/commands/ACL_
GENPASS
lib/commands/ACL_
GETUSER
lib/commands/ACL_
LIST
lib/commands/ACL_
LOAD
lib/commands/ACL_
LOG
lib/commands/ACL_
LOG_
RESET
lib/commands/ACL_
SAVE
lib/commands/ACL_
SETUSER
lib/commands/ACL_
USERS
lib/commands/ACL_
WHOAMI
lib/commands/APPEND
lib/commands/ASKING
lib/commands/AUTH
lib/commands/BGREWRITEAOF
lib/commands/BGSAVE
lib/commands/BITCOUNT
lib/commands/BITFIELD
lib/commands/BITOP
lib/commands/BITPOS
lib/commands/BLMOVE
lib/commands/BLPOP
lib/commands/BRPOP
lib/commands/BRPOPLPUSH
lib/commands/BZPOPMAX
lib/commands/BZPOPMIN
lib/commands/CLIENT_
CACHING
lib/commands/CLIENT_
GETNAME
lib/commands/CLIENT_
GETREDIR
lib/commands/CLIENT_
ID
lib/commands/CLIENT_
INFO
lib/commands/CLIENT_
KILL
lib/commands/CLIENT_
SETNAME
lib/commands/CLUSTER_
ADDSLOTS
lib/commands/CLUSTER_
FLUSHSLOTS
lib/commands/CLUSTER_
GETKEYSINSLOT
lib/commands/CLUSTER_
INFO
lib/commands/CLUSTER_
MEET
lib/commands/CLUSTER_
NODES
lib/commands/CLUSTER_
RESET
lib/commands/CLUSTER_
SETSLOT
lib/commands/CLUSTER_
SLOTS
lib/commands/COMMAND
lib/commands/COMMAND_
COUNT
lib/commands/COMMAND_
GETKEYS
lib/commands/COMMAND_
INFO
lib/commands/CONFIG_
GET
lib/commands/CONFIG_
RESETSTAT
lib/commands/CONFIG_
REWRITE
lib/commands/CONFIG_
SET
lib/commands/COPY
lib/commands/DBSIZE
lib/commands/DECR
lib/commands/DECRBY
lib/commands/DEL
lib/commands/DISCARD
lib/commands/DUMP
lib/commands/ECHO
lib/commands/EVAL
lib/commands/EVALSHA
lib/commands/EXISTS
lib/commands/EXPIRE
lib/commands/EXPIREAT
lib/commands/FAILOVER
lib/commands/FLUSHALL
lib/commands/FLUSHDB
lib/commands/GEOADD
lib/commands/GEODIST
lib/commands/GEOHASH
lib/commands/GEOPOS
lib/commands/GEOSEARCH
lib/commands/GEOSEARCHSTORE
lib/commands/GEOSEARCH_
WITH
lib/commands/GET
lib/commands/GETBIT
lib/commands/GETDEL
lib/commands/GETEX
lib/commands/GETRANGE
lib/commands/GETSET
lib/commands/HDEL
lib/commands/HELLO
lib/commands/HEXISTS
lib/commands/HGET
lib/commands/HGETALL
lib/commands/HINCRBY
lib/commands/HINCRBYFLOAT
lib/commands/HKEYS
lib/commands/HLEN
lib/commands/HMGET
lib/commands/HRANDFIELD
lib/commands/HRANDFIELD_
COUNT
lib/commands/HRANDFIELD_
COUNT_
WITHVALUES
lib/commands/HSCAN
lib/commands/HSET
lib/commands/HSETNX
lib/commands/HSTRLEN
lib/commands/HVALS
lib/commands/INCR
lib/commands/INCRBY
lib/commands/INCRBYFLOAT
lib/commands/INFO
lib/commands/KEYS
lib/commands/LASTSAVE
lib/commands/LINDEX
lib/commands/LINSERT
lib/commands/LLEN
lib/commands/LMOVE
lib/commands/LOLWUT
lib/commands/LPOP
lib/commands/LPOP_
COUNT
lib/commands/LPOS
lib/commands/LPOS_
COUNT
lib/commands/LPUSH
lib/commands/LPUSHX
lib/commands/LRANGE
lib/commands/LREM
lib/commands/LSET
lib/commands/LTRIM
lib/commands/MEMORY_
DOCTOR
lib/commands/MEMORY_
MALLOC-
STATS
lib/commands/MEMORY_
PURGE
lib/commands/MEMORY_
STATS
lib/commands/MEMORY_
USAGE
lib/commands/MGET
lib/commands/MIGRATE
lib/commands/MODULE_
LIST
lib/commands/MODULE_
LOAD
lib/commands/MODULE_
UNLOAD
lib/commands/MOVE
lib/commands/MSET
lib/commands/MSETNX
lib/commands/PERSIST
lib/commands/PEXPIRE
lib/commands/PEXPIREAT
lib/commands/PFADD
lib/commands/PFCOUNT
lib/commands/PFMERGE
lib/commands/PING
lib/commands/PSETEX
lib/commands/PTTL
lib/commands/PUBLISH
lib/commands/PUBSUB_
CHANNELS
lib/commands/PUBSUB_
NUMPAT
lib/commands/PUBSUB_
NUMSUB
lib/commands/RANDOMKEY
lib/commands/READONLY
lib/commands/READWRITE
lib/commands/RENAME
lib/commands/RENAMENX
lib/commands/REPLICAOF
lib/commands/RESTORE-
ASKING
lib/commands/ROLE
lib/commands/RPOP
lib/commands/RPOPLPUSH
lib/commands/RPOP_
COUNT
lib/commands/RPUSH
lib/commands/RPUSHX
lib/commands/SADD
lib/commands/SAVE
lib/commands/SCAN
lib/commands/SCARD
lib/commands/SCRIPT_
DEBUG
lib/commands/SCRIPT_
EXISTS
lib/commands/SCRIPT_
FLUSH
lib/commands/SCRIPT_
KILL
lib/commands/SCRIPT_
LOAD
lib/commands/SDIFF
lib/commands/SDIFFSTORE
lib/commands/SET
lib/commands/SETBIT
lib/commands/SETEX
lib/commands/SETNX
lib/commands/SETRANGE
lib/commands/SHUTDOWN
lib/commands/SINTER
lib/commands/SINTERSTORE
lib/commands/SISMEMBER
lib/commands/SMEMBERS
lib/commands/SMISMEMBER
lib/commands/SMOVE
lib/commands/SORT
lib/commands/SPOP
lib/commands/SRANDMEMBER
lib/commands/SRANDMEMBER_
COUNT
lib/commands/SREM
lib/commands/SSCAN
lib/commands/STRLEN
lib/commands/SUNION
lib/commands/SUNIONSTORE
lib/commands/SWAPDB
lib/commands/TIME
lib/commands/TOUCH
lib/commands/TTL
lib/commands/TYPE
lib/commands/UNLINK
lib/commands/UNWATCH
lib/commands/WAIT
lib/commands/WATCH
lib/commands/XACK
lib/commands/XADD
lib/commands/XAUTOCLAIM
lib/commands/XAUTOCLAIM_
JUSTID
lib/commands/XCLAIM
lib/commands/XCLAIM_
JUSTID
lib/commands/XDEL
lib/commands/XGROUP_
CREATE
lib/commands/XGROUP_
CREATECONSUMER
lib/commands/XGROUP_
DELCONSUMER
lib/commands/XGROUP_
DESTROY
lib/commands/XGROUP_
SETID
lib/commands/XINFO_
CONSUMERS
lib/commands/XINFO_
GROUPS
lib/commands/XINFO_
STREAM
lib/commands/XLEN
lib/commands/XPENDING
lib/commands/XPENDING_
RANGE
lib/commands/XRANGE
lib/commands/XREAD
lib/commands/XREADGROUP
lib/commands/XREVRANGE
lib/commands/XTRIM
lib/commands/ZADD
lib/commands/ZCARD
lib/commands/ZCOUNT
lib/commands/ZDIFF
lib/commands/ZDIFFSTORE
lib/commands/ZDIFF_
WITHSCORES
lib/commands/ZINCRBY
lib/commands/ZINTER
lib/commands/ZINTERSTORE
lib/commands/ZINTER_
WITHSCORES
lib/commands/ZLEXCOUNT
lib/commands/ZMSCORE
lib/commands/ZPOPMAX
lib/commands/ZPOPMAX_
COUNT
lib/commands/ZPOPMIN
lib/commands/ZPOPMIN_
COUNT
lib/commands/ZRANDMEMBER
lib/commands/ZRANDMEMBER_
COUNT
lib/commands/ZRANDMEMBER_
COUNT_
WITHSCORES
lib/commands/ZRANGE
lib/commands/ZRANGEBYLEX
lib/commands/ZRANGEBYSCORE
lib/commands/ZRANGEBYSCORE_
WITHSCORES
lib/commands/ZRANGESTORE
lib/commands/ZRANGE_
WITHSCORES
lib/commands/ZRANK
lib/commands/ZREM
lib/commands/ZREMRANGEBYLEX
lib/commands/ZREMRANGEBYRANK
lib/commands/ZREMRANGEBYSCORE
lib/commands/ZREVRANK
lib/commands/ZSCAN
lib/commands/ZSCORE
lib/commands/ZUNION
lib/commands/ZUNIONSTORE
lib/commands/ZUNION_
WITHSCORES
lib/commands/generic-
transformers
lib/errors
lib/lua-
script
lib/multi-
command
lib/utils
default
Client
Command
Options
Redis
Client
Options
Client
Legacy
Command
Arguments
Exclude
Mapped
String
Instantiable
Redis
Client
Redis
Client
Command
Signature
Redis
Client
Type
With
Modules
With
Scripts
Generated using
TypeDoc