Skip to main content

@jewel998/state-machine - v0.0.5 / InvalidStateError

Class: InvalidStateError

Custom error classes for the state machine library

Hierarchy​

Table of contents​

Constructors​

Properties​

Methods​

Constructors​

constructor​

• new InvalidStateError(state, validStates?): InvalidStateError

Parameters​

NameType
statestring
validStates?string[]

Returns​

InvalidStateError

Overrides​

StateMachineError.constructor

Defined in​

src/errors.ts:17

Properties​

name​

• name: string

Inherited from​

StateMachineError.name

Defined in​

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

message​

• message: string

Inherited from​

StateMachineError.message

Defined in​

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

stack​

• Optional stack: string

Inherited from​

StateMachineError.stack

Defined in​

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

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​

StateMachineError.stackTraceLimit

Defined in​

node_modules/.pnpm/@types+node@20.19.21/node_modules/@types/node/globals.d.ts:68

code​

• Optional Readonly code: string

Inherited from​

StateMachineError.code

Defined in​

src/errors.ts:8

Methods​

captureStackTrace​

▸ 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​

NameType
targetObjectobject
constructorOpt?Function

Returns​

void

Inherited from​

StateMachineError.captureStackTrace

Defined in​

node_modules/.pnpm/@types+node@20.19.21/node_modules/@types/node/globals.d.ts:52

prepareStackTrace​

▸ prepareStackTrace(err, stackTraces): any

Parameters​

NameType
errError
stackTracesCallSite[]

Returns​

any

See

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

Inherited from​

StateMachineError.prepareStackTrace

Defined in​

node_modules/.pnpm/@types+node@20.19.21/node_modules/@types/node/globals.d.ts:56