Wait until

Wait until a date, then continue execution.

This example sends a reminder email to a user at the specified datetime.

/trigger/reminder-email.ts

export const sendReminderEmail = task({
  id: "send-reminder-email",
  run: async (payload: { to: string; name: string; date: string }) => {
    //wait until the date
    await wait.until({ date: new Date(payload.date) });

    //todo send email
    const { data, error } = await resend.emails.send({
      from: "[e-mail]",
      to: payload.to,
      subject: "Don't forget…",
      html: `<p>Hello ${payload.name},</p><p>...</p>`,
    });
  },
});

This allows you to write linear code without having to worry about the complexity of scheduling or managing cron jobs.

In the Trigger.dev Cloud we automatically pause execution of tasks when they are waiting for longer than a few seconds.

When triggering and waiting for subtasks, the parent is checkpointed and while waiting does not count towards compute usage. When waiting for a time period (wait.for or wait.until), if the wait is longer than 5 seconds we checkpoint and it does not count towards compute usage.

throwIfInThePast

You can optionally throw an error if the date is already in the past when the function is called:

await wait.until({ date: new Date(date), throwIfInThePast: true });

You can of course use try/catch if you want to do something special in this case.