Setu-TS
    Preparing search index...

    Type Alias NodeRedisClientLike

    Single-node node-redis client surface used by fromNodeRedis. No Redis package is loaded by this contract or its adapter.

    0.11.0

    type NodeRedisClientLike = {
        isOpen: boolean;
        isReady: boolean;
        close(): void | Promise<unknown>;
        connect(): Promise<unknown>;
        destroy(): unknown;
        off(
            event: string,
            listener:
                | ((error: unknown) => void)
                | ((channel: string, message: string) => void),
        ): unknown;
        on(
            event: string,
            listener:
                | ((error: unknown) => void)
                | ((channel: string, message: string) => void),
        ): unknown;
        sendCommand(args: readonly string[]): Promise<unknown>;
        subscribe(
            channel: string,
            listener: (message: string, channel: string) => void,
        ): Promise<unknown>;
        unsubscribe(channel: string): Promise<unknown>;
    }
    Index
    isOpen isReady
    close connect destroy off on sendCommand subscribe unsubscribe
    isOpen: boolean

    Whether a connection is open or reconnecting.

    isReady: boolean

    Whether commands can currently reach Redis.

    • Removes an emitter listener.

      Parameters

      • event: string
      • listener: ((error: unknown) => void) | ((channel: string, message: string) => void)

      Returns unknown

    • Registers an emitter listener.

      Parameters

      • event: string
      • listener: ((error: unknown) => void) | ((channel: string, message: string) => void)

      Returns unknown

    • Sends raw command arguments without node-redis's typed reply transforms.

      Parameters

      • args: readonly string[]

      Returns Promise<unknown>

    • Subscribes using node-redis's message-first callback.

      Parameters

      • channel: string
      • listener: (message: string, channel: string) => void

      Returns Promise<unknown>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods