Class: WirestateError

Defined in: src/wirestate-core/error/wirestate-error.ts:30

Error type thrown for expected Wirestate API failures.

Remarks

Use code for programmatic checks and message for humans. Wirestate uses this for failures a caller can handle, such as invalid config, missing bindings, missing required handlers, and lifecycle access after disposal.

Example

import { Container, WirestateError } from "@wirestate/core";

class MissingService {}

const container = new Container();

try {
  container.get(MissingService);
} catch (error) {
  if (error instanceof WirestateError) {
    console.error(error.code, error.message);
  }
}

Extends

• Error

Constructors

Constructor

new WirestateError(message: string, code?: string): WirestateError;

Defined in: src/wirestate-core/error/wirestate-error.ts:55

Creates a Wirestate error.

Parameters

Parameter	Type	Default value	Description
message	string	undefined	Human-readable diagnostic message.
code	string	ERROR_CODE_GENERIC	String code for the failure type.

Returns

WirestateError

Overrides

Error.constructor

Methods

captureStackTrace()

static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Defined in: @types/node:

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

Parameter	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err: Error, stackTraces: CallSite[]): any;

Defined in: @types/node:

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace

Properties

cause?

optional cause?: unknown;

Defined in: typescript:

Inherited from

Error.cause

---

code

readonly code: string;

Defined in: src/wirestate-core/error/wirestate-error.ts:42

Stable string code identifying the failure type.

Remarks

Use this when application code needs a specific branch.

---

message

readonly message: string;

Defined in: src/wirestate-core/error/wirestate-error.ts:47

Human-readable diagnostic message.

Overrides

Error.message

---

name

readonly name: string = "WirestateError";

Defined in: src/wirestate-core/error/wirestate-error.ts:34

Error class name used for diagnostics.

Overrides

Error.name

---

stack?

optional stack?: string;

Defined in: typescript:

Inherited from

Error.stack

---

stackTraceLimit

static stackTraceLimit: number;

Defined in: @types/node:

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