Skip to main content
Workflows

andLoop

Repeat a step with do-while or do-until semantics.

Quick Start​

Do-While​

import { createWorkflowChain, andDoWhile, andThen } from "@voltagent/core";
import { z } from "zod";

const workflow = createWorkflowChain({
  id: "retry-loop",
  input: z.number(),
}).andDoWhile({
  id: "increment-until-3",
  step: andThen({
    id: "increment",
    execute: async ({ data }) => data + 1,
  }),
  condition: ({ data }) => data < 3,
});

Do-Until​

import { createWorkflowChain, andDoUntil, andThen } from "@voltagent/core";
import { z } from "zod";

const workflow = createWorkflowChain({
  id: "until-loop",
  input: z.number(),
}).andDoUntil({
  id: "increment-until-2",
  step: andThen({
    id: "increment",
    execute: async ({ data }) => data + 1,
  }),
  condition: ({ data }) => data >= 2,
});

Function Signature​

.andDoWhile({
  id: string,
  step: Step,
  condition: (ctx) => boolean | Promise<boolean>,
  retries?: number,
  name?: string,
  purpose?: string
})

.andDoUntil({
  id: string,
  step: Step,
  condition: (ctx) => boolean | Promise<boolean>,
  retries?: number,
  name?: string,
  purpose?: string
})

Notes​

  • The step runs at least once.
  • The loop continues until the condition fails (do-while) or succeeds (do-until).

Table of Contents