Class JobScheduler

constructor

• new JobScheduler(options: JobSchedulerOptions): JobScheduler

  Parameters

  • options: JobSchedulerOptions

  Returns JobScheduler

lastError

Readonlynamespace

cancel

• cancel(id: string): Promise<boolean>

  Fence cancellation; application authorization must happen before calling.

  Parameters

  • id: string

  Returns Promise<boolean>

cleanup

• cleanup(limit?: number): Promise<number>

  Explicit bounded terminal-data cleanup. Workers/dispatcher also run this periodically.

  Parameters

  • limit: number = 100

  Returns Promise<number>

createWorker

• createWorker(options: JobWorkerOptions): JobWorker

  Create a separately startable worker sharing this namespace/repository.

  Parameters

  • options: JobWorkerOptions

  Returns JobWorker

dispatch

• dispatch(): Promise<number>

  Run one bounded dispatcher pass, useful for externally managed lifecycles.

  Returns Promise<number>

enqueue

• enqueue<D extends JobDefinition<any, any, any>>(
      definition: D,
      input: InferType<D["input"]>,
      options?: { idempotencyKey?: string; runAt?: Date },
  ): Promise<JobRun<InferType<D["output"]>>>

  Accept a validated immediate/delayed job, or return its retained duplicate.

  Type Parameters

  • D extends JobDefinition<any, any, any>

  Parameters

  • definition: D
  • input: InferType<D["input"]>
  • options: { idempotencyKey?: string; runAt?: Date } = {}

  Returns Promise<JobRun<InferType<D["output"]>>>

events

• events<D extends JobDefinition<any, any, any>>(
      definition: D,
      id: string,
      options?: { after?: number; signal?: AbortSignal },
  ): AsyncGenerator<JobEvent<InferType<D["progress"]>>>

  Replay then follow committed events; disconnecting does not cancel the job.

  Type Parameters

  • D extends JobDefinition<any, any, any>

  Parameters

  • definition: D
  • id: string
  • options: { after?: number; signal?: AbortSignal } = {}

  Returns AsyncGenerator<JobEvent<InferType<D["progress"]>>>

getRun

• getRun<D extends JobDefinition<any, any, any>>(
      definition: D,
      id: string,
  ): Promise<JobRun<InferType<D["output"]>> | undefined>

  Read a typed snapshot without leaking worker ownership credentials.

  Type Parameters

  • D extends JobDefinition<any, any, any>

  Parameters

  • definition: D
  • id: string

  Returns Promise<JobRun<InferType<D["output"]>> | undefined>

health

• health(): Promise<JobRepositoryHealth>

  Inspect operational counts/queue age and queued definition versions.

  Returns Promise<JobRepositoryHealth>

pauseSchedule

• pauseSchedule(id: string, paused?: boolean): Promise<boolean>

  Pause/resume future occurrences. Resume applies the configured missed policy.

  Parameters

  • id: string
  • paused: boolean = true

  Returns Promise<boolean>

removeSchedule

• removeSchedule(id: string): Promise<boolean>

  Remove a recurring trigger, not its already accepted runs.

  Parameters

  • id: string

  Returns Promise<boolean>

start

• start(): Promise<void>

  Start only recurring dispatch; producer-only processes do not need start().

  Returns Promise<void>

stop

• stop(): Promise<void>

  Stop dispatching. Workers must be stopped separately before closing database pools.

  Returns Promise<void>

upsertSchedule

• upsertSchedule<D extends JobDefinition<any, any, any>>(
      id: string,
      definition: D,
      input: InferType<D["input"]>,
      options: {
          missed?: "coalesce" | "skip" | "replay";
          overlap?: "skip" | "allow";
          schedule:
              | {
                  endsOn?: Date;
                  every: "minute";
                  interval?: number;
                  maxOccurences?: number;
                  maxOccurrences?: number;
                  skipFirst?: number;
                  startsOn?: Date;
                  timeZone?: string;
              }
              | {
                  endsOn?: Date;
                  every: "day";
                  hour?: number;
                  interval?: number;
                  maxOccurences?: number;
                  maxOccurrences?: number;
                  minute?: number;
                  skipFirst?: number;
                  startsOn?: Date;
                  timeZone?: string;
              }
              | {
                  dayOfWeek: number[];
                  endsOn?: Date;
                  every: "week";
                  hour?: number;
                  interval?: number;
                  maxOccurences?: number;
                  maxOccurrences?: number;
                  minute?: number;
                  skipFirst?: number;
                  startsOn?: Date;
                  timeZone?: string;
              }
              | {
                  day: number
                  | "last";
                  endsOn?: Date;
                  every: "month";
                  hour?: number;
                  interval?: number;
                  maxOccurences?: number;
                  maxOccurrences?: number;
                  minute?: number;
                  skipFirst?: number;
                  startsOn?: Date;
                  timeZone?: string;
              }
              | {
                  day: number
                  | "last";
                  endsOn?: Date;
                  every: "year";
                  hour?: number;
                  interval?: number;
                  maxOccurences?: number;
                  maxOccurrences?: number;
                  minute?: number;
                  month: number;
                  skipFirst?: number;
                  startsOn?: Date;
                  timeZone?: string;
              };
      },
  ): Promise<ScheduleRecord>

  Upsert future recurrence; already accepted runs are never rewritten.

  Type Parameters

  • D extends JobDefinition<any, any, any>

  Parameters

  • id: string
  • definition: D
  • input: InferType<D["input"]>
  • options: {
        missed?: "coalesce" | "skip" | "replay";
        overlap?: "skip" | "allow";
        schedule:
            | {
                endsOn?: Date;
                every: "minute";
                interval?: number;
                maxOccurences?: number;
                maxOccurrences?: number;
                skipFirst?: number;
                startsOn?: Date;
                timeZone?: string;
            }
            | {
                endsOn?: Date;
                every: "day";
                hour?: number;
                interval?: number;
                maxOccurences?: number;
                maxOccurrences?: number;
                minute?: number;
                skipFirst?: number;
                startsOn?: Date;
                timeZone?: string;
            }
            | {
                dayOfWeek: number[];
                endsOn?: Date;
                every: "week";
                hour?: number;
                interval?: number;
                maxOccurences?: number;
                maxOccurrences?: number;
                minute?: number;
                skipFirst?: number;
                startsOn?: Date;
                timeZone?: string;
            }
            | {
                day: number
                | "last";
                endsOn?: Date;
                every: "month";
                hour?: number;
                interval?: number;
                maxOccurences?: number;
                maxOccurrences?: number;
                minute?: number;
                skipFirst?: number;
                startsOn?: Date;
                timeZone?: string;
            }
            | {
                day: number
                | "last";
                endsOn?: Date;
                every: "year";
                hour?: number;
                interval?: number;
                maxOccurences?: number;
                maxOccurrences?: number;
                minute?: number;
                month: number;
                skipFirst?: number;
                startsOn?: Date;
                timeZone?: string;
            };
    }

  Returns Promise<ScheduleRecord>