Class: InvalidEventError

API / @xmachines/play-xstate / errors / InvalidEventError

Defined in: packages/play-xstate/src/errors.ts:250

PlayerActor.send() throws this error when the event argument is not a plain object.

A PlayEvent needs the shape { type: string, ...fields }. A null value, an undefined value, a string, and every other value that is not an object are an error of the programmer.

The error holds the value in question in its readonly class field detail, for the debug work. A TypeScript consumer reads err.detail directly, with no unsafe cast.

Error code: PLAY_XSTATE_INVALID_EVENT

Example

import { InvalidEventError } from "@xmachines/play-xstate/errors";

try {
  actor.send(null as any);
} catch (err) {
  if (err instanceof InvalidEventError) {
    // err.detail has the type `unknown`, and it needs no cast
    console.error("Invalid event passed to actor.send():", err.detail);
  }
}

Extends

PlayError

Constructors

Constructor

new InvalidEventError(detail): InvalidEventError;

Defined in: packages/play-xstate/src/errors.ts:254

Parameters

Parameter	Type
`detail`	`unknown`

Returns

InvalidEventError

Overrides

PlayError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`cause?`	`public`	`unknown`	-	`PlayError`.`cause`	-
`code`	`readonly`	`string`	A stable, machine-readable identifier of the error. An error code follows the naming convention `PLAY_<PACKAGE>_<DESCRIPTION>`. It 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.	`PlayError`.`code`	packages/play/src/errors.ts:76
`detail`	`readonly`	`unknown`	The value in question, from the `send()` call.	-	packages/play-xstate/src/errors.ts:252
`message`	`public`	`string`	-	`PlayError`.`message`	-
`name`	`public`	`string`	-	`PlayError`.`name`	-
`scope`	`readonly`	`string`	The class or the module that threw this error, for example `"RouterBridgeBase"`.	`PlayError`.`scope`	packages/play/src/errors.ts:66
`stack?`	`public`	`string`	-	`PlayError`.`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.	`PlayError`.`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

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

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

PlayError.prepareStackTrace