Class: InvalidBasePathError

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

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

Thrown when a basePath option resolves to one concrete URL prefix never.

A bridge writes a real browser URL from its prefix, so every segment must hold exactly one value. A wildcard segment (*), an optional segment (:section?), a nameless : segment, a query string, and a hash fragment each describe a SET of prefixes instead, or no prefix at all. A $param segment is the route-param syntax of TanStack Router: a base path writes a param as :param, and it takes the value of that param from basePathParams.

How to fix it: mount on the prefix itself, and let the machine own the rest. For the splat route /$machineId/play/$ of TanStack, the base path is "/:machineId/play" with basePathParams: { machineId }.

Error code: PLAY_ROUTER_INVALID_BASE_PATH

Example

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

try {
  bridge.setBasePath("/:machineId/play/*");
} catch (err) {
  if (err instanceof InvalidBasePathError) {
    console.error(`Bad base path: "${err.basePath}"`, err.message);
  }
}

Extends

PlayError

Constructors

Constructor

new InvalidBasePathError(basePath, reason): InvalidBasePathError;

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

Parameters

Parameter	Type
`basePath`	`string`
`reason`	`string`

Returns

InvalidBasePathError

Overrides

PlayError.constructor

Properties

Property	Modifier	Type	Description	Inherited from	Defined in
`basePath`	`readonly`	`string`	The `basePath` option of the refusal, exactly as the caller gave it.	-	packages/play-url/src/errors.ts:101
`cause?`	`public`	`unknown`	-	`PlayError`.`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.	`PlayError`.`code`	packages/core/src/errors.ts:56
`message`	`public`	`string`	-	`PlayError`.`message`	-
`name`	`public`	`string`	-	`PlayError`.`name`	-
`scope`	`readonly`	`string`	The class or the module that threw this error, for example `"asDisposable"`.	`PlayError`.`scope`	packages/core/src/errors.ts:46
`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