Skip to main content

Class: ApiError

Defined in: packages/api-client/src/api.ts:12

Extends​

  • Error

Constructors​

Constructor​

new ApiError(status, message, detail?): ApiError

Defined in: packages/api-client/src/api.ts:13

Parameters​

status​

number

message​

string

detail?​

string

The response body's detail as one sentence: a string detail verbatim (e.g. a guard refusal to surface inline), or a 422's field errors ([{loc, msg, type}]) joined by their messages. Undefined when the body carried neither.

Returns​

ApiError

Overrides​

Error.constructor

Properties​

cause?​

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

Error.cause

detail?​

readonly optional detail?: string

Defined in: packages/api-client/src/api.ts:21

The response body's detail as one sentence: a string detail verbatim (e.g. a guard refusal to surface inline), or a 422's field errors ([{loc, msg, type}]) joined by their messages. Undefined when the body carried neither.

message​

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.name

stack?​

optional stack?: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack

status​

readonly status: number

Defined in: packages/api-client/src/api.ts:14