Beignet API reference
    Preparing search index...

    Interface CreateBullMQJobsProviderOptions

    Options for the provider factory.

    interface CreateBullMQJobsProviderOptions {
        connection?: ConnectionOptions;
        defaultJobOptions?: JobsOptions;
        jobOptions?: (
            args: { job: JobDef; payload: unknown },
        ) => MaybePromise<JobsOptions | undefined>;
        prefix?: string;
        queueName?: string;
        queueOptions?: Omit<QueueOptions, "connection" | "prefix">;
        retention?: false | BullMQJobsRetentionOptions;
        startupTimeoutMs?: number;
    }
    Index
    connection? defaultJobOptions? jobOptions? prefix? queueName? queueOptions? retention? startupTimeoutMs?
    connection?: ConnectionOptions

    Explicit BullMQ connection options. When omitted, BULLMQ_REDIS_URL is parsed into a BullMQ connection object.

    defaultJobOptions?: JobsOptions

    Optional default BullMQ job options for all dispatched jobs.

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

    Optional callback for per-job BullMQ options.

    prefix?: string

    Redis key prefix. Defaults to BULLMQ_PREFIX, then "beignet".

    queueName?: string

    Queue name. Defaults to BULLMQ_QUEUE_NAME, then "beignet-jobs".

    queueOptions?: Omit<QueueOptions, "connection" | "prefix">

    Additional BullMQ queue options.

    retention?: false | BullMQJobsRetentionOptions

    Retention policy for completed and failed BullMQ jobs.

    startupTimeoutMs?: number

    Maximum time to wait for the queue connection during provider startup.

    Defaults to 5000ms.

    Settings
    Member Visibility

    On This Page
    Properties