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/cluster/cluster-slots
default
Class default<M, S>
Type parameters
M
:
RedisModules
S
:
RedisScripts
Hierarchy
default
Index
Constructors
constructor
Properties
#
Client
#node
By
Url
#on
Error
#options
#random
Client
Iterator
#running
Rediscover
Promise
#slots
Methods
#client
Options
Defaults
#discover
Nodes
#get
Random
Client
#get
Slot
Client
#initiate
Client
#initiate
Client
For
Node
#rediscover
#reset
#slot
Client
Iterator
connect
disconnect
get
Client
get
Masters
get
Node
By
Url
get
Slot
Master
rediscover
Constructors
constructor
new default
<
M
,
S
>
(
options
:
RedisClusterOptions
<
M
,
S
>
, onError
:
OnError
)
:
default
<
M
,
S
>
Type parameters
M
:
RedisModules
S
:
RedisScripts
Parameters
options:
RedisClusterOptions
<
M
,
S
>
onError:
OnError
Returns
default
<
M
,
S
>
Properties
Private
Readonly
#
Client
#
Client
:
InstantiableRedisClient
<
M
,
S
>
Private
Readonly
#node
By
Url
#node
By
Url
:
Map
<
string
,
ClusterNode
<
M
,
S
>
>
= ...
Private
Readonly
#on
Error
#on
Error
:
OnError
Private
Readonly
#options
#options
:
RedisClusterOptions
<
M
,
S
>
Private
Optional
#random
Client
Iterator
#random
Client
Iterator
?:
IterableIterator
<
ClusterNode
<
M
,
S
>
>
Private
Optional
#running
Rediscover
Promise
#running
Rediscover
Promise
?:
Promise
<
void
>
Private
Readonly
#slots
#slots
:
SlotNodes
<
M
,
S
>
[]
= []
Methods
Private
#client
Options
Defaults
#client
Options
Defaults
(
options
?:
RedisClusterClientOptions
)
:
undefined
|
RedisClusterClientOptions
Parameters
Optional
options:
RedisClusterClientOptions
Returns
undefined
|
RedisClusterClientOptions
Private
#discover
Nodes
#discover
Nodes
(
clientOptions
?:
RedisClusterClientOptions
)
:
Promise
<
boolean
>
Parameters
Optional
clientOptions:
RedisClusterClientOptions
Returns
Promise
<
boolean
>
Private
#get
Random
Client
#get
Random
Client
(
)
:
RedisClientType
<
M
,
S
>
Returns
RedisClientType
<
M
,
S
>
Private
#get
Slot
Client
#get
Slot
Client
(
slotNumber
:
number
)
:
RedisClientType
<
M
,
S
>
Parameters
slotNumber:
number
Returns
RedisClientType
<
M
,
S
>
Private
#initiate
Client
#initiate
Client
(
options
?:
RedisClusterClientOptions
)
:
RedisClientType
<
M
,
S
>
Parameters
Optional
options:
RedisClusterClientOptions
Returns
RedisClientType
<
M
,
S
>
Private
#initiate
Client
For
Node
#initiate
Client
For
Node
(
nodeData
:
RedisClusterMasterNode
|
RedisClusterReplicaNode
, readonly
:
boolean
, clientsInUse
:
Set
<
string
>
, promises
:
Promise
<
void
>
[]
)
:
ClusterNode
<
M
,
S
>
Parameters
nodeData:
RedisClusterMasterNode
|
RedisClusterReplicaNode
readonly:
boolean
clientsInUse:
Set
<
string
>
promises:
Promise
<
void
>
[]
Returns
ClusterNode
<
M
,
S
>
Private
#rediscover
#rediscover
(
startWith
:
RedisClientType
<
M
,
S
>
)
:
Promise
<
void
>
Parameters
startWith:
RedisClientType
<
M
,
S
>
Returns
Promise
<
void
>
Private
#reset
#reset
(
masters
:
RedisClusterMasterNode
[]
)
:
Promise
<
void
>
Parameters
masters:
RedisClusterMasterNode
[]
Returns
Promise
<
void
>
Private
#slot
Client
Iterator
#slot
Client
Iterator
(
slotNumber
:
number
)
:
IterableIterator
<
RedisClientType
<
M
,
S
>
>
Parameters
slotNumber:
number
Returns
IterableIterator
<
RedisClientType
<
M
,
S
>
>
connect
connect
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
disconnect
disconnect
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Client
get
Client
(
firstKey
?:
RedisCommandArgument
, isReadonly
?:
boolean
)
:
RedisClientType
<
M
,
S
>
Parameters
Optional
firstKey:
RedisCommandArgument
Optional
isReadonly:
boolean
Returns
RedisClientType
<
M
,
S
>
get
Masters
get
Masters
(
)
:
ClusterNode
<
M
,
S
>
[]
Returns
ClusterNode
<
M
,
S
>
[]
get
Node
By
Url
get
Node
By
Url
(
url
:
string
)
:
undefined
|
ClusterNode
<
M
,
S
>
Parameters
url:
string
Returns
undefined
|
ClusterNode
<
M
,
S
>
get
Slot
Master
get
Slot
Master
(
slot
:
number
)
:
ClusterNode
<
M
,
S
>
Parameters
slot:
number
Returns
ClusterNode
<
M
,
S
>
rediscover
rediscover
(
startWith
:
RedisClientType
<
M
,
S
>
)
:
Promise
<
void
>
Parameters
startWith:
RedisClientType
<
M
,
S
>
Returns
Promise
<
void
>
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
constructor
#
Client
#node
By
Url
#on
Error
#options
#random
Client
Iterator
#running
Rediscover
Promise
#slots
#client
Options
Defaults
#discover
Nodes
#get
Random
Client
#get
Slot
Client
#initiate
Client
#initiate
Client
For
Node
#rediscover
#reset
#slot
Client
Iterator
connect
disconnect
get
Client
get
Masters
get
Node
By
Url
get
Slot
Master
rediscover
Generated using
TypeDoc