@gluonjs/router / packages/router/src / stringifyQuery

Function: stringifyQuery()

stringifyQuery(query?): string

Parameters

query?

LocationQueryRaw = {}

Returns

string

Example

Encode and deterministically sort raw query values for a Router URL while omitting undefined entries and retaining arrays:

import {
  parseQuery,
  stringifyQuery,
  type LocationQuery,
  type LocationQueryPrimitive,
  type LocationQueryRaw,
  type LocationQueryValue,
} from '@gluonjs/router';

const sort: LocationQueryPrimitive = 'price-asc';
const categories: LocationQueryValue = ['lighting', 'seating'];
const raw = { sort, category: categories, inStock: true } satisfies LocationQueryRaw;
const search = stringifyQuery(raw);
const query: LocationQuery = parseQuery(search);
console.log(search, query.category);