Skip to main content

ParameterError

Extends​

  • TypeError

Constructors​

new ParameterError()​

new ParameterError(field, target, message?): ParameterError

Parameters​

field​

string

target​

null | string

message?​

string

Returns​

ParameterError

Overrides​

TypeError.constructor

Properties​

field​

field: string

message​

message: string

Inherited from​

TypeError.message

name​

name: "ParameterError" = ParameterError.NAME

Overrides​

TypeError.name

stack?​

optional stack: string

Inherited from​

TypeError.stack

target?​

optional target: string

NAME​

readonly static NAME: "ParameterError" = "ParameterError"

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​

TypeError.stackTraceLimit

Methods​

assert()​

Call Signature​

static assert(target, params, ...fields): void

Parameters​
target​

string

params​

any

fields​

...string[]

Returns​

void

Call Signature​

static assert(params, ...fields): void

Parameters​
params​

any

fields​

...string[]

Returns​

void

assertEmpty()​

static assertEmpty(value, name, target?): asserts value

Parameters​

value​

unknown

name​

string

target?​

string

Returns​

asserts value

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​

TypeError.captureStackTrace

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​

TypeError.prepareStackTrace