Class: PlayError

Defined in: packages/play/src/errors.ts:64

Base class for all typed runtime errors thrown by @xmachines/* packages.

PlayError gives every error two structured fields:

scope — the class or module that threw (e.g. "RouterBridgeBase")
code — a stable, machine-readable identifier (e.g. "PLAY_ROUTER_SYNC_FAILED")

These fields let application code branch on error type without parsing .message strings, which change across releases.

Error codes

Each @xmachines/* package exports its own typed subclasses from an "./errors" subpath:

Package	Import
`@xmachines/play`	`@xmachines/play/errors`
`@xmachines/play-router`	`@xmachines/play-router/errors`
`@xmachines/play-vue-router`	`@xmachines/play-vue-router/errors`
`@xmachines/play-xstate`	`@xmachines/play-xstate/errors`
`@xmachines/play-react`	`@xmachines/play-react/errors`
`@xmachines/play-solid`	`@xmachines/play-solid/errors`

PlayError itself is exported from the root @xmachines/play and is the base for all of those subclasses.

Catching errors by type

import { PlayError } from "@xmachines/play";
import { RouterSyncError } from "@xmachines/play-router/errors";

try {
  bridge.connect();
} catch (err) {
  if (err instanceof RouterSyncError) {
    // err.scope === "RouterBridgeBase"
    // err.code  === "PLAY_ROUTER_SYNC_FAILED"
    // err.cause  — the original error that triggered the sync failure
    reportToMonitoring(err);
  } else if (err instanceof PlayError) {
    // Any other @xmachines/* error
    console.error(`[${err.scope}:${err.code}] ${err.message}`);
  } else {
    throw err; // Re-throw unknown errors
  }
}

Extending PlayError

import { PlayError } from "@xmachines/play";

export class MyPackageError extends PlayError {
  constructor(message: string, options?: ErrorOptions) {
    super("MyScope", "MY_PACKAGE_ERROR_CODE", message, options);
    this.name = "MyPackageError";
  }
}

Extends

Error

Extended by

NonNullableError

Constructors

Constructor

new PlayError(
   scope,
   code,
   message,
   options?): PlayError;

Defined in: packages/play/src/errors.ts:83

Parameters

Parameter	Type	Description
`scope`	`string`	The class or module throwing this error.
`code`	`string`	Machine-readable error identifier (e.g. `"PLAY_ROUTER_SYNC_FAILED"`).
`message`	`string`	Human-readable description. Do not match on this in code.
`options?`	`ErrorOptions`	Standard `ErrorOptions`; pass `{ cause: originalError }` to chain errors.

Returns

PlayError

Overrides

Error.constructor;

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`cause?`	`public`	`unknown`	-	`Error.cause`	-
`code`	`readonly`	`string`	A stable, machine-readable error identifier. Error codes follow the `PLAY_<PACKAGE>_<DESCRIPTION>` naming convention and are guaranteed stable across patch and minor releases within a major version. Never match on `.message` — always match on `.code` or the subclass.	-	packages/play/src/errors.ts:75
`message`	`public`	`string`	-	`Error.message`	-
`name`	`public`	`string`	-	`Error.name`	-
`scope`	`readonly`	`string`	The class or module that threw this error (e.g. `"RouterBridgeBase"`).	-	packages/play/src/errors.ts:66
`stack?`	`public`	`string`	-	`Error.stack`	-
`stackTraceLimit`	`static`	`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.	`Error.stackTraceLimit`	-

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): 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;

isError()

static isError(error): error is Error;

Defined in: typescript

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

Parameter	Type
`error`	`unknown`

Returns

error is Error

Inherited from

Error.isError;

prepareStackTrace()

static prepareStackTrace(err, stackTraces): 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;