Skip to content

Function: extractQueryParams()

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

function extractQueryParams(search): Record<string, string>;

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

Extract query parameters from search string

Parameters

ParameterTypeDescription
searchstringQuery string with or without leading ? (e.g., “?tab=settings” or “tab=settings”)

Returns

Record<string, string>

Object mapping query parameter names to values

Example

extractQueryParams("?tab=settings&theme=dark");
// Returns: { tab: "settings", theme: "dark" }
extractQueryParams("q=hello%20world");
// Returns: { q: "hello world" } (auto-decoded)