Type Alias: BeforeIterationHook

type BeforeIterationHook = (context) => 
  | undefined
  | Promise<undefined>
  | {
  skip: true;
}
  | Promise<{
  skip: true;
}>;

Defined in: hooks/types.ts:70

Hook called before each iteration starts.

Can be used for:

  • Logging iteration boundaries
  • Custom iteration budget tracking
  • Early termination checks

Parameters

Parameter Type
context IterationHookContext

Returns

| undefined | Promise<undefined> | { skip: true; } | Promise<{ skip: true; }>

void, or { skip: true } to skip this iteration