Class: InvalidRoutePatternError

API / @xmachines/play-router / errors / InvalidRoutePatternError

Defined in: packages/play-url/src/errors.ts:45

The library throws this error when URLPattern cannot compile the string of a route pattern. The pattern field holds the string in question, and cause holds the original error of the URLPattern constructor.

Every compilation reports through this error, so extractRouteParams raises it for a pattern that no RouteMap ever held, and not a bare TypeError.

The common causes:

• A parenthesis or a bracket without its pair in the string of the pattern
• A character that a URL pathname pattern does not permit
• Two params of one pattern that land on the same URLPattern group. A name with a hyphen compiles with an underscore, so :cat-id and :cat_id are one group. The message names the two params and the group, and cause is absent: the library refuses the pattern before URLPattern sees it.

Error code: PLAY_ROUTE_MAP_INVALID_PATTERN

Example

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

try {
  const routeMap = createRouteMap(machine);
} catch (err) {
  if (err instanceof InvalidRoutePatternError) {
    console.error(`Bad route pattern: "${err.pattern}"`, err.cause);
  }
}

Extends

• PlayError

Constructors

Constructor

new InvalidRoutePatternError(pattern, options?): InvalidRoutePatternError;

Defined in: packages/play-url/src/errors.ts:55

Parameters

Parameter	Type	Description
pattern	string	The route pattern that URLPattern could not compile.
options?	ErrorOptions & object	The standard cause, and an optional reason that says WHY. Give a reason whenever the library knows it: the pattern alone shows a caller nothing when the fault is a rewrite that the library made, and not the text they wrote.

Returns

InvalidRoutePatternError

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	-
pattern	readonly	string	The string of the route pattern. URLPattern could not compile it.	-	packages/play-url/src/errors.ts:47
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