HumanReadableError

An error carrying a message that is good to be shown directly in the UI.
These can be thrown from extensions and caught in core code.

Extends

• Error

---

Constructors

new HumanReadableError()

ts

new HumanReadableError(message?): HumanReadableError

Parameters

Parameter	Type
message?	string

Returns

HumanReadableError

Inherited from

Error.constructor

---

Properties

message

ts

message: string;

Inherited from

Error.message

---

name

ts

name: string = 'HumanReadableError';

Overrides

Error.name

---

stack?

ts

optional stack: string;

Inherited from

Error.stack

---

stackTraceLimit

ts

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

---

Methods

captureStackTrace()

ts

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.

JavaScript

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:

JavaScript

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

ts

static prepareStackTrace(err, stackTraces): any

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

See

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