bullmq - v5.81.1
    Preparing search index...

    Interface MinimalQueue

    interface MinimalQueue {
        closing: Promise<void>;
        keys: KeysMap;
        name: string;
        opts: QueueBaseOptions;
        qualifiedName: string;
        scripts?: Scripts;
        toKey: (type: string) => string;
        get client(): Promise<IRedisClient>;
        get databaseType(): DatabaseType;
        get redisVersion(): string;
        emit(event: string | symbol, ...args: any[]): boolean;
        on(event: string | symbol, listener: (...args: any[]) => void): this;
        removeListener(
            event: string | symbol,
            listener: (...args: any[]) => void,
        ): this;
        trace<T>(
            spanKind: SpanKind,
            operation: string,
            destination: string,
            callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>,
            srcPropagationMetadata?: string,
        ): Promise<T | Promise<T>>;
        waitUntilReady(): Promise<IRedisClient>;
    }

    Hierarchy (View Summary)

    Implemented by

    Index
    closing keys name opts qualifiedName scripts? toKey
    client databaseType redisVersion
    emit on removeListener trace waitUntilReady
    closing: Promise<void>
    keys: KeysMap
    name: string
    opts: QueueBaseOptions
    qualifiedName: string
    scripts?: Scripts

    The long-lived Scripts instance shared by the queue. Jobs reuse this instance instead of allocating their own, since it is bound to the same queue keys and connection. Optional only so that custom queue-like implementations remain valid; the built-in Queue, Worker and FlowProducer always provide one so no redundant Scripts is created per job.

    toKey: (type: string) => string
    • get redisVersion(): string

      Returns the version of the Redis instance the client is connected to,

      Returns string

    • Emits an event. Normally used by subclasses to emit events.

      Parameters

      • event: string | symbol

        The emitted event.

      • ...args: any[]

      Returns boolean

    • Parameters

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

      Returns this

    • Parameters

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

      Returns this

    • Wraps the code with telemetry and provides a span for configuration.

      Type Parameters

      • T

      Parameters

      • spanKind: SpanKind

        kind of the span: Producer, Consumer, Internal

      • operation: string

        operation name (such as add, process, etc)

      • destination: string

        destination name (normally the queue name)

      • callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>

        code to wrap with telemetry

      • OptionalsrcPropagationMetadata: string

      Returns Promise<T | Promise<T>>

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods