Class DynamicSchedule

packages/trigger-sdk/src/triggers/scheduled.ts:154–253

/** DynamicSchedule` allows you to define a scheduled trigger that can be configured dynamically at runtime. */
export class DynamicSchedule implements Trigger<ScheduledEventSpecification> {
  /**
   * @param client The `TriggerClient` instance to use for registering the trigger.
   * @param options The options for the schedule.
   */
  constructor(
    private client: TriggerClient,
    private options: DynamicIntervalOptions
  ) {
    client.attachDynamicSchedule(this.options.id);
  }

  get id() {
    return this.options.id;
  }

  get event() {
    return {
      name: "trigger.scheduled",
      title: "Dynamic Schedule",
      source: "trigger.dev",
      icon: "schedule-dynamic",
      examples,
      parsePayload: ScheduledPayloadSchema.parse,
    };
  }

  async register(key: string, metadata: ScheduleMetadata) {
    const runStore = runLocalStorage.getStore();

    if (!runStore) {
      return this.client.registerSchedule(this.id, key, metadata);
    }

    const { io } = runStore;

    return await io.runTask(
      [key, "register"],
      async (task) => {
        return this.client.registerSchedule(this.id, key, metadata);
      },
      {
        name: "Register Schedule",
        icon: metadata.type === "cron" ? "schedule-cron" : "schedule-interval",
        properties: [
          { label: "Dynamic Schedule", text: this.id },
          { label: "Schedule ID", text: key },
        ],
        params: metadata,
      }
    );
  }

  async unregister(key: string) {
    const runStore = runLocalStorage.getStore();

    if (!runStore) {
      return this.client.unregisterSchedule(this.id, key);