Methods
bitcount
Parameters
Returns void
Parameters
start: number
end: number
callback: ((err: Error, res: number) => void)
- (err: Error, res: number): void
Returns void
Parameters
Returns Promise<number>
Parameters
Returns Promise<number>
bitfield
Parameters
Returns void
Parameters
Returns Promise<number[]>
get
Parameters
Returns void
Parameters
Returns Promise<string>
getdel
Parameters
Returns void
Parameters
Returns Promise<string>
getBuffer
Parameters
Returns void
Parameters
getex
Parameters
Optional expiryMode: string
Optional time: string | number
Returns Promise<string>
Parameters
Returns void
Parameters
expiryMode: string
time: string | number
Returns void
set
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode?: string | any[], time?: string | number, setMode?: string | number): Promise<"OK">
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, callback: <internal>.IORedis.Callback<"OK">): void
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, setMode: string | any[], callback: <internal>.IORedis.Callback<"OK">): void
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: string | number, callback: <internal>.IORedis.Callback<"OK">): void
- set(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: string | number, setMode: string | number, callback: <internal>.IORedis.Callback<"OK">): void
Parameters
Optional expiryMode: string | any[]
Optional time: string | number
Optional setMode: string | number
Returns Promise<"OK">
Parameters
Returns void
Parameters
Returns void
Parameters
expiryMode: string
time: string | number
Returns void
Parameters
expiryMode: string
time: string | number
setMode: string | number
Returns void
setBuffer
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode?: string | any[], time?: string | number, setMode?: string | number): Promise<<internal>.Buffer>
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, callback: <internal>.IORedis.Callback<<internal>.Buffer>): void
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, setMode: string, callback: <internal>.IORedis.Callback<<internal>.Buffer>): void
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: number, callback: <internal>.IORedis.Callback<<internal>.Buffer>): void
- setBuffer(key: <internal>.IORedis.KeyType, value: <internal>.IORedis.ValueType, expiryMode: string, time: string | number, setMode: string | number, callback: <internal>.IORedis.Callback<<internal>.Buffer>): void
Parameters
Optional expiryMode: string | any[]
Optional time: string | number
Optional setMode: string | number
Parameters
Returns void
Parameters
Returns void
Parameters
expiryMode: string
time: number
Returns void
Parameters
expiryMode: string
time: string | number
setMode: string | number
Returns void
setnx
Parameters
Returns void
Parameters
setex
Parameters
Returns void
Parameters
Returns Promise<"OK">
psetex
Parameters
Returns void
Parameters
Returns Promise<"OK">
append
Parameters
Returns void
Parameters
Returns Promise<number>
strlen
Parameters
Returns void
Parameters
Returns Promise<number>
exists
Parameters
Returns Promise<number>
Parameters
Returns void
setbit
Parameters
Returns void
Parameters
Returns Promise<number>
getbit
Parameters
Returns void
Parameters
Returns Promise<number>
setrange
Parameters
Returns void
Parameters
Returns Promise<number>
getrange
Parameters
Returns void
Parameters
Returns Promise<string>
getrangeBuffer
Parameters
Returns void
Parameters
substr
Parameters
Returns void
Parameters
Returns Promise<string>
incr
Parameters
Returns void
Parameters
Returns Promise<number>
decr
Parameters
Returns void
Parameters
Returns Promise<number>
linsert
Parameters
direction: "BEFORE" | "AFTER"
pivot: string
Returns void
Parameters
direction: "BEFORE" | "AFTER"
pivot: string
Returns Promise<number>
rpop
Parameters
Returns void
Parameters
Returns Promise<string>
Parameters
Returns void
Parameters
Returns Promise<string[]>
lpop
Parameters
Returns void
Parameters
Returns Promise<string>
Parameters
Returns void
Parameters
Returns Promise<string[]>
lpos
Parameters
Optional rank: number
Optional count: number
Optional maxlen: number
Returns Promise<number>
lpopBuffer
Parameters
Returns void
Parameters
brpoplpush
- brpoplpush(source: string, destination: string, timeout: number, callback: <internal>.IORedis.Callback<string>): void
- brpoplpush(source: string, destination: string, timeout: number): Promise<string>
Parameters
source: string
destination: string
timeout: number
Returns void
Parameters
source: string
destination: string
timeout: number
Returns Promise<string>
blmove
Parameters
whereFrom: "LEFT" | "RIGHT"
whereTo: "LEFT" | "RIGHT"
timeout: number
Returns void
Parameters
whereFrom: "LEFT" | "RIGHT"
whereTo: "LEFT" | "RIGHT"
timeout: number
Returns Promise<string>
lmove
Parameters
whereFrom: "LEFT" | "RIGHT"
whereTo: "LEFT" | "RIGHT"
Returns void
Parameters
whereFrom: "LEFT" | "RIGHT"
whereTo: "LEFT" | "RIGHT"
Returns Promise<string>
llen
Parameters
Returns void
Parameters
Returns Promise<number>
lindex
Parameters
Returns void
Parameters
Returns Promise<string>
lindexBuffer
Parameters
Returns void
Parameters
lset
Parameters
Returns void
Parameters
Returns Promise<"OK">
lrange
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
Returns Promise<string[]>
lrangeBuffer
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
ltrim
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
Returns Promise<"OK">
lrem
Parameters
Returns void
Parameters
Returns Promise<number>
rpoplpush
- rpoplpush(source: string, destination: string, callback: <internal>.IORedis.Callback<string>): void
- rpoplpush(source: string, destination: string): Promise<string>
Parameters
source: string
destination: string
Returns void
Parameters
source: string
destination: string
Returns Promise<string>
rpoplpushBuffer
Parameters
source: string
destination: string
Returns void
Parameters
source: string
destination: string
smove
Parameters
source: string
destination: string
member: string
Returns void
Parameters
source: string
destination: string
member: string
sismember
Parameters
Returns void
Parameters
smismember
Parameters
Rest ...members: string[]
scard
Parameters
Returns void
Parameters
Returns Promise<number>
spop
Parameters
Returns void
Parameters
Returns Promise<string>
Parameters
Returns void
Parameters
Returns Promise<string[]>
srandmember
Parameters
Returns void
Parameters
Returns Promise<string>
Parameters
Returns void
Parameters
Returns Promise<string[]>
smembers
Parameters
Returns void
Parameters
Returns Promise<string[]>
zaddBuffer
Parameters
Returns void
Parameters
Returns Promise<string | number>
zincrby
Parameters
increment: number
member: string
Returns void
Parameters
increment: number
member: string
Returns Promise<string>
zpopmin
Parameters
Returns void
Parameters
Returns void
Parameters
Returns Promise<string[]>
zpopmax
Parameters
Returns void
Parameters
Returns void
Parameters
Returns Promise<string[]>
zremrangebyscore
Parameters
min: string | number
max: string | number
Returns void
Parameters
min: string | number
max: string | number
Returns Promise<number>
zremrangebyrank
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
Returns Promise<number>
zremrangebylex
Parameters
Returns Promise<number>
Parameters
Returns void
zrange
- zrange(key: <internal>.IORedis.KeyType, start: number, stop: number, callback: <internal>.IORedis.Callback<string[]>): void
- zrange(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<string[]>): void
- zrange(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores?: "WITHSCORES"): Promise<string[]>
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
withScores: "WITHSCORES"
Returns void
Parameters
start: number
stop: number
Optional withScores: "WITHSCORES"
Returns Promise<string[]>
zrangeBuffer
- zrangeBuffer(key: <internal>.IORedis.KeyType, start: number, stop: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrangeBuffer(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrangeBuffer(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores?: "WITHSCORES"): Promise<<internal>.Buffer[]>
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
withScores: "WITHSCORES"
Returns void
Parameters
start: number
stop: number
Optional withScores: "WITHSCORES"
zrevrange
- zrevrange(key: <internal>.IORedis.KeyType, start: number, stop: number, callback: <internal>.IORedis.Callback<string[]>): void
- zrevrange(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<string[]>): void
- zrevrange(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores?: "WITHSCORES"): Promise<string[]>
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
withScores: "WITHSCORES"
Returns void
Parameters
start: number
stop: number
Optional withScores: "WITHSCORES"
Returns Promise<string[]>
zrevrangeBuffer
- zrevrangeBuffer(key: <internal>.IORedis.KeyType, start: number, stop: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrevrangeBuffer(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrevrangeBuffer(key: <internal>.IORedis.KeyType, start: number, stop: number, withScores?: "WITHSCORES"): Promise<<internal>.Buffer[]>
Parameters
start: number
stop: number
Returns void
Parameters
start: number
stop: number
withScores: "WITHSCORES"
Returns void
Parameters
start: number
stop: number
Optional withScores: "WITHSCORES"
zrangebyscore
- zrangebyscore(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores?: "WITHSCORES"): Promise<string[]>
- zrangebyscore(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number): Promise<string[]>
- zrangebyscore(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, limit: "LIMIT", offset: number, count: number): Promise<string[]>
- zrangebyscore(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, callback: <internal>.IORedis.Callback<string[]>): void
- zrangebyscore(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<string[]>): void
- zrangebyscore(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<string[]>): void
- zrangebyscore(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<string[]>): void
Parameters
min: string | number
max: string | number
Optional withScores: "WITHSCORES"
Returns Promise<string[]>
Parameters
min: string | number
max: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Returns Promise<string[]>
Parameters
min: string | number
max: string | number
limit: "LIMIT"
offset: number
count: number
Returns Promise<string[]>
Parameters
min: string | number
max: string | number
Returns void
Parameters
min: string | number
max: string | number
withScores: "WITHSCORES"
Returns void
Parameters
min: string | number
max: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Returns void
Parameters
min: string | number
max: string | number
limit: "LIMIT"
offset: number
count: number
Returns void
zrangebyscoreBuffer
- zrangebyscoreBuffer(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores?: "WITHSCORES"): Promise<<internal>.Buffer[]>
- zrangebyscoreBuffer(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number): Promise<<internal>.Buffer[]>
- zrangebyscoreBuffer(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, limit: "LIMIT", offset: number, count: number): Promise<<internal>.Buffer[]>
- zrangebyscoreBuffer(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrangebyscoreBuffer(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrangebyscoreBuffer(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrangebyscoreBuffer(key: <internal>.IORedis.KeyType, min: string | number, max: string | number, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
Parameters
min: string | number
max: string | number
Optional withScores: "WITHSCORES"
Parameters
min: string | number
max: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Parameters
min: string | number
max: string | number
limit: "LIMIT"
offset: number
count: number
Parameters
min: string | number
max: string | number
Returns void
Parameters
min: string | number
max: string | number
withScores: "WITHSCORES"
Returns void
Parameters
min: string | number
max: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Returns void
Parameters
min: string | number
max: string | number
limit: "LIMIT"
offset: number
count: number
Returns void
zrevrangebyscore
- zrevrangebyscore(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores?: "WITHSCORES"): Promise<string[]>
- zrevrangebyscore(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number): Promise<string[]>
- zrevrangebyscore(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, limit: "LIMIT", offset: number, count: number): Promise<string[]>
- zrevrangebyscore(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, callback: <internal>.IORedis.Callback<string[]>): void
- zrevrangebyscore(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<string[]>): void
- zrevrangebyscore(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<string[]>): void
- zrevrangebyscore(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<string[]>): void
Parameters
max: string | number
min: string | number
Optional withScores: "WITHSCORES"
Returns Promise<string[]>
Parameters
max: string | number
min: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Returns Promise<string[]>
Parameters
max: string | number
min: string | number
limit: "LIMIT"
offset: number
count: number
Returns Promise<string[]>
Parameters
max: string | number
min: string | number
Returns void
Parameters
max: string | number
min: string | number
withScores: "WITHSCORES"
Returns void
Parameters
max: string | number
min: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Returns void
Parameters
max: string | number
min: string | number
limit: "LIMIT"
offset: number
count: number
Returns void
zrevrangebyscoreBuffer
- zrevrangebyscoreBuffer(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores?: "WITHSCORES"): Promise<<internal>.Buffer[]>
- zrevrangebyscoreBuffer(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number): Promise<<internal>.Buffer[]>
- zrevrangebyscoreBuffer(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, limit: "LIMIT", offset: number, count: number): Promise<<internal>.Buffer[]>
- zrevrangebyscoreBuffer(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrevrangebyscoreBuffer(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores: "WITHSCORES", callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrevrangebyscoreBuffer(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, withScores: "WITHSCORES", limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrevrangebyscoreBuffer(key: <internal>.IORedis.KeyType, max: string | number, min: string | number, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
Parameters
max: string | number
min: string | number
Optional withScores: "WITHSCORES"
Parameters
max: string | number
min: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Parameters
max: string | number
min: string | number
limit: "LIMIT"
offset: number
count: number
Parameters
max: string | number
min: string | number
Returns void
Parameters
max: string | number
min: string | number
withScores: "WITHSCORES"
Returns void
Parameters
max: string | number
min: string | number
withScores: "WITHSCORES"
limit: "LIMIT"
offset: number
count: number
Returns void
Parameters
max: string | number
min: string | number
limit: "LIMIT"
offset: number
count: number
Returns void
zrangebylex
- zrangebylex(key: <internal>.IORedis.KeyType, min: string, max: string): Promise<string[]>
- zrangebylex(key: <internal>.IORedis.KeyType, min: string, max: string, limit: "LIMIT", offset: number, count: number): Promise<string[]>
- zrangebylex(key: <internal>.IORedis.KeyType, min: string, max: string, callback: <internal>.IORedis.Callback<string[]>): void
- zrangebylex(key: <internal>.IORedis.KeyType, min: string, max: string, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<string[]>): void
Parameters
Returns Promise<string[]>
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
Returns Promise<string[]>
Parameters
Returns void
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
Returns void
zrangebylexBuffer
- zrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string): Promise<<internal>.Buffer[]>
- zrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string, limit: "LIMIT", offset: number, count: number): Promise<<internal>.Buffer[]>
- zrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
Parameters
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
Parameters
Returns void
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
Returns void
zrevrangebylex
- zrevrangebylex(key: <internal>.IORedis.KeyType, max: string, min: string): Promise<string[]>
- zrevrangebylex(key: <internal>.IORedis.KeyType, max: string, min: string, limit: "LIMIT", offset: number, count: number): Promise<string[]>
- zrevrangebylex(key: <internal>.IORedis.KeyType, max: string, min: string, callback: <internal>.IORedis.Callback<string[]>): void
- zrevrangebylex(key: <internal>.IORedis.KeyType, max: string, min: string, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<string[]>): void
Parameters
Returns Promise<string[]>
Parameters
max: string
min: string
limit: "LIMIT"
offset: number
count: number
Returns Promise<string[]>
Parameters
Returns void
Parameters
max: string
min: string
limit: "LIMIT"
offset: number
count: number
Returns void
zrevrangebylexBuffer
- zrevrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string): Promise<<internal>.Buffer[]>
- zrevrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string, limit: "LIMIT", offset: number, count: number): Promise<<internal>.Buffer[]>
- zrevrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
- zrevrangebylexBuffer(key: <internal>.IORedis.KeyType, min: string, max: string, limit: "LIMIT", offset: number, count: number, callback: <internal>.IORedis.Callback<<internal>.Buffer[]>): void
Parameters
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
Parameters
Returns void
Parameters
min: string
max: string
limit: "LIMIT"
offset: number
count: number
Returns void
zcount
Parameters
min: string | number
max: string | number
Returns void
Parameters
min: string | number
max: string | number
Returns Promise<number>
zcard
Parameters
Returns void
Parameters
Returns Promise<number>
zscore
Parameters
Returns void
Parameters
Returns Promise<string>
zrank
Parameters
Returns void
Parameters
Returns Promise<number>
zrevrank
Parameters
Returns void
Parameters
Returns Promise<number>
hsetBuffer
Parameters
Returns void
Parameters
hsetnx
Parameters
Returns void
Parameters
hget
Parameters
Returns void
Parameters
Returns Promise<string>
hgetBuffer
Parameters
Returns void
Parameters
hstrlen
Parameters
Returns void
Parameters
Returns Promise<number>
hincrby
Parameters
field: string
increment: number
Returns void
Parameters
field: string
increment: number
Returns Promise<number>
hincrbyfloat
Parameters
field: string
increment: number
Returns void
Parameters
field: string
increment: number
Returns Promise<number>
hlen
Parameters
Returns void
Parameters
Returns Promise<number>
hkeys
Parameters
Returns void
Parameters
Returns Promise<string[]>
hvals
Parameters
Returns void
Parameters
Returns Promise<string[]>
hgetall
Parameters
Returns void
Parameters
Returns Promise<<internal>.Record<string, string>>
hexists
Parameters
Returns void
Parameters
geoadd
Parameters
longitude: number
latitude: number
member: string
Returns void
Parameters
longitude: number
latitude: number
member: string
Returns Promise<number>
geodist
Parameters
member1: string
member2: string
unit: "m" | "km" | "ft" | "mi"
Returns void
Parameters
member1: string
member2: string
unit: "m" | "km" | "ft" | "mi"
Returns Promise<string>
georadius
- georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", callback: <internal>.IORedis.Callback<string[]>): void
- georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", sort?: "ASC" | "DESC"): Promise<string[]>
- georadius(key: <internal>.IORedis.KeyType, longitude: number, latitude: number, radius: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, sort?: "ASC" | "DESC"): Promise<string[]>
Parameters
longitude: number
latitude: number
radius: number
unit: "m" | "km" | "ft" | "mi"
Returns void
Parameters
longitude: number
latitude: number
radius: number
unit: "m" | "km" | "ft" | "mi"
Optional sort: "ASC" | "DESC"
Returns Promise<string[]>
Parameters
longitude: number
latitude: number
radius: number
unit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
Optional sort: "ASC" | "DESC"
Returns Promise<string[]>
georadiusbymember
- georadiusbymember(key: <internal>.IORedis.KeyType, member: string, radius: number, unit: "m" | "km" | "ft" | "mi", callback: <internal>.IORedis.Callback<string[]>): void
- georadiusbymember(key: <internal>.IORedis.KeyType, member: string, radius: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number, callback: <internal>.IORedis.Callback<string[]>): void
- georadiusbymember(key: <internal>.IORedis.KeyType, member: string, radius: number, unit: "m" | "km" | "ft" | "mi"): Promise<string[]>
- georadiusbymember(key: <internal>.IORedis.KeyType, member: string, radius: number, unit: "m" | "km" | "ft" | "mi", count: "COUNT", countValue: number): Promise<string[]>
Parameters
member: string
radius: number
unit: "m" | "km" | "ft" | "mi"
Returns void
Parameters
member: string
radius: number
unit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
Returns void
Parameters
member: string
radius: number
unit: "m" | "km" | "ft" | "mi"
Returns Promise<string[]>
Parameters
member: string
radius: number
unit: "m" | "km" | "ft" | "mi"
count: "COUNT"
countValue: number
Returns Promise<string[]>
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"): Promise<string[] | (string[] | string[][])[]>
- 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"): Promise<string[] | (string[] | string[][])[]>
- 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"): Promise<string[] | (string[] | string[][])[]>
- 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"): Promise<string[] | (string[] | string[][])[]>
- 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"): Promise<string[] | (string[] | string[][])[]>
- 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"): Promise<string[] | (string[] | string[][])[]>
- 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"): Promise<string[] | (string[] | string[][])[]>
- 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"): Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
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"
Returns Promise<string[] | (string[] | string[][])[]>
incrby
Parameters
Returns void
Parameters
Returns Promise<number>
incrbyfloat
Parameters
Returns void
Parameters
Returns Promise<number>
decrby
Parameters
Returns void
Parameters
Returns Promise<number>
getset
Parameters
Returns void
Parameters
Returns Promise<string>
memory
Parameters
Returns Promise<number>
randomkey
Parameters
Returns void
Returns Promise<string>
select
Parameters
Returns void
Parameters
Returns Promise<"OK">
move
Parameters
Returns void
Parameters
rename
Parameters
Returns void
Parameters
Returns Promise<"OK">
renamenx
Parameters
Returns void
Parameters
expire
Parameters
Returns void
Parameters
pexpire
Parameters
Returns void
Parameters
expireat
Parameters
Returns void
Parameters
pexpireat
Parameters
millisecondsTimestamp: number
Returns void
Parameters
millisecondsTimestamp: number
keys
Parameters
Returns void
Parameters
Returns Promise<string[]>
dbsize
Parameters
Returns void
Returns Promise<number>
auth
- auth(username: string, password: string, callback: <internal>.IORedis.Callback<string>): void
- auth(password: string, callback: <internal>.IORedis.Callback<string>): void
- auth(username: string, password: string): Promise<string>
- auth(password: string): Promise<string>
Parameters
username: string
password: string
Returns void
Parameters
Returns void
Parameters
username: string
password: string
Returns Promise<string>
Parameters
Returns Promise<string>
ping
Parameters
Returns void
Parameters
Returns void
Parameters
Returns Promise<string>
echo
Parameters
Returns void
Parameters
Returns Promise<string>
save
Parameters
Returns void
Returns Promise<string>
bgsave
Parameters
Returns void
Returns Promise<string>
bgrewriteaof
Parameters
Returns void
Returns Promise<string>
shutdown
- shutdown(save: "SAVE" | "NOSAVE", callback: <internal>.IORedis.Callback<never>): void
- shutdown(save: "SAVE" | "NOSAVE"): Promise<never>
Parameters
Returns void
Parameters
Returns Promise<never>
lastsave
Parameters
Returns void
Returns Promise<number>
type
Parameters
Returns void
Parameters
Returns Promise<string>
multi
Parameters
Optional commands: string[][]
Parameters
options: { pipeline: false }
Returns Promise<"OK">
exec
Parameters
Returns void
Returns Promise<[Error, string][]>
discard
Parameters
Returns void
Returns Promise<"OK">
sync
Parameters
Returns void
Returns Promise<any>
flushdb
Parameters
Returns void
Parameters
Optional option: "async" | "sync"
Returns Promise<"OK">
flushall
Parameters
Returns void
Returns Promise<"OK">
info
Parameters
Returns void
Parameters
Returns void
Parameters
Returns Promise<string>
time
Parameters
Returns void
Returns Promise<[string, string]>
monitor
Parameters
Returns void
ttl
Parameters
Returns void
Parameters
Returns Promise<number>
pttl
Parameters
Returns void
Parameters
Returns Promise<number>
persist
Parameters
Returns void
Parameters
slaveof
- slaveof(host: string, port: number, callback: <internal>.IORedis.Callback<string>): void
- slaveof(host: string, port: number): Promise<string>
Parameters
Returns void
Parameters
Returns Promise<string>
config
Parameters
Returns Promise<string[]>
Parameters
Returns void
Parameters
op: "REWRITE" | "RESETSTAT"
Returns Promise<"OK">
Parameters
op: "REWRITE" | "RESETSTAT"
Returns void
Parameters
Returns Promise<"OK">
Parameters
Returns void
publish
- publish(channel: string, message: string, callback: <internal>.IORedis.Callback<number>): void
- publish(channel: string, message: string): Promise<number>
Parameters
channel: string
message: string
Returns void
Parameters
channel: string
message: string
Returns Promise<number>
publishBuffer
Parameters
Returns Promise<number>
unwatch
Parameters
Returns void
Returns Promise<string>
dump
Parameters
Returns void
Parameters
Returns Promise<string>
quit
Parameters
Returns void
Returns Promise<"OK">
scan
- scan(cursor: string | number): Promise<[string, string[]]>
- scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string): Promise<[string, string[]]>
- scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string, callback: <internal>.IORedis.Callback<[string, string[]]>): void
- scan(cursor: string | number, countOption: "count" | "COUNT", count: number): Promise<[string, string[]]>
- scan(cursor: string | number, countOption: "count" | "COUNT", count: number, callback: <internal>.IORedis.Callback<[string, string[]]>): void
- scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string, countOption: "count" | "COUNT", count: number): Promise<[string, string[]]>
- scan(cursor: string | number, matchOption: "match" | "MATCH", pattern: string, countOption: "count" | "COUNT", count: number, callback: <internal>.IORedis.Callback<[string, string[]]>): void
- scan(cursor: string | number, countOption: "count" | "COUNT", count: number, matchOption: "match" | "MATCH", pattern: string): Promise<[string, string[]]>
- scan(cursor: string | number, countOption: "count" | "COUNT", count: number, matchOption: "match" | "MATCH", pattern: string, callback: <internal>.IORedis.Callback<[string, string[]]>): void
Parameters
Returns Promise<[string, string[]]>
Parameters
cursor: string | number
matchOption: "match" | "MATCH"
pattern: string
Returns Promise<[string, string[]]>
Parameters
cursor: string | number
matchOption: "match" | "MATCH"
pattern: string
Returns void
Parameters
cursor: string | number
countOption: "count" | "COUNT"
count: number
Returns Promise<[string, string[]]>
Parameters
cursor: string | number
countOption: "count" | "COUNT"
count: number
Returns void
Parameters
cursor: string | number
matchOption: "match" | "MATCH"
pattern: string
countOption: "count" | "COUNT"
count: number
Returns Promise<[string, string[]]>
Parameters
cursor: string | number
matchOption: "match" | "MATCH"
pattern: string
countOption: "count" | "COUNT"
count: number
Returns void
Parameters
cursor: string | number
countOption: "count" | "COUNT"
count: number
matchOption: "match" | "MATCH"
pattern: string
Returns Promise<[string, string[]]>
Parameters
cursor: string | number
countOption: "count" | "COUNT"
count: number
matchOption: "match" | "MATCH"
pattern: string
Returns void
pipeline
Parameters
Optional commands: string[][]
scanStream
Parameters
sscanStream
Parameters
hscanStream
Parameters
zscanStream
Parameters
xlen
Parameters
Returns Promise<number>
Parameters
Returns void
Properties
del
unlink
mget
mgetBuffer
rpush
rpushBuffer
lpush
lpushBuffer
rpushx
lpushx
brpop
blpop
sadd
srem
sinter
sinterstore
sunion
sunionstore
sdiff
sdiffstore
zadd
bzpopmin
bzpopmax
zrem
zunionstore
zinterstore
zmscore
hset
hmset
hmget
hmgetBuffer
hdel
geohash
geopos
mset
msetBuffer
msetnx
sort
debug
subscribe
unsubscribe
psubscribe
punsubscribe
watch
cluster
restore
migrate
object
client
eval
evalsha
script
sscan
hscan
zscan
pfmerge
pfadd
pfcount
xack
xadd
xclaim
xautoclaim
xdel
xgroup
xinfo
xpending
xrange
xread
xreadgroup
xrevrange
xtrim
https://redis.io/commands/geosearch