Class CronTrigger

packages/trigger-sdk/src/triggers/scheduled.ts:83–139

}

export class CronTrigger implements Trigger<ScheduledEventSpecification> {
  constructor(private options: CronOptions) {}

  get event() {
    /**
     * We need to concat `(UTC)` string at the end of the human readable string to avoid confusion 
     * with execution time/last run of a job in the UI dashboard which is displayed in local time.
     */
    const humanReadable = cronstrue.toString(this.options.cron, {
      throwExceptionOnParseError: false,
    }).concat(" (UTC)");

    return {
      name: "trigger.scheduled",
      title: "Cron Schedule",
      source: "trigger.dev",
      icon: "schedule-cron",
      examples,
      parsePayload: ScheduledPayloadSchema.parse,
      properties: [
        {
          label: "cron",
          text: this.options.cron,
        },
        {
          label: "Schedule",
          text: humanReadable,
        },
      ],
    };
  }

  attachToJob(
    triggerClient: TriggerClient,
    job: Job<Trigger<ScheduledEventSpecification>, any>
  ): void {}

  get preprocessRuns() {
    return false;
  }

  async verifyPayload(payload: ReturnType<ScheduledEventSpecification["parsePayload"]>) {
    return { success: true as const };
  }

  toJSON(): TriggerMetadata {
    return {
      type: "scheduled",
      schedule: {
        type: "cron",
        options: {
          cron: this.options.cron,
        },
      },
    };
  }
}