Skip to content

Function: fail()

ts
function fail(response): Failure;

Defined in: packages/core/src/core/result.ts:103

Create a failed result from a ToolResponse.

Parameters

ParameterTypeDescription
responseToolResponseAn error ToolResponse (typically from error())

Returns

Failure

A Failure with ok: false

Example

typescript
return fail(error('User not found'));
return fail(required('email'));

See

  • error for creating error responses
  • required for missing field errors