Interface Schedule
interface Schedule {
cronExpr?: string;
enabled: boolean;
intervalMs?: number;
kind: string;
lastRunAt?: string;
maxAttempts: number;
name: string;
nextRunAt: string;
payload: any;
priority: number;
queue: string;
}
cronExpr?: string;
enabled: boolean;
intervalMs?: number;
kind: string;
lastRunAt?: string;
maxAttempts: number;
name: string;
nextRunAt: string;
payload: any;
priority: number;
queue: string;
}
Index
Properties
OptionalcronExpr
cronExpr?: string
Cron expression. null when the row is interval-driven.
enabled
enabled: boolean
OptionalintervalMs
intervalMs?: number
Fixed-interval cadence in milliseconds. null when cron-driven.
kind
kind: string
OptionallastRunAt
lastRunAt?: string
maxAttempts
maxAttempts: number
name
name: string
nextRunAt
nextRunAt: string
payload
payload: any
priority
priority: number
queue
queue: string
Named queue the fired job lands on.
A schedule registered via
addSchedule(cron) oraddIntervalSchedule({ every: ms }). Exactly one ofcronExprandintervalMsis set; the DB CHECK on Postgres and the stored entry on Redis both enforce this.