Functions

pauseHere

Function: pauseHere()

pauseHere(data): never

Defined in: src/core/pause.ts:71

Called from inside a tool's execute() to request a pause. Throws a PauseRequest that the Agent catches and forwards to the flowchart.

Parameters

data

unknown

Returns

never

Example

const approveTool: Tool<{ action: string }, string> = {
    schema: { name: 'approve', description: 'Ask human', inputSchema: {...} },
    execute: async (args) => {
      pauseHere({ question: `Approve ${args.action}?`, risk: 'high' });
      return ''; // unreachable — pauseHere always throws
    },
  };

On this page