Skip to main content

InvariantError

@rotorsoft/act-root

@rotorsoft/act-root / act/src / InvariantError

Class: InvariantError<S, E, A, K>

Defined in: libs/act/src/types/errors.ts:47

Thrown when a state invariant is violated after an action or event.

Param​

The name of the invariant or action.

Param​

The state or payload that failed the invariant.

Param​

The target context (e.g., stream, actor).

Param​

Description of the invariant.

Example​

throw new InvariantError('balanceNonNegative', state, target, 'Balance must be >= 0');

Extends​

  • Error

Type Parameters​

S​

S extends Schema

E​

E extends Schemas

A​

A extends Schemas

K​

K extends keyof A

Constructors​

Constructor​

new InvariantError<S, E, A, K>(action, payload, target, snapshot, description): InvariantError<S, E, A, K>

Defined in: libs/act/src/types/errors.ts:53

Parameters​

action​

K

payload​

Readonly<A[K]>

target​

Target

snapshot​

Snapshot<S, E>

description​

string

Returns​

InvariantError<S, E, A, K>

Overrides​

Error.constructor

Properties​

action​

readonly action: K

Defined in: libs/act/src/types/errors.ts:54

cause?​

optional cause: unknown

Defined in: node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from​

Error.cause

description​

readonly description: string

Defined in: libs/act/src/types/errors.ts:58

message​

message: string

Defined in: node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

Error.message

name​

name: string

Defined in: node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

Error.name

payload​

readonly payload: Readonly<A[K]>

Defined in: libs/act/src/types/errors.ts:55

snapshot​

readonly snapshot: Snapshot<S, E>

Defined in: libs/act/src/types/errors.ts:57

stack?​

optional stack: string

Defined in: node_modules/.pnpm/typescript@5.9.2/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

Error.stack

target​

readonly target: Target

Defined in: libs/act/src/types/errors.ts:56

stackTraceLimit​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@24.2.1/node_modules/@types/node/globals.d.ts:162

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/.pnpm/@types+node@24.2.1/node_modules/@types/node/globals.d.ts:146

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/.pnpm/@types+node@24.2.1/node_modules/@types/node/globals.d.ts:150

Parameters​

err​

Error

stackTraces​

CallSite[]

Returns​

any

See​

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

Inherited from​

Error.prepareStackTrace