bullmq - v6.0.3
    Preparing search index...

    Interface MinimalQueue

    The minimal, datastore-agnostic surface that Job and other helpers need from a queue. Redis specifics (client, version, …) live behind the IQueueBackend the queue owns.

    interface MinimalQueue {
        backend: IQueueBackend;
        closing: Promise<void>;
        keys: KeysMap;
        name: string;
        opts: QueueBaseOptions;
        qualifiedName: string;
        toKey: (type: string) => 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<void>;
    }

    Implemented by

    Index
    backend closing keys name opts qualifiedName toKey
    emit on removeListener trace waitUntilReady
    backend: IQueueBackend

    The datastore backend the queue operates through.

    closing: Promise<void>
    keys: KeysMap
    name: string
    opts: QueueBaseOptions
    qualifiedName: string
    toKey: (type: string) => 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
    Methods