Err

Err extends the built-in Error and implements ref.Val.

Extends

• Error

Implements

• Error

Constructors

Constructor

new Err(message, idValue?): Err

Parameters

message

string

idValue?

number = 0

Returns

Err

Overrides

globalThis.Error.constructor

Properties

cause?

optional cause?: unknown

Implementation of

Error.cause

Inherited from

globalThis.Error.cause

---

message

message: string

Implementation of

Error.message

Inherited from

globalThis.Error.message

---

name

name: string

Implementation of

Error.name

Inherited from

globalThis.Error.name

---

stack?

optional stack?: string

Implementation of

Error.stack

Inherited from

globalThis.Error.stack

---

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

globalThis.Error.stackTraceLimit

Methods

convertToNative()

convertToNative(): never

ConvertToNative converts the Value to a native TypeScript value according to the provided type description, or throws if the conversion is not feasible.

Returns

never

Implementation of

Error.convertToNative

---

convertToType()

convertToType(): Val

ConvertToType supports type conversions between CEL value types supported by the expression language.

Returns

Val

Implementation of

Error.convertToType

---

equal()

equal(): Val

Equal returns true if the other value has the same type and content as the implementing value.

Returns

Val

Implementation of

Error.equal

---

is()

is(target): boolean

Is indicates whether the current error matches the target error.

Parameters

target

unknown

Returns

boolean

---

nodeId()

nodeId(): number

NodeID returns the AST node ID of the expression that returned the error.

Returns

number

---

type()

type(): RefType

Type returns the TypeValue of the value.

Returns

RefType

Implementation of

Error.type

---

value()

value(): unknown

Value returns the raw value of the instance which may not be directly compatible with the expression language types.

Returns

unknown

Implementation of

Error.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

globalThis.Error.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

globalThis.Error.prepareStackTrace