ApiError

Defined in: packages/core/src/class/ApiError.ts:9

Backend-agnostic API error. All backend-shape knowledge (what codes exist, which i18n keys they map to) is delegated to an injected ErrorCodeAdapter instead of being hardcoded — see @flextable/react-crud/@flextable/vue-crud for a ready-made NestJS-shaped adapter.

Extends

• Error

Type Parameters

TCode

TCode extends string = string

Constructors

Constructor

new ApiError<TCode>(response, adapter): ApiError<TCode>

Defined in: packages/core/src/class/ApiError.ts:16

Parameters

response

ApiErrorResponseShape

adapter

ErrorCodeAdapter<TCode>

Returns

ApiError<TCode>

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

The cause of the error.

Inherited from

Error.cause

---

code

readonly code: TCode

Defined in: packages/core/src/class/ApiError.ts:11

---

description

readonly description: string | undefined

Defined in: packages/core/src/class/ApiError.ts:12

---

details

readonly details: unknown

Defined in: packages/core/src/class/ApiError.ts:13

---

message

message: string

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

name

name: string

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

---

stack?

optional stack?: string

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

---

statusCode

readonly statusCode: number

Defined in: packages/core/src/class/ApiError.ts:10

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.bun/@types+node@26.1.1/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Accessors

descriptionKey

Get Signature

get descriptionKey(): string

Defined in: packages/core/src/class/ApiError.ts:31

Returns

string

---

messageKey

Get Signature

get messageKey(): string

Defined in: packages/core/src/class/ApiError.ts:27

Returns

string

Methods

is()

is(code): boolean

Defined in: packages/core/src/class/ApiError.ts:35

Parameters

code

TCode

Returns

boolean

---

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@26.1.1/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

from()

static from<TCode>(error, adapter): ApiError<TCode>

Defined in: packages/core/src/class/ApiError.ts:46

Normalizes any thrown value into an ApiError. Reads statusCode/ code/message/description/details off any object-shaped error — covers both real Error subclasses with extra fields bolted on and plain rejected objects (throw { statusCode, code, message }), which is how many fetch/HTTP clients surface API failures.

Type Parameters

TCode

TCode extends string

Parameters

error

unknown

adapter

ErrorCodeAdapter<TCode>

Returns

ApiError<TCode>

---

isError()

Call Signature

static isError(error): error is Error

Defined in: node_modules/.bun/typescript@6.0.3/node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

Call Signature

static isError(value): value is Error

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

Parameters

value

unknown

The value to check

Returns

value is Error

True if the value is an instance of Error, false otherwise

Inherited from

Error.isError

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@26.1.1/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace