Class: PlayError

API / @xmachines/play / errors / PlayError

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

The base class of every typed runtime error of a Play package.

PlayError extends BaseError of @xmachines/core/errors, which gives each error two structured fields:

• scope — the class or the module that threw the error, for example "RouterBridgeBase"
• code — a stable, machine-readable identifier, for example "PLAY_ROUTER_SYNC_FAILED"

Your application code therefore branches on the type of an error, and it does not parse the .message string. A message changes between releases.

The error codes

An @xmachines/* package that defines typed subclasses exports them from an "./errors" subpath:

Package	Import
@xmachines/play	@xmachines/play/errors
@xmachines/play-router	@xmachines/play-router/errors
@xmachines/play-url	@xmachines/play-url/errors
@xmachines/play-view	@xmachines/play-view/errors
@xmachines/play-vue-router	@xmachines/play-vue-router/errors
@xmachines/play-xstate	@xmachines/play-xstate/errors

PlayError is the base of every subclass above, and it sits on the subpath with them. The root barrel of @xmachines/play exports it never: one name has one import. A package below the Play protocol, such as @xmachines/core, extends BaseError directly, so err instanceof BaseError matches every typed error of the workspace.

How to catch an error by its type

import { PlayError } from "@xmachines/play/errors";
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 of the failed synchronization
    reportToMonitoring(err);
  } else if (err instanceof PlayError) {
    // Every other error of a Play package. `BaseError` of @xmachines/core/errors
    // also matches an error of a package below the Play protocol.
    console.error(`[${err.scope}:${err.code}] ${err.message}`);
  } else {
    throw err; // Throw an unknown error again
  }
}

How to extend PlayError

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

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

Extends

• BaseError

Extended by

• NonNullableError
• DuplicateBridgeError
• DuplicateRoutePathError
• EmptyRoutePathError
• InvalidBasePathError
• InvalidRoutePatternError
• InvalidStateIdError
• MissingBasePathParamError
• RouterSyncError
• UnknownStateTypeError
• InvalidBasePathError
• InvalidRoutePatternError
• MissingBasePathParamError
• InvalidViewOutletError
• ReadOnlyContextError
• ViewElementKeyCollisionError
• VueRouterNavigationError
• VueRouterSendError
• ActorThrewNonErrorError
• InvalidEventError
• InvalidMachineError
• InvalidRouteHandlerError
• InvalidRouteMetadataError
• InvalidRouteParamError
• MissingRouteParamError
• MissingStateIdError

Constructors

Constructor

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

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

Parameters

Parameter	Type	Description
scope	string	The class or the module that throws this error.
code	string	The machine-readable identifier of the error, for example "PLAY_ROUTER_SYNC_FAILED". A Play package names a code PLAY_<PACKAGE>_<DESCRIPTION>.
message	string	The description for a person. Never match on it in your code.
options?	ErrorOptions	The standard ErrorOptions. Give { cause: originalError } to make a chain of errors.

Returns

PlayError

Overrides

BaseError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
cause?	public	unknown	-	BaseError.cause	-
code	readonly	string	A stable, machine-readable identifier of the error. An error code follows the naming convention <PACKAGE>_<DESCRIPTION>, and a Play package writes PLAY_<PACKAGE>_<DESCRIPTION>. A code stays the same across each patch release and each minor release of one major version. Never match on .message. Always match on .code, or on the subclass.	BaseError.code	packages/core/src/errors.ts:56
message	public	string	-	BaseError.message	-
name	public	string	-	BaseError.name	-
scope	readonly	string	The class or the module that threw this error, for example "asDisposable".	BaseError.scope	packages/core/src/errors.ts:46
stack?	public	string	-	BaseError.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.	BaseError.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

BaseError.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

BaseError.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

BaseError.prepareStackTrace