Interface QueueRegistration

    Argument to EddyqModule.registerQueue — declarative per-queue config that the module aggregates at bootstrap.

    interface QueueRegistration {
        defaults?: QueueDefaults;
        groups?: Record<string, GroupProfile>;
        name: string;
        schedules?: ScheduleDeclaration[];
        subscribe?: boolean;
    }
    Index

    Properties

    defaults? groups? name schedules? subscribe?

    Properties

    defaults?: QueueDefaults

    Defaults merged into every enqueue from this queue's handle. Caller's options win on conflict.

    groups?: Record<string, GroupProfile>

    Named group profiles. Configured idempotently at bootstrap (each profile is treated as a static group whose key equals the profile name) AND available by name via queue.group(key, 'profile-name').

    name: string

    Queue name. Must be unique across registerQueue calls in a single app.

    schedules?: ScheduleDeclaration[]

    Cron schedules owned by this queue. Unioned with forRoot.schedules and reconciled together — entries not present in the union are deleted.

    subscribe?: boolean

    Whether worker pods should subscribe to this queue when subscribeTo is not explicitly set on forRoot. Default true. Set false for queues that exist only for enqueueing in this process (rare).

    Settings

    Member Visibility

    On This Page

    Properties