bunqueue v2.9 API referenceall versions · guide
bunqueue
    Preparing search index...

    Interface Job<T>

    Public BullMQ-compatible job contract.

    interface Job<T = unknown> {
        asJSON(): JobJsonRaw;
        attemptsMade: number;
        attemptsStarted: number;
        changeDelay(delay: number): Promise<void>;
        changePriority(opts: ChangePriorityOpts): Promise<void>;
        clearLogs(keepLogs?: number): Promise<void>;
        data: T;
        deduplicationId?: string;
        delay: number;
        discard(): void;
        extendLock(token: string, duration: number): Promise<number>;
        failedReason?: string;
        finishedOn?: number;
        getBatch?(): Job<T>[];
        getChildrenValues<R = unknown>(): Promise<Record<string, R>>;
        getDependencies(opts?: GetDependenciesOpts): Promise<JobDependencies>;
        getDependenciesCount(
            opts?: GetDependenciesOpts,
        ): Promise<JobDependenciesCount>;
        getFailedChildrenValues(): Promise<Record<string, string>>;
        getIgnoredChildrenFailures(): Promise<Record<string, string>>;
        getState(): Promise<JobStateType>;
        id: string;
        isActive(): Promise<boolean>;
        isCompleted(): Promise<boolean>;
        isDelayed(): Promise<boolean>;
        isFailed(): Promise<boolean>;
        isWaiting(): Promise<boolean>;
        isWaitingChildren(): Promise<boolean>;
        log(message: string): Promise<void>;
        moveToCompleted(
            returnValue: unknown,
            token?: string,
            fetchNext?: boolean,
        ): Promise<unknown>;
        moveToDelayed(timestamp: number, token?: string): Promise<void>;
        moveToFailed(
            error: Error,
            token?: string,
            fetchNext?: boolean,
        ): Promise<void>;
        moveToWait(token?: string): Promise<boolean>;
        moveToWaitingChildren(
            token?: string,
            opts?: { child?: { id: string; queue: string } },
        ): Promise<boolean>;
        name: string;
        opts: JobOptions;
        parent?: { id: string; queueQualifiedName: string };
        parentKey?: string;
        priority: number;
        processedBy?: string;
        processedOn?: number;
        progress: number;
        promote(): Promise<void>;
        queueName: string;
        remove(): Promise<void>;
        removeChildDependency(): Promise<boolean>;
        removeDeduplicationKey(): Promise<boolean>;
        removeUnprocessedChildren(): Promise<void>;
        repeatJobKey?: string;
        retry(): Promise<void>;
        returnvalue?: unknown;
        setAsFailed?(error: Error): void;
        stacktrace: string[] | null;
        stalledCounter: number;
        timestamp: number;
        toJSON(): JobJson<T>;
        token?: string;
        updateData(data: T): Promise<void>;
        updateProgress(progress: number, message?: string): Promise<void>;
        waitUntilFinished(queueEvents: unknown, ttl?: number): Promise<unknown>;
    }

    Type Parameters

    • T = unknown
    Index
    attemptsMade attemptsStarted data deduplicationId? delay failedReason? finishedOn? id name opts parent? parentKey? priority processedBy? processedOn? progress queueName repeatJobKey? returnvalue? stacktrace stalledCounter timestamp token?
    asJSON changeDelay changePriority clearLogs discard extendLock getBatch? getChildrenValues getDependencies getDependenciesCount getFailedChildrenValues getIgnoredChildrenFailures getState isActive isCompleted isDelayed isFailed isWaiting isWaitingChildren log moveToCompleted moveToDelayed moveToFailed moveToWait moveToWaitingChildren promote remove removeChildDependency removeDeduplicationKey removeUnprocessedChildren retry setAsFailed? toJSON updateData updateProgress waitUntilFinished
    attemptsMade: number
    attemptsStarted: number
    data: T
    deduplicationId?: string
    delay: number
    failedReason?: string
    finishedOn?: number
    id: string
    name: string
    opts: JobOptions
    parent?: { id: string; queueQualifiedName: string }
    parentKey?: string
    priority: number
    processedBy?: string
    processedOn?: number
    progress: number
    queueName: string
    repeatJobKey?: string
    returnvalue?: unknown
    stacktrace: string[] | null
    stalledCounter: number
    timestamp: number
    token?: string

    • Parameters

      • delay: number

      Returns Promise<void>

    • Parameters

      • OptionalkeepLogs: number

      Returns Promise<void>

    • Parameters

      • token: string
      • duration: number

      Returns Promise<number>

    • Type Parameters

      • R = unknown

      Returns Promise<Record<string, R>>

    • Returns Promise<Record<string, string>>

    • Returns Promise<Record<string, string>>

    • Parameters

      • message: string

      Returns Promise<void>

    • Parameters

      • returnValue: unknown
      • Optionaltoken: string
      • OptionalfetchNext: boolean

      Returns Promise<unknown>

    • Parameters

      • timestamp: number
      • Optionaltoken: string

      Returns Promise<void>

    • Parameters

      • error: Error
      • Optionaltoken: string
      • OptionalfetchNext: boolean

      Returns Promise<void>

    • Parameters

      • Optionaltoken: string

      Returns Promise<boolean>

    • Parameters

      • Optionaltoken: string
      • Optionalopts: { child?: { id: string; queue: string } }

      Returns Promise<boolean>

    • Mark only this member as failed while allowing the rest of its batch to complete.

      Parameters

      • error: Error

      Returns void

    • Parameters

      • progress: number
      • Optionalmessage: string

      Returns Promise<void>

    • Parameters

      • queueEvents: unknown
      • Optionalttl: number

      Returns Promise<unknown>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods