Interface IORedisClientType
interface IORedisClientType { call(command: string,
...args: any[]): Promise<any>; del(key: string): Promise<number>; exec(): Promise<unknown[]>; exists(key: string): Promise<number>; flushdb(): Promise<string>; get(key: string): Promise<string>; hdel(key: string,
itemId: string): Promise<number>; hget(key: string,
itemId: string): Promise<string>; hgetall(key: string): Promise<StringStringType>; hincrbyfloat(key: string,
itemId: string,
value: number): Promise<number>; hmget(key: string,
itemIds: string[]): Promise<string[]>; hset(key: string,
values: Record<string, string>): this; lpush(key: string,
...args: string[]): Promise<number>; lrange(key: string,
start: number,
end: number): Promise<string[]>; multi(): IORedisMultiType; on(event: string,
callback: ((...args: any[]) => void)): void; psubscribe(pattern: string,
callback: ((channel: string,
message: string) => void)): Promise<void>; publish(channel: string,
message: string): Promise<number>; punsubscribe(pattern: string): void; punsubscribe(channel: string): void; quit(): Promise<string>; rpush(key: string,
...args: string[]): Promise<number>; sendCommand(args: any[]): Promise<any>; set(key: string,
value: string): Promise<string>; subscribe(channel: string,
callback: ((channel: string,
message: string) => void)): void; unsubscribe(channel: string): void; xack(key: string,
group: string,
id: string): Promise<number>; xadd(key: string,
id: string,
fields: any,
message?: string): Promise<string>; xclaim(key: string,
group: string,
consumer: string,
minIdleTime: number,
id: string,
...args: string[]): Promise<ReclaimedMessageType>; xdel(key: string,
id: string): Promise<number>; xgroup(command: string,
key: string,
groupName: string,
id: string,
mkStream?: "MKSTREAM"): Promise<string>; xinfo(command: string,
key: string): Promise<unknown>; xlen(key: string): Promise<number>; xpending(key: string,
group: string,
start?: string,
end?: string,
count?: number,
consumer?: string): Promise<unknown[] | [string, string, number, number] | [string, string, number, [string, number][]][]>; xrange(key: string,
start: string,
end: string): Promise<string[][]>; zadd(...args: (string | number)[]): Promise<number>; zrange(key: string,
start: number,
end: number,
withScores?: "WITHSCORES"): Promise<string[]>; zrank(key: string,
member: string): Promise<number>; zscore(key: string,
value: string): Promise<number>; } Methods
call
- call(command, ...args): Promise<any>
Parameters
- command: string
Rest
...args: any[]
Returns Promise<any>
del
- del(key): Promise<number>
Returns Promise<number>
exec
- exec(): Promise<unknown[]>
Returns Promise<unknown[]>
exists
- exists(key): Promise<number>
Returns Promise<number>
flushdb
- flushdb(): Promise<string>
Returns Promise<string>
get
- get(key): Promise<string>
Returns Promise<string>
hdel
- hdel(key, itemId): Promise<number>
Parameters
- key: string
- itemId: string
Returns Promise<number>
hget
- hget(key, itemId): Promise<string>
Parameters
- key: string
- itemId: string
Returns Promise<string>
hincrbyfloat
- hincrbyfloat(key, itemId, value): Promise<number>
Parameters
- key: string
- itemId: string
- value: number
Returns Promise<number>
hmget
- hmget(key, itemIds): Promise<string[]>
Parameters
- key: string
- itemIds: string[]
Returns Promise<string[]>
hset
- hset(key, values): this
Parameters
- key: string
- values: Record<string, string>
Returns this
lpush
- lpush(key, ...args): Promise<number>
Parameters
- key: string
Rest
...args: string[]
Returns Promise<number>
lrange
- lrange(key, start, end): Promise<string[]>
Parameters
- key: string
- start: number
- end: number
Returns Promise<string[]>
on
- on(event, callback): void
Parameters
- event: string
- callback: ((...args: any[]) => void)
- (...args): void
Returns void
Returns void
psubscribe
- psubscribe(pattern, callback): Promise<void>
Parameters
- pattern: string
- callback: ((channel: string, message: string) => void)
- (channel, message): void
Parameters
- channel: string
- message: string
Returns void
Returns Promise<void>
publish
- publish(channel, message): Promise<number>
Parameters
- channel: string
- message: string
Returns Promise<number>
punsubscribe
- punsubscribe(pattern): void
Returns void
- punsubscribe(channel): void
Returns void
quit
- quit(): Promise<string>
Returns Promise<string>
rpush
- rpush(key, ...args): Promise<number>
Parameters
- key: string
Rest
...args: string[]
Returns Promise<number>
sendCommand
- sendCommand(args): Promise<any>
Returns Promise<any>
set
- set(key, value): Promise<string>
Returns Promise<string>
subscribe
- subscribe(channel, callback): void
Parameters
- channel: string
- callback: ((channel: string, message: string) => void)
- (channel, message): void
Parameters
- channel: string
- message: string
Returns void
Returns void
unsubscribe
- unsubscribe(channel): void
Returns void
xack
- xack(key, group, id): Promise<number>
Parameters
- key: string
- group: string
- id: string
Returns Promise<number>
xadd
- xadd(key, id, fields, message?): Promise<string>
Parameters
- key: string
- id: string
- fields: any
Optional
message: string
Returns Promise<string>
xclaim
- xclaim(key, group, consumer, minIdleTime, id, ...args): Promise<ReclaimedMessageType>
Parameters
- key: string
- group: string
- consumer: string
- minIdleTime: number
- id: string
Rest
...args: string[]
xdel
- xdel(key, id): Promise<number>
Returns Promise<number>
xgroup
- xgroup(command, key, groupName, id, mkStream?): Promise<string>
Parameters
- command: string
- key: string
- groupName: string
- id: string
Optional
mkStream: "MKSTREAM"
Returns Promise<string>
xinfo
- xinfo(command, key): Promise<unknown>
Parameters
- command: string
- key: string
Returns Promise<unknown>
xlen
- xlen(key): Promise<number>
Returns Promise<number>
xpending
- xpending(key, group, start?, end?, count?, consumer?): Promise<unknown[] | [string, string, number, number] | [string, string, number, [string, number][]][]>
Parameters
- key: string
- group: string
Optional
start: stringOptional
end: stringOptional
count: numberOptional
consumer: string
Returns Promise<unknown[] | [string, string, number, number] | [string, string, number, [string, number][]][]>
xrange
- xrange(key, start, end): Promise<string[][]>
Parameters
- key: string
- start: string
- end: string
Returns Promise<string[][]>
zadd
- zadd(...args): Promise<number>
Parameters
Rest
...args: (string | number)[]
Returns Promise<number>
zrange
- zrange(key, start, end, withScores?): Promise<string[]>
Parameters
- key: string
- start: number
- end: number
Optional
withScores: "WITHSCORES"
Returns Promise<string[]>
zrank
- zrank(key, member): Promise<number>
Parameters
- key: string
- member: string
Returns Promise<number>
zscore
- zscore(key, value): Promise<number>
Returns Promise<number>