Parse Query String into Object

parseQueryString

The parseQueryString function parses a URL query string (with or without a leading ?) into a JavaScript object. It supports arrays for repeated keys and can convert numeric, boolean, or nullish strings into their actual primitive types.

Function Signature

function parseQueryString<QParams extends ParsedQueryGeneric>(
  query: string,
  parsePrimitives?: boolean
): QParams

Parameters

• query (string): The query string to parse.
• parsePrimitives (boolean, optional): When true, converts numeric, boolean, and nullish strings to their primitive types. Defaults to true.

Return Value

• QParams: A JavaScript object mapping keys to values (primitive, array of primitives, or string).

Example Usage

Aliases

The following aliases can be used for the parseQueryString function:

• getQueryStringAsObject
• queryStringToObject

parseQueryStringLiteral

Parses a literal query string type into a strictly typed JavaScript object. This utility is designed specifically for literal string types to provide compile-time type safety.

Function Signature

function parseQueryStringLiteral<Q extends string>(query: Q): ParsedQuery<Q>

Parameters

• query (Q): The literal query string to parse (supports as const).

Return Value

• ParsedQuery<Q>: A strictly typed object matching the literal properties parsed from query. All values are inferred as string literals or arrays of string literals.

Example Usage

Aliases

The following aliases can be used for the parseQueryStringLiteral function:

• literalQueryStringToObject

Types

type ParsedQueryGeneric = Record<string, NormalPrimitive | NormalPrimitive[]>;
type NormalPrimitive = string | number | boolean | null | undefined;