mcpField
N
nuqs

nuqs

github.com/fandhe-ai开发4100 次安装4 天前更新
代码仓库

关于 nuqs

nuqs 的参考技能；nuqs 是一个 React 库，可将 URL 查询参数与状态同步，作为 React.useState 的类型安全替代方案。技能按任务映射文档类别，帮助定位相关 API 说明。

主要功能

  1. 01按任务映射文档类别
  2. 02Hook 与解析器参考
  3. 03框架适配器指引
  4. 04选项与服务端 API 参考
  5. 05限制、示例和脚本说明

适用场景

  1. 01查询 useQueryState 或 useQueryStates
  2. 02选择内置或自定义解析器
  3. 03为 React 框架配置适配器
  4. 04查找 URL 限制或服务端解析说明

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/fandhe-ai/agent-reference-skills --skill nuqs

安装后在 Claude Code 中输入/nuqs确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/adapters/
adapters.md
README.md
references/guides/
README.md
seo.md
tips-tricks.md
troubleshooting.md
references/hooks/
README.md
useQueryState.md
useQueryStates.md
references/limits/
limits.md
README.md
references/options/
options.md
README.md
references/parsers/
built-in.md
community-effect-schema.md
community-sury.md
community-tanstack-table.md
community-zod-codecs.md
custom.md
README.md
references/server/
README.md
server-side.md
references/utilities/
createSerializer.md
createStandardSchemaV1.md
inferParserType.md
README.md
samples/
adapter-setup.md
array-params.md
basic-query-state.md
custom-parser.md

详细介绍

nuqs API 参考

nuqs — 面向 React 的类型安全 URL 查询状态管理。 作为 React.useState 的直接替代方案，同步 URL 查询参数与状态。

适用于 nuqs v2.10.2（2026-10-08，GitHub tag v2.10.2，文档源文件位于该 tag 下的 packages/docs/content/docs）。

目录结构

skills/nuqs/
  SKILL.md
  references/
    hooks/
      README.md
      useQueryState.md
      useQueryStates.md
    parsers/
      README.md
      built-in.md
      custom.md
      community-zod-codecs.md
      community-effect-schema.md
      community-sury.md
      community-tanstack-table.md
    adapters/
      README.md
      adapters.md
    guides/
      README.md
      troubleshooting.md
      seo.md
      tips-tricks.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
    suspense-boundary.md
    seo-canonical-url.md
  scripts/
    README.md
    install.md
    setup.md
    testing.md
    debug.md

探索步骤

根据任务查找类别，并在类别的 README.md 中确定目标页面：

  1. 在下方映射表中查找与任务对应的类别
  2. 参考该类别的 references/{category}/README.md，确定目标页面
  3. Read 对应页面的 .md，查看详细信息

任务 → 类别映射

任务类别参考 README
useQueryState 的基本用法、读写单个参数hooksreferences/hooks/README.md
使用 useQueryStates 批量更新、同步多个参数hooksreferences/hooks/README.md
内置解析器（parseAsString / parseAsInteger / parseAsBoolean / parseAsArrayOf 等）的用法parsersreferences/parsers/README.md
使用 createParser 创建自定义解析器、Zod codecs / Effect Schema / Sury / TanStack Table 社区解析器parsersreferences/parsers/README.md
各框架的 NuqsAdapter（Next.js app/pages/unified、React SPA、Remix、React Router v6/v7/v8、TanStack Router）、serverSearch、已弃用的 adapteradaptersreferences/adapters/README.md
Suspense boundary 错误、相同 key 使用不同解析器、Pages Router SSR 中的 null、canonical URL / SEO、自定义钩子复用guidesreferences/guides/README.md
history、shallow、scroll、throttle、debounce、clearOnDefault、startTransition 选项设置optionsreferences/options/README.md
使用 createLoader、createSearchParamsCache 进行服务端解析serverreferences/server/README.md
使用 createSerializer、createStandardSchemaV1、inferParserType 从解析器生成工具utilitiesreferences/utilities/README.md
了解 URL 长度和浏览器限制（throttling、max URL length）limitsreferences/limits/README.md
了解典型用法samplessamples/README.md
了解安装、CLI 命令、测试和调试步骤scriptsscripts/README.md

评论

支持 Markdown