nuqs

nuqs API Reference

nuqs — Type-safe URL query state management for React。 React.useState Synchronize URL query parameters and state as a drop-in replacement for.

Directory Structure

skills/nuqs/
  SKILL.md
  references/
    hooks/
      README.md
      useQueryState.md
      useQueryStates.md
    parsers/
      README.md
      built-in.md
      custom.md
    options/
      README.md
      options.md
    server/
      README.md
      server-side.md
    utilities/
      README.md
      createSerializer.md
      createStandardSchemaV1.md
      inferParserType.md
    limits/
      README.md
      limits.md
  samples/
    README.md
    basic-query-state.md
    typed-state-with-parsers.md
    multiple-params-batch-update.md
    search-filter-debounce.md
    server-side-parsing.md
    search-params-cache.md
    adapter-setup.md
    custom-parser.md
    url-key-remapping.md
    array-params.md
    testing.md
  scripts/
    README.md
    install.md
    setup.md
    testing.md
    debug.md

Exploration Procedure

Derive the category from the task, and identify the target page in the category's README.md:

1. Find the category corresponding to the task in the mapping table below
2. For that category references/{category}/README.md Refer to and identify the target page
3. The relevant page's .md Read and check the details

Task → Category Mapping

Task	Category	Reference README
Basic usage of useQueryState, reading and writing a single parameter	hooks	references/hooks/README.md
Batch updates with useQueryStates, synchronizing multiple parameters	hooks	references/hooks/README.md
How to use built-in parsers (parseAsString / parseAsInteger / parseAsBoolean / parseAsArrayOf, etc.)	parsers	references/parsers/README.md
Create a custom parser with createParser	parsers	references/parsers/README.md
history, shallow, scroll, throttle, debounce, clearOnDefault, startTransition option settings	options	references/options/README.md
Server-side parsing with createLoader, createSearchParamsCache	server	references/server/README.md
Generate utilities from parsers with createSerializer, createStandardSchemaV1, inferParserType	utilities	references/utilities/README.md
I want to know about URL length and browser limits (throttling, max URL length)	limits	references/limits/README.md
I want to know typical usage	samples	samples/README.md
I want to know installation, CLI commands, testing, and debugging procedures	scripts	scripts/README.md