Interface: KitError<R *extends* Registry, C *extends* Code<R> = Code<R>>

Defined in: kit.ts:77

The shape every kit's error instances have, independent of which kit built them.

Example

const err = kit.fail('WIDGET_NOT_FOUND', { widgetId: 'w1' })
err.toJSON() // { ok: false, error: { code: 'WIDGET_NOT_FOUND', status: 404, widgetId: 'w1' } }

Extends

• Error

Type Parameters

R

R extends Registry

C

C extends Code<R> = Code<R>

Properties

code

readonly code: C

Defined in: kit.ts:78

meta

readonly meta: Record<string, unknown>

Defined in: kit.ts:82

status

readonly status: number

Defined in: kit.ts:79

statusCode

readonly statusCode: number

Defined in: kit.ts:81

Same value as status, under the name Nest's base exception filter reads.

Methods

toJSON()

toJSON(): { error: { code: C; status: number; } & Record<string, unknown>; ok: false; }

Defined in: kit.ts:83

Returns

{ error: { code: C; status: number; } & Record<string, unknown>; ok: false; }

error

error: { code: C; status: number; } & Record<string, unknown>

Type Declaration

code

code: C

status

status: number

ok

ok: false