Skip to content

Interface: RouteMapping

Documentation / @xmachines/play-tanstack-solid-router / RouteMapping

Defined in: play-tanstack-solid-router/src/types.ts:19

A single state ID ↔ path mapping entry for the TanStack Solid Router adapter.

Structurally compatible with BaseRouteMapping from @xmachines/play-router. Fields are readonly — entries are immutable once passed to RouteMap.

Example

const mapping: RouteMapping = { stateId: "#profile", path: "/profile/:userId" };

Properties

PropertyModifierTypeDescriptionDefined in
pathreadonlystringTanStack Router path pattern (e.g., "/", "/profile/:userId", "/settings/:section?")play-tanstack-solid-router/src/types.ts:23
stateIdreadonlystringXMachines state ID (e.g., "#home", "#profile")play-tanstack-solid-router/src/types.ts:21