Beignet API reference
    Preparing search index...

    Interface CreateBullMQJobDispatcherOptions

    Options for creating a BullMQ-backed job dispatcher.

    interface CreateBullMQJobDispatcherOptions {
        defaultJobOptions?: JobsOptions;
        instrumentation?: ProviderInstrumentationTarget;
        jobOptions?: (
            args: { job: JobDef; payload: unknown },
        ) => MaybePromise<JobsOptions | undefined>;
        retention?: false | BullMQJobsRetentionOptions;
    }
    Index
    defaultJobOptions? instrumentation? jobOptions? retention?
    defaultJobOptions?: JobsOptions

    BullMQ options applied to every enqueued job before Beignet retry mapping.

    instrumentation?: ProviderInstrumentationTarget

    Optional provider instrumentation target.

    jobOptions?: (
        args: { job: JobDef; payload: unknown },
    ) => MaybePromise<JobsOptions | undefined>

    Optional callback for per-job BullMQ options. Values returned here are merged after Beignet retry mapping, so apps can opt into BullMQ features such as priorities or job IDs intentionally.

    retention?: false | BullMQJobsRetentionOptions

    Retention policy for completed and failed BullMQ jobs.

    Defaults to keeping up to 1000 completed jobs for 24 hours and 5000 failed jobs for 7 days. Pass false to leave retention entirely to defaultJobOptions or per-job options.

    Settings
    Member Visibility

    On This Page
    Properties