Function: extractParams()

Documentation / @xmachines/play-tanstack-react-router / extractParams

function extractParams(pathname, pattern): Record<string, string>;

Defined in: play-tanstack-react-router/src/extract-params.ts:29

Extract route parameters from URL path based on route pattern using URLPattern API

Parameters

Parameter	Type	Description
pathname	string	Actual URL path (e.g., “/profile/123”)
pattern	string	Route pattern with params (e.g., “/profile/:userId“)

Returns

Record<string, string>

Object with extracted parameters

Example

extractParams("/profile/123", "/profile/:userId");
// Returns: { userId: "123" }

extractParams("/api/123", "/api/:id(\\d+)");
// Returns: { id: "123" }
// Validates numeric constraint via URLPattern

extractParams("/docs/intro", "/docs/*");
// Returns: { "0": "intro" }