Skip to main content

Class: M2Error

Custom error class for m2c2kit errors.

Extends​

  • Error

Constructors​

new M2Error()​

new M2Error(message?, options?): M2Error

Parameters​

• message?: string

The error message.

• options?

Optional object containing an error 'cause' for error chaining.

• options.cause?: unknown

Returns​

M2Error

Overrides​

Error.constructor

Defined in​

m2c2kit/packages/core/src/M2Error.ts:14

Properties​

cause?​

optional cause: unknown

The underlying cause of the error.

Defined in​

m2c2kit/packages/core/src/M2Error.ts:8

message​

message: string

Inherited from​

Error.message

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1077

name​

name: string

Inherited from​

Error.name

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1076

stack?​

optional stack: string

Inherited from​

Error.stack

Defined in​

node_modules/typescript/lib/lib.es5.d.ts:1078

stackTraceLimit​

static stackTraceLimit: number

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

Defined in​

m2c2kit/node_modules/@types/node/globals.d.ts:68

Methods​

toJSON()​

toJSON(): Record<string, unknown>

Structured JSON representation for logging, telemetry, and transport.

Returns​

Record<string, unknown>

Defined in​

m2c2kit/packages/core/src/M2Error.ts:49

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

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

Defined in​

m2c2kit/node_modules/@types/node/globals.d.ts:52

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Parameters​

• err: Error

• stackTraces: CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace

Defined in​

m2c2kit/node_modules/@types/node/globals.d.ts:56