Class: InvalidRouteParamError

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

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

buildRouteUrl() throws this error when a route parameter carries a value that no path can hold, so the template matches the built URL back never.

A dot segment is that value. A URL parser resolves . and .. BEFORE it decodes the percent escapes, and it counts %2e as the dot, so every encoding of them resolves away: /files/.. becomes /. The actor would hold the route /files/.. while the address bar shows /, and the two stay out of step for the rest of the session.

Give the param a value that names a segment. Machine state that can carry a path from a user belongs behind a check of its own, in the same way that a base path checks the values of its :param segments.

Error code: PLAY_XSTATE_ROUTE_PARAM_INVALID

Example

import { buildRouteUrl } from "@xmachines/play-xstate/routing";
import { InvalidRouteParamError } from "@xmachines/play-xstate/errors";

try {
  buildRouteUrl("/files/:name", { params: { name: ".." }, query: {} });
} catch (err) {
  if (err instanceof InvalidRouteParamError) {
    console.error(`"${err.value}" cannot stand in "${err.param}"`);
  }
}

Extends

PlayError

Constructors

Constructor

new InvalidRouteParamError(
   param,
   value,
   template
): InvalidRouteParamError;

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

Parameters

Parameter	Type
`param`	`string`
`value`	`string`
`template`	`string`

Returns

InvalidRouteParamError

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
`message`	`public`	`string`	-	`PlayError`.`message`	-
`name`	`public`	`string`	-	`PlayError`.`name`	-
`param`	`readonly`	`string`	The name of the route parameter that carries the value, for example `"name"`.	-	packages/play-xstate/src/errors.ts:102
`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`	-
`template`	`readonly`	`string`	The route template that declares the parameter, for example `"/files/:name"`.	-	packages/play-xstate/src/errors.ts:108
`value`	`readonly`	`string`	The value that no path can hold, for example `".."`.	-	packages/play-xstate/src/errors.ts:105
`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