Wrapped provider native client object that standardizes the interface for all providers.

interface RedisRedisClientType {
    DEL(key: string): Promise<number>;
    EXISTS(key: string): Promise<number>;
    HDEL(key: string, fields: string | 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>): Promise<number>;
    LPUSH(key: string, items: string[]): Promise<number>;
    LRANGE(key: string, start: number, end: number): Promise<string[]>;
    RPUSH(key: string, items: string[]): Promise<number>;
    SET(key: string, value: string): Promise<string>;
    XACK(key: string, group: string, ...ids: string[]): Promise<number>;
    XACK(key: string, group: string, id: string): Promise<number>;
    XADD(key: string, id: string, fields: any): Promise<string>;
    XCLAIM(key: string, group: string, consumer: string, minIdleTime: number, id: string, ...args: string[]): Promise<ReclaimedMessageType>;
    XDEL(key: string, id: string): Promise<number>;
    XDEL(key: string, ...ids: string[]): Promise<number>;
    XINFO(command: string, key: string): Promise<unknown>;
    XINFO_GROUPS(key: string): Promise<unknown>;
    XLEN(key: string): Promise<number>;
    XPENDING(key: string, group: string, start?: string, end?: string, count?: number, consumer?: string): this;
    ZADD(key: string, values: {
        score: string;
        value: string;
    }, opts?: {
        NX: boolean;
    }): Promise<number>;
    ZRANGE_WITHSCORES(key: string, start: number, end: number): Promise<{
        score: number;
        value: string;
    }>;
    ZRANK(key: string, member: string): Promise<number>;
    ZSCORE(key: string, value: string): Promise<number>;
    connect(): Promise<void>;
    disconnect(): void;
    duplicate(): RedisRedisClientType;
    exec(): Promise<unknown[]>;
    flushDb(): Promise<string>;
    get(key: string): Promise<string>;
    mintKey(type: KeyType, params: KeyStoreParams): string;
    multi(): Partial<RedisRedisMultiType>;
    on(event: string, callback: ((...args: any[]) => void)): void;
    pSubscribe(pattern: string, callback: ((channel: string, message: string) => void)): void;
    pUnsubscribe(pattern: string): void;
    publish(channel: string, message: string): Promise<number>;
    punsubscribe(channel: string): void;
    quit(): Promise<string>;
    sendCommand(args: any[]): Promise<any>;
    set(key: string, value: string): Promise<string>;
    subscribe(channel: string, callback: ((channel: string, message: string) => void)): void;
    transact(): ProviderTransaction;
    unsubscribe(channel: string): void;
    xGroupDestroy(key: string, groupName: string): Promise<boolean>;
}

Hierarchy (view full)

Methods

  • Parameters

    • key: string

    Returns Promise<number>

  • Parameters

    • key: string

    Returns Promise<number>

  • Parameters

    • key: string
    • fields: string | string[]

    Returns Promise<number>

  • Parameters

    • key: string
    • itemId: string

    Returns Promise<string>

  • Parameters

    • key: string
    • itemId: string
    • value: number

    Returns Promise<number>

  • Parameters

    • key: string
    • itemIds: string[]

    Returns Promise<string[]>

  • Parameters

    • key: string
    • values: Record<string, string>

    Returns Promise<number>

  • Parameters

    • key: string
    • items: string[]

    Returns Promise<number>

  • Parameters

    • key: string
    • start: number
    • end: number

    Returns Promise<string[]>

  • Parameters

    • key: string
    • items: string[]

    Returns Promise<number>

  • Parameters

    • key: string
    • value: string

    Returns Promise<string>

  • Parameters

    • key: string
    • group: string
    • Rest...ids: string[]

    Returns Promise<number>

  • Parameters

    • key: string
    • group: string
    • id: string

    Returns Promise<number>

  • Parameters

    • key: string
    • id: string
    • fields: any

    Returns Promise<string>

  • Parameters

    • key: string
    • id: string

    Returns Promise<number>

  • Parameters

    • key: string
    • Rest...ids: string[]

    Returns Promise<number>

  • Parameters

    • command: string
    • key: string

    Returns Promise<unknown>

  • Parameters

    • key: string

    Returns Promise<unknown>

  • Parameters

    • key: string

    Returns Promise<number>

  • Parameters

    • key: string
    • group: string
    • Optionalstart: string
    • Optionalend: string
    • Optionalcount: number
    • Optionalconsumer: string

    Returns this

  • Parameters

    • key: string
    • values: {
          score: string;
          value: string;
      }
      • score: string
      • value: string
    • Optionalopts: {
          NX: boolean;
      }
      • NX: boolean

    Returns Promise<number>

  • Parameters

    • key: string
    • start: number
    • end: number

    Returns Promise<{
        score: number;
        value: string;
    }>

  • Parameters

    • key: string
    • member: string

    Returns Promise<number>

  • Parameters

    • key: string
    • value: string

    Returns Promise<number>

  • Parameters

    • key: string

    Returns Promise<string>

  • Parameters

    • event: string
    • callback: ((...args: any[]) => void)
        • (...args): void
        • Parameters

          • Rest...args: any[]

          Returns void

    Returns void

  • Parameters

    • pattern: string
    • callback: ((channel: string, message: string) => void)
        • (channel, message): void
        • Parameters

          • channel: string
          • message: string

          Returns void

    Returns void

  • Parameters

    • pattern: string

    Returns void

  • Parameters

    • channel: string
    • message: string

    Returns Promise<number>

  • Parameters

    • channel: string

    Returns void

  • Parameters

    • args: any[]

    Returns Promise<any>

  • Parameters

    • key: string
    • value: string

    Returns Promise<string>

  • Parameters

    • channel: string
    • callback: ((channel: string, message: string) => void)
        • (channel, message): void
        • Parameters

          • channel: string
          • message: string

          Returns void

    Returns void

  • Parameters

    • channel: string

    Returns void

  • Parameters

    • key: string
    • groupName: string

    Returns Promise<boolean>