CborEncodeError

Defined in: src/serialization/CborCodec.ts:20

Minimal CBOR codec (RFC 8949 subset) used by CborSerializer.

Supported major types: 0 (unsigned int), 1 (negative int), 2 (byte string), 3 (text string), 4 (array), 5 (map, with string keys), 7 (simple values: false/true/null + double float).

Additional-info values 0–27 are handled for every major type. Indefinite- length items and tagged items (major type 6) are NOT supported — the target use case is actor message serialisation, not arbitrary CBOR interop. Dates and bigints are supported via semantic tagging (tag 1 and tag 2/3) on the encoder side; the decoder recognises them.

Extends

• Error

Constructors

Constructor

new CborEncodeError(m): CborEncodeError

Defined in: src/serialization/CborCodec.ts:21

Parameters

m

string

Returns

CborEncodeError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

---

message

message: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

---

name

name: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

---

stack?

optional stack?: string

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: 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/@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/@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