Skip to main content

Class: FrappeError

Defined in: packages/client/src/core/errors.ts:87

Base class for every error this client throws.

Deliberately has no index signature: error.stauts (a typo) is a compile error, not silent undefined. Unrecognized server fields live under extra, which can never overwrite a named field on this class.

Stable​

Extends​

  • Error

Extended by​

Constructors​

Constructor​

new FrappeError(init): FrappeError

Defined in: packages/client/src/core/errors.ts:100

Parameters​

init​

FrappeErrorInit

Returns​

FrappeError

Overrides​

Error.constructor

Properties​

cause?​

optional cause?: unknown

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

Inherited from​

Error.cause

errors?​

readonly optional errors?: FrappeV2ErrorEntry[]

Defined in: packages/client/src/core/errors.ts:93

exc?​

readonly optional exc?: string

Defined in: packages/client/src/core/errors.ts:91

extra​

readonly extra: Readonly<Record<string, unknown>>

Defined in: packages/client/src/core/errors.ts:98

Extra server-provided fields, never shadowing a named field on this class.

frappeExceptionType?​

readonly optional frappeExceptionType?: string

Defined in: packages/client/src/core/errors.ts:90

message​

message: string

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

Inherited from​

Error.message

name​

name: string

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

Inherited from​

Error.name

request?​

readonly optional request?: FrappeRequestContext

Defined in: packages/client/src/core/errors.ts:95

responseText?​

readonly optional responseText?: string

Defined in: packages/client/src/core/errors.ts:94

retryAfterMs?​

readonly optional retryAfterMs?: number

Defined in: packages/client/src/core/errors.ts:96

serverMessages​

readonly serverMessages: ServerMessage[]

Defined in: packages/client/src/core/errors.ts:92

stack?​

optional stack?: string

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

Inherited from​

Error.stack

status​

readonly status: number

Defined in: packages/client/src/core/errors.ts:88

statusText​

readonly statusText: string

Defined in: packages/client/src/core/errors.ts:89

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@26.5.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

Methods​

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@26.5.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

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@26.5.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