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

    Interface TriggerRule<T>

    Event trigger rule

    interface TriggerRule<T = unknown> {
        condition?: (result: unknown, job: Job<T>) => boolean;
        create: string;
        data: (result: unknown, job: Job<T>) => T;
        event?: "completed" | "failed";
        on: string;
        opts?: JobOptions;
    }

    Type Parameters

    • T = unknown
    Index
    condition? create data event? on opts?
    condition?: (result: unknown, job: Job<T>) => boolean

    Optional condition

    create: string

    Job name to create

    data: (result: unknown, job: Job<T>) => T

    Data builder from the triggering job

    event?: "completed" | "failed"

    Event type (default: completed)

    on: string

    Job name that triggers this rule

    opts?: JobOptions

    Optional job options

    Settings
    Member Visibility

    On This Page
    Properties