Sleep until step.sleepUntil()
step.sleepUntil(id, datetime): Promise
- Name
id- Type
- string
- Required
- required
- Description
The ID of the step. This will be what appears in your function's logs and is used to memoize step state across function versions.
- Name
datetime- Type
- Date | string
- Required
- required
- Description
The datetime at which to continue execution of your function. This can be:
- A
Dateobject - Any date time string in the format accepted by the
Dateobject, i.e.YYYY-MM-DDTHH:mm:ss.sssZor simplified forms likeYYYY-MM-DDorYYYY-MM-DDHH:mm:ss
- A
// Sleep until the new year
await step.sleepUntil("happy-new-year", "2024-01-01");
// Sleep until September ends
await step.sleepUntil("wake-me-up", "2023-09-30T11:59:59");
// Sleep until the end of the this week
const date = dayjs().endOf("week").toDate();
await step.sleepUntil("wait-for-end-of-the-week", date);
step.sleepUntil() must be called using await or some other Promise handler to ensure your function sleeps correctly.