askHuman

Variables

askHuman

Variable: askHuman

const askHuman: (data) => never = pauseHere

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

Ergonomic alias for pauseHere(data) — the human-in-the-loop name.

pauseHere describes the mechanism (control-flow throw); askHuman describes the intent (ask a person to decide). Both work identically.

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
    },
  };

Example

const approveRefund: Tool<{ amount: number }, string> = {
    schema: { name: 'approve_refund', description: '...', inputSchema: {...} },
    execute: async ({ amount }) => {
      if (amount > 1000) askHuman({ question: `Approve $${amount}?` });
      return 'auto-approved';
    },
  };