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

    Interface CronJobInput

    Input for creating a cron job

    interface CronJobInput {
        data: unknown;
        dedup?: CronDedup;
        immediately?: boolean;
        jobOptions?: CronJobOptions;
        maxLimit?: number;
        name: string;
        preventOverlap?: boolean;
        priority?: number;
        queue: string;
        repeatEvery?: number;
        schedule?: string;
        skipIfNoWorker?: boolean;
        skipMissedOnRestart?: boolean;
        timezone?: string;
        uniqueKey?: string;
    }
    Index
    data dedup? immediately? jobOptions? maxLimit? name preventOverlap? priority? queue repeatEvery? schedule? skipIfNoWorker? skipMissedOnRestart? timezone? uniqueKey?
    data: unknown
    dedup?: CronDedup

    Deduplication options for cron-spawned jobs

    immediately?: boolean

    Fire immediately on creation, then continue on schedule

    jobOptions?: CronJobOptions

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

    maxLimit?: number
    name: string
    preventOverlap?: boolean

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

    priority?: number
    queue: string
    repeatEvery?: number
    schedule?: string
    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

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

    uniqueKey?: string

    Unique key for deduplication of cron-spawned jobs

    Settings
    Member Visibility

    On This Page
    Properties