Properties
Readonly redis
Readonly isCluster
isCluster: boolean
Readonly options
Readonly length
length: number
Methods
bitcount
Parameters
Parameters
bitfield
Parameters
get
Parameters
getBuffer
Parameters
getex
Parameters
expiryMode: string
time: number
set
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, callback?: <internal>.IORedis.Callback<string>): <internal>.IORedis.Pipeline
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, setMode: string, callback?: <internal>.IORedis.Callback<string>): <internal>.IORedis.Pipeline
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: number, callback?: <internal>.IORedis.Callback<string>): <internal>.IORedis.Pipeline
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: number, setMode: string, callback?: <internal>.IORedis.Callback<string>): <internal>.IORedis.Pipeline
Parameters
Parameters
Parameters
expiryMode: string
time: number
Parameters
expiryMode: string
time: number
setMode: string
setBuffer
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, callback?: <internal>.IORedis.Callback<<internal>.Buffer>): <internal>.IORedis.Pipeline
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, setMode: string, callback?: <internal>.IORedis.Callback<<internal>.Buffer>): <internal>.IORedis.Pipeline
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: number, callback?: <internal>.IORedis.Callback<<internal>.Buffer>): <internal>.IORedis.Pipeline
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: number, setMode: string, callback?: <internal>.IORedis.Callback<<internal>.Buffer>): <internal>.IORedis.Pipeline
Parameters
Parameters
Parameters
expiryMode: string
time: number
Parameters
expiryMode: string
time: number
setMode: string
setnx
Parameters
setex
Parameters
psetex
Parameters
append
Parameters
strlen
Parameters
del
Parameters
unlink
Parameters
exists
Parameters
setbit
Parameters
getbit
Parameters
setrange
Parameters
getrange
Parameters
getrangeBuffer
Parameters
substr
Parameters
incr
Parameters
decr
Parameters
mget
Parameters
mgetBuffer
Parameters
rpush
Parameters
rpushBuffer
Parameters
lpush
Parameters
rpushx
Parameters
Parameters
lpushx
Parameters
Parameters
linsert
Parameters
direction: "BEFORE" | "AFTER"
pivot: string
rpop
Parameters
lpop
Parameters
lpopBuffer
Parameters
brpop
Parameters
blpop
Parameters
brpoplpush
Parameters
source: string
destination: string
timeout: number
llen
Parameters
lindex
Parameters
lset
Parameters
lrange
Parameters
start: number
stop: number
lrangeBuffer
Parameters
start: number
stop: number
ltrim
Parameters
start: number
stop: number
lrem
Parameters
rpoplpush
Parameters
source: string
destination: string
sadd
Parameters
srem
Parameters
smove
Parameters
source: string
destination: string
member: string
sismember
Parameters
scard
Parameters
spop
Parameters
Parameters
srandmember
Parameters
Parameters
sinter
Parameters
sinterstore
Parameters
sunion
Parameters
sunionstore
Parameters
sdiff
Parameters
sdiffstore
Parameters
smembers
Parameters
zadd
Parameters
Rest ...scoresAndMembers: (string | number)[]
zincrby
Parameters
increment: number
member: string
zpopmin
Parameters
zpopmax
Parameters
bzpopmin
Parameters
bzpopmax
Parameters
zrem
Parameters
zremrangebyscore
Parameters
min: string | number
max: string | number
zremrangebyrank
Parameters
start: number
stop: number
zremrangebylex
Parameters
zunionstore
Parameters
destination: string
numkeys: number
Rest ...args: string[]
zinterstore
Parameters
destination: string
numkeys: number
Rest ...args: string[]
zrange
Parameters
start: number
stop: number
Parameters
start: number
stop: number
withScores: "WITHSCORES"
zrevrange
Parameters
start: number
stop: number
Parameters
start: number
stop: number
withScores: "WITHSCORES"
zrangebyscore
Parameters
min: string | number
max: string | number
Rest ...args: string[]
zrevrangebyscore
Parameters
max: string | number
min: string | number
Rest ...args: string[]
zrangebylex
Parameters
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
zrevrangebylex
Parameters
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
zcount
Parameters
min: string | number
max: string | number
zcard
Parameters
zscore
Parameters
zmscore
Parameters
Rest ...members: string[]
zrank
Parameters
zrevrank
Parameters
hset
Parameters
Parameters
data: object | Map<string, any>
Parameters
hsetBuffer
Parameters
hsetnx
Parameters
hget
Parameters
hgetBuffer
Parameters
hmset
Parameters
Parameters
data: object | Map<string, any>
hmget
Parameters
hstrlen
Parameters
hincrby
Parameters
field: string
increment: number
hincrbyfloat
Parameters
field: string
increment: number
hdel
Parameters
hlen
Parameters
hkeys
Parameters
hvals
Parameters
hgetall
Parameters
hexists
Parameters
geoadd
Parameters
longitude: number
latitude: number
member: string
geodist
Parameters
member1: string
member2: string
unit: "m" | "km" | "ft" | "mi"
geohash
Parameters
geopos
Parameters
georadius
- georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", callback?: <internal>.IORedis.Callback<string[]>): <internal>.IORedis.Pipeline
- georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, callback?: <internal>.IORedis.Callback<string[]>): <internal>.IORedis.Pipeline
Parameters
longitude: number
latitude: number
radius: number
unit: "m" | "km" | "ft" | "mi"
Parameters
longitude: number
latitude: number
radius: number
unit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
georadiusbymember
- georadiusbymember(key: <internal>.IORedis.KeyType, member: string, radius: number, unit: "m" | "km" | "ft" | "mi", callback?: <internal>.IORedis.Callback<string[]>): <internal>.IORedis.Pipeline
- georadiusbymember(key: <internal>.IORedis.KeyType, member: string, radius: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, callback?: <internal>.IORedis.Callback<string[]>): <internal>.IORedis.Pipeline
Parameters
member: string
radius: number
unit: "m" | "km" | "ft" | "mi"
Parameters
member: string
radius: number
unit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
geosearch
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMMEMBER", member: string, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYRADIUS", radius: number, radiusUnit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
- geosearch(key: <internal>.IORedis.KeyType, from: "FROMLONLAT", longitude: number, latitude: number, by: "BYBOX", width: number, height: number, unit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC", withCoord?: "WITHCOORD", withDist?: "WITHDIST", withHash?: "WITHHASH"): <internal>.IORedis.Pipeline
Parameters
from: "FROMMEMBER"
member: string
by: "BYRADIUS"
radius: number
radiusUnit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
Parameters
from: "FROMMEMBER"
member: string
by: "BYBOX"
width: number
height: number
unit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
Parameters
from: "FROMLONLAT"
longitude: number
latitude: number
by: "BYRADIUS"
radius: number
radiusUnit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
Parameters
from: "FROMLONLAT"
longitude: number
latitude: number
by: "BYBOX"
width: number
height: number
unit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
Parameters
from: "FROMMEMBER"
member: string
by: "BYRADIUS"
radius: number
radiusUnit: "m" | "km" | "ft" | "mi"
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
Parameters
from: "FROMMEMBER"
member: string
by: "BYBOX"
width: number
height: number
unit: "m" | "km" | "ft" | "mi"
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
Parameters
from: "FROMLONLAT"
longitude: number
latitude: number
by: "BYRADIUS"
radius: number
radiusUnit: "m" | "km" | "ft" | "mi"
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
Parameters
from: "FROMLONLAT"
longitude: number
latitude: number
by: "BYBOX"
width: number
height: number
unit: "m" | "km" | "ft" | "mi"
Optional sort: "ASC" | "DESC"
Optional withCoord: "WITHCOORD"
Optional withDist: "WITHDIST"
Optional withHash: "WITHHASH"
incrby
Parameters
incrbyfloat
Parameters
decrby
Parameters
getset
Parameters
mset
Parameters
Parameters
data: object | Map<string, any>
msetBuffer
Parameters
msetnx
Parameters
Parameters
data: object | Map<string, any>
memory
Parameters
randomkey
Parameters
select
Parameters
move
Parameters
rename
Parameters
renamenx
Parameters
expire
Parameters
pexpire
Parameters
expireat
Parameters
pexpireat
Parameters
millisecondsTimestamp: number
keys
Parameters
dbsize
Parameters
auth
Parameters
Parameters
username: string
password: string
ping
Parameters
Parameters
echo
Parameters
save
Parameters
bgsave
Parameters
bgrewriteaof
Parameters
shutdown
Parameters
lastsave
Parameters
type
Parameters
multi
Parameters
exec
Parameters
Returns Promise<[Error, any][]>
discard
Parameters
sync
Parameters
flushdb
Parameters
flushall
Parameters
sort
Parameters
info
Parameters
Parameters
time
Parameters
monitor
Parameters
ttl
Parameters
pttl
Parameters
persist
Parameters
slaveof
Parameters
debug
Parameters
config
Parameters
subscribe
Parameters
unsubscribe
Parameters
Rest ...channels: string[]
psubscribe
Parameters
Rest ...patterns: string[]
punsubscribe
Parameters
Rest ...patterns: string[]
publish
Parameters
channel: string
message: string
watch
Parameters
unwatch
Parameters
cluster
Parameters
restore
Parameters
migrate
Parameters
dump
Parameters
object
Parameters
client
Parameters
eval
Parameters
script: string
numKeys: number
evalsha
Parameters
scriptSha: string
numKeys: string
script
Parameters
quit
Parameters
scan
- scan(cursor: string | number): <internal>.IORedis.Pipeline
- scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string): <internal>.IORedis.Pipeline
- scan(cursor: string | number, countOption: "count" | "COUNT", count: number): <internal>.IORedis.Pipeline
- scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string, countOption: "count" | "COUNT", count: number): <internal>.IORedis.Pipeline
- scan(cursor: string | number, countOption: "count" | "COUNT", count: number, matchOption: "match" | "MATCH", pattern: string): <internal>.IORedis.Pipeline
Parameters
Parameters
cursor: string | number
matchOption: "match" | "MATCH"
pattern: string
Parameters
cursor: string | number
countOption: "count" | "COUNT"
count: number
Parameters
cursor: string | number
matchOption: "match" | "MATCH"
pattern: string
countOption: "count" | "COUNT"
count: number
Parameters
cursor: string | number
countOption: "count" | "COUNT"
count: number
matchOption: "match" | "MATCH"
pattern: string
sscan
Parameters
hscan
Parameters
zscan
Parameters
pfmerge
Parameters
pfadd
Parameters
Rest ...elements: string[]
pfcount
Parameters
xack
Parameters
group: string
Rest ...ids: string[]
xadd
Parameters
xclaim
Parameters
group: string
consumer: string
minIdleTime: number
id: string
xdel
Parameters
xgroup
Parameters
xinfo
Parameters
xlen
Parameters
xpending
Parameters
xrange
Parameters
xread
Parameters
xreadgroup
Parameters
command: "GROUP" | "group"
group: string
consumer: string
xrevrange
Parameters
xtrim
Parameters
strategy: "MAXLEN" | "maxlen"
https://redis.io/commands/geosearch