bullmq - v5.77.1
    Preparing search index...

    Interface NodeRedisRawClient

    interface NodeRedisRawClient {
        isOpen: boolean;
        isReady: boolean;
        options?: Record<string, unknown>;
        bzPopMin(
            key: string,
            timeout: number,
        ): Promise<{ key: string; score: string | number; value: string }>;
        clientSetName(name: string): Promise<unknown>;
        close?(): Promise<void>;
        connect(): Promise<void>;
        del(keys: string[]): Promise<number>;
        destroy(): void | Promise<void>;
        duplicate(): NodeRedisRawClient;
        eval<T = unknown>(
            lua: string,
            options: { arguments: NodeRedisCommandArgument[]; keys: string[] },
        ): Promise<T>;
        evalSha<T = unknown>(
            sha: string,
            options: { arguments: NodeRedisCommandArgument[]; keys: string[] },
        ): Promise<T>;
        exists(keys: string[]): Promise<number>;
        flushAll(): Promise<string>;
        get(key: string): Promise<string>;
        hDel(key: string, fields: string[]): Promise<number>;
        hExists(key: string, field: string): Promise<boolean>;
        hGet(key: string, field: string): Promise<string>;
        hGetAll(key: string): Promise<Record<string, string>>;
        hmGet(key: string, fields: string[]): Promise<string[]>;
        hSet(key: string, data: Record<string, string | number>): Promise<number>;
        incr(key: string): Promise<number>;
        incrBy(key: string, increment: number): Promise<number>;
        info(): Promise<string>;
        keys(pattern: string): Promise<string[]>;
        lLen(key: string): Promise<number>;
        lPos(key: string, value: string): Promise<number>;
        lPush(key: string, values: string[]): Promise<number>;
        lRange(key: string, start: number, end: number): Promise<string[]>;
        lTrim(key: string, start: number, end: number): Promise<unknown>;
        multi(): NodeRedisRawTransaction;
        on(event: string, listener: (...args: any[]) => void): this;
        quit(): Promise<unknown>;
        rPop(key: string): Promise<string>;
        sAdd(key: string, members: string[]): Promise<number>;
        scan(
            cursor: string,
            options?: Record<string, unknown>,
        ): Promise<{ cursor: string | number; keys: string[] }>;
        scanIterator(
            options?: Record<string, unknown>,
        ): AsyncIterable<string | string[]>;
        sCard(key: string): Promise<number>;
        scriptLoad(lua: string): Promise<unknown>;
        sendCommand(args: string[]): Promise<string>;
        set(
            key: string,
            value: string,
            options?: Record<string, unknown>,
        ): Promise<string>;
        sMembers(key: string): Promise<string[]>;
        xAdd(
            key: string,
            id: string,
            fields: Record<string, string>,
            options?: Record<string, unknown>,
        ): Promise<string>;
        xLen(key: string): Promise<number>;
        xRead(
            streams: { id: string; key: string }[],
            options?: Record<string, unknown>,
        ): Promise<any>;
        xRevRange(
            key: string,
            end: string,
            start: string,
            options?: Record<string, unknown>,
        ): Promise<any[]>;
        xTrim(
            key: string,
            strategy: "MAXLEN",
            threshold: number,
            options?: Record<string, unknown>,
        ): Promise<number>;
        zAdd(
            key: string,
            members: { score: number; value: string }[],
        ): Promise<number>;
        zCard(key: string): Promise<number>;
        zRange(
            key: string,
            start: number,
            end: number,
            options?: Record<string, unknown>,
        ): Promise<string[]>;
        zRangeWithScores?(
            key: string,
            start: number,
            end: number,
            options?: Record<string, unknown>,
        ): Promise<{ score: number; value: string }[]>;
        zRem(key: string, members: string[]): Promise<number>;
        zScore(key: string, member: string): Promise<string | number>;
    }
    Index

    Properties

    isOpen isReady options?

    Methods

    bzPopMin clientSetName close? connect del destroy duplicate eval evalSha exists flushAll get hDel hExists hGet hGetAll hmGet hSet incr incrBy info keys lLen lPos lPush lRange lTrim multi on quit rPop sAdd scan scanIterator sCard scriptLoad sendCommand set sMembers xAdd xLen xRead xRevRange xTrim zAdd zCard zRange zRangeWithScores? zRem zScore

    Properties

    isOpen: boolean
    isReady: boolean
    options?: Record<string, unknown>

    Methods

    • Parameters

      • key: string
      • timeout: number

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

    • Parameters

      • key: string

      Returns Promise<Record<string, string>>

    • Parameters

      • key: string
      • fields: string[]

      Returns Promise<string[]>

    • Parameters

      • key: string
      • data: Record<string, string | number>

      Returns Promise<number>

    • Parameters

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

      Returns Promise<string[]>

    • Parameters

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

      Returns Promise<unknown>

    • Parameters

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

      Returns this

    • Parameters

      • cursor: string
      • Optionaloptions: Record<string, unknown>

      Returns Promise<{ cursor: string | number; keys: string[] }>

    • Parameters

      • Optionaloptions: Record<string, unknown>

      Returns AsyncIterable<string | string[]>

    • Parameters

      • key: string
      • value: string
      • Optionaloptions: Record<string, unknown>

      Returns Promise<string>

    • Parameters

      • key: string
      • id: string
      • fields: Record<string, string>
      • Optionaloptions: Record<string, unknown>

      Returns Promise<string>

    • Parameters

      • streams: { id: string; key: string }[]
      • Optionaloptions: Record<string, unknown>

      Returns Promise<any>

    • Parameters

      • key: string
      • end: string
      • start: string
      • Optionaloptions: Record<string, unknown>

      Returns Promise<any[]>

    • Parameters

      • key: string
      • strategy: "MAXLEN"
      • threshold: number
      • Optionaloptions: Record<string, unknown>

      Returns Promise<number>

    • Parameters

      • key: string
      • members: { score: number; value: string }[]

      Returns Promise<number>

    • Parameters

      • key: string
      • start: number
      • end: number
      • Optionaloptions: Record<string, unknown>

      Returns Promise<string[]>

    • Parameters

      • key: string
      • start: number
      • end: number
      • Optionaloptions: Record<string, unknown>

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

    • Parameters

      • key: string
      • member: string

      Returns Promise<string | number>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods