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

    Interface CronJob

    Cron job definition

    interface CronJob {
        data: unknown;
        dedup: CronDedup | null;
        executions: number;
        jobOptions: CronJobOptions | null;
        maxLimit: number | null;
        name: string;
        nextRun: number;
        preventOverlap: boolean;
        priority: number;
        queue: string;
        repeatEvery: number | null;
        schedule: string | null;
        skipIfNoWorker: boolean;
        skipMissedOnRestart: boolean;
        timezone: string | null;
        uniqueKey: string | null;
    }
    Index
    data dedup executions jobOptions maxLimit name nextRun preventOverlap priority queue repeatEvery schedule skipIfNoWorker skipMissedOnRestart timezone uniqueKey
    data: unknown
    dedup: CronDedup | null

    Deduplication options for cron-spawned jobs

    executions: number
    jobOptions: CronJobOptions | null

    Job options applied to each spawned job (retry/cleanup policy, etc.)

    maxLimit: number | null
    name: string
    nextRun: number
    preventOverlap: boolean

    Prevent overlapping cron jobs via automatic dedup (default: true)

    priority: number
    queue: string
    repeatEvery: number | null
    schedule: string | null
    skipIfNoWorker: boolean

    Skip job push if no worker is registered for the queue (default: false)

    skipMissedOnRestart: boolean

    Skip missed runs on restart instead of executing them (default: false)

    timezone: string | null

    IANA timezone for cron schedule (e.g., "Europe/Rome", "America/New_York")

    uniqueKey: string | null

    Unique key for deduplication of cron-spawned jobs

    Settings
    Member Visibility

    On This Page
    Properties