feat: Add UrlKeys type helper

[franky47]

This helps defining the values for urlKeys in a type-safe manner by tying it to a parsers object.

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
})

Note: the UrlKeys type is intentionally wider to work in useQueryStates, which does not (yet) use the ParsersMap also introduced in this PR.

[email protected] will deprecate some of the internal types exported in useQueryStates.ts, and remap them to be based on ParsersMap. This will mark the serialize and eq functions of parsers required, possibly breaking userland code, so it will be the subject of another PR.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nuqs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 26, 2024 10:15am

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/nuqs@824

commit: 07234e3

[github-actions]

🎉 This PR is included in version 2.3.0-beta.2 🎉

The release is available on:

• npm package (@beta dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[github-actions]

🎉 This PR is included in version 2.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀