Aller au contenu
English

TriggerSchedule

import type { TriggerSchedule } from "@elie-laloum/outpost";
  • nameRequis
    string
    Nom stable de 1 à 128 lettres, chiffres, points, tirets bas ou tirets ; il fait partie de chaque identifiant de job.
  • cronRequis
    CronSchedule
    Planification créée avec createCronSchedule().
  • handlerRequis
    string
    Handler du worker de file qui reçoit les jobs, généralement un defineWorkflowJob().
  • runIdOptionnel
    ((slot: Date) => string) | undefined
    Dérive l’exécution de checkpoint d’un créneau ; <name>:<heure ISO du créneau> par défaut. Renvoyez la même valeur pour un créneau sur chaque réplica, sinon la file refuse la publication suivante.
  • inputOptionnel
    ((slot: Date) => WorkflowJson) | undefined
    Dérive l’entrée JSON d’un créneau ; null par défaut. Renvoyez la même valeur pour un créneau sur chaque réplica, sinon la file refuse la publication suivante.
export interface TriggerSchedule {
  /** Stable name; part of each slot's queue job identifier. */
  readonly name: string;
  readonly cron: CronSchedule;
  readonly handler: string;
  /** Defaults to `<name>:<slot ISO time>`. */
  readonly runId?: (slot: Date) => string;
  /** Defaults to `null`. */
  readonly input?: (slot: Date) => WorkflowJson;
}