Agenda - v6.0.0
    Preparing search index...

    Interface AgendaOptions

    Agenda configuration options

    interface AgendaOptions {
        backend: AgendaBackend;
        defaultConcurrency?: number;
        defaultLockLifetime?: number;
        defaultLockLimit?: number;
        forkedWorker?: boolean;
        forkHelper?: { options?: ForkOptions; path: string };
        lockLimit?: number;
        maxConcurrency?: number;
        name?: string;
        notificationChannel?: NotificationChannel;
        processEvery?: string | number;
    }
    Index

    Properties

    backend defaultConcurrency? defaultLockLifetime? defaultLockLimit? forkedWorker? forkHelper? lockLimit? maxConcurrency? name? notificationChannel? processEvery?

    Properties

    backend: AgendaBackend

    Unified backend for storage and optionally notifications

    defaultConcurrency?: number

    Default number of concurrent jobs per job type

    defaultLockLifetime?: number

    Default lock lifetime in milliseconds

    defaultLockLimit?: number

    Default max locked jobs per job type

    forkedWorker?: boolean

    Whether this is a forked worker instance

    forkHelper?: { options?: ForkOptions; path: string }

    Fork helper configuration for sandboxed workers

    lockLimit?: number

    Global max locked jobs

    maxConcurrency?: number

    Maximum number of concurrent jobs globally

    name?: string

    Name to identify this agenda instance

    notificationChannel?: NotificationChannel

    Override notification channel from backend. Use this to mix storage from one system with notifications from another. e.g., MongoDB storage + Redis notifications

    processEvery?: string | number

    How often to poll for new jobs (string like '5 seconds' or milliseconds)

    Settings

    Member Visibility

    On This Page

    Properties