Workflow.sleepUntil()

The .sleepUntil() method pauses execution until a specified date.

Usage example

workflow.sleepUntil(new Date(Date.now() + 5000))

Parameters

dateOrCallback:

Date | ExecuteFunction<TState, TPrevSchema, Date, any, any, TEngineType>

Either a Date object or a step-style execute function that returns a Date. The callback receives the execution context typed to the workflow state and the previous step output, and can compute the target time dynamically based on input data.

options?:

StepFlowEntryOptions

Optional identity and display metadata for this graph entry. Preserved through serialization and storage; has no effect on execution.

string

string

Record<string, unknown>

Returns

workflow:

Workflow

The workflow instance for method chaining

Extended usage example

import { createWorkflow, createStep } from "@mastra/core/workflows";

const step1 = createStep({...});
const step2 = createStep({...});

export const testWorkflow = createWorkflow({...})
  .then(step1)
  .sleepUntil(async ({ inputData }) => {
    const { delayInMs } = inputData;
    return new Date(Date.now() + delayInMs);
  })
  .then(step2)
  .commit();