Type Alias UrlKeys<Parsers>

Helper type to define and reuse urlKey options to rename search params keys

Usage:

import { type UrlKeys } from 'nuqs' // or 'nuqs/server'

export const coordinatesSearchParams = {
  latitude: parseAsFloat.withDefault(0),
  longitude: parseAsFloat.withDefault(0),
}
export const coordinatesUrlKeys: UrlKeys<typeof coordinatesSearchParams> = {
  latitude: 'lat',
  longitude: 'lng',
}

// Later in the code:
useQueryStates(coordinatesSearchParams, {
  urlKeys: coordinatesUrlKeys
})
createSerializer(coordinatesSearchParams, {
  urlKeys: coordinatesUrlKeys
})
createSearchParamsCache(coordinatesSearchParams, {
  urlKeys: coordinatesUrlKeys
})
Copy