# @bnussman/query-key 中文文档

规范地址：https://npmcn.com/package/%40bnussman/query-key/

版本：0\.0\.8
npm 元数据更新时间：2024-01-13T03:58:27.913Z
中文译文更新时间：2026-11-08T09:31:11.852Z
软件包许可：未声明

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bnussman/query-key
原文对照：https://npmcn.com/package/%40bnussman/query-key/?lang=original
项目主页：https://github.com/bnussman/query-key#readme
源码仓库：https://github.com/bnussman/query-key

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：6.8 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：typescript ^5\.0\.0
- 首次发布：2023-11-28T21:50:53.685Z
- 最新版本发布：2024-01-13T03:58:27.749Z
- 近 30 天下载量：11385（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

帮助您构建类型安全查询密钥的简单软件包 [`@tanstack/react-query`](https://tanstack.com/query) 🔑

## 安装

```sh
npm install @bnussman/query-key
```

也可以使用：`pnpm add @bnussman/query-key`、`yarn add @bnussman/query-key`、`bun add @bnussman/query-key`

## README

# @bnussman/query-键

帮助您构建类型安全查询密钥的简单软件包 [`@tanstack/react-query`](https://tanstack.com/query) 🔑

此软件包的灵感来自并类似于 [`@lukemorales/query-key-factory`](https://github.com/lukemorales/query-key-factory),但允许您输入查询.

## 🚀主要地物

-   根据对象形状生成类型安全查询密钥
-   严格夫妇查询键和查询Fn [这个](https://twitter.com/TkDodo/status/1724082589068075450) 建议
-   允许无限地筑巢

## 使用量

```typescript
import { getQueryKeys } from '@bnussman/query-key';
import { useQuery } from '@tanstack/react-query';

const queries = getQueryKeys({
  users: {
    paginated: (params: Params = {}, filter: Filter = {}) => ({
      queryFn: () => getUsers(params, filter),
      queryKey: [params, filter]
    }),
    user: (id: string) => ({
      queryFn: () => getUser(id)
    }),
    all: {
      queryFn: getAllUsers
    }
  },
});

const useUsersQuery = (params: Params, filter: Filter) => 
  useQuery<Page<User>, APIError[]>(queries.users.paginated(params, filter));

const useUserQuery = (id: string, enabled = true) => 
  useQuery<User, APIError[]>({
    ...queries.users.user(id),
    enabled,
  });

const useAllUsersQuery = (params: Params, filter: Filter) => 
  useQuery<User[], APIError[]>(queries.users.all);

const useUserMutation = (id: string) => {
  const queryClient = useQueryClient();

  return useMutation<User, APIError[], Partial<User>>({
    mutationFn: (data) => updateUser(id, data),
    onSuccess: (user) => {
      queryClient.setQueryData(queries.users.user(id).queryKey, user);
      queryClient.invalidateQueries(queries.users.paginated.queryKey);
      queryClient.invalidateQueries(queries.users.all.queryKey);
    },
  });
};
```

## 常见问题

### @bnussman/query-key 是什么？

帮助您构建类型安全查询密钥的简单软件包 @tanstack/react-query 🔑

### 如何安装 @bnussman/query-key？

在项目目录运行 npm install @bnussman/query-key，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bnussman/query-key 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @bnussman/query-key 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @bnussman/query-key 可以商用吗？

@bnussman/query-key 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @bnussman/query-key 的下载量有多少？

根据 npm 官方下载统计，@bnussman/query-key 在 2026/10/09 – 2026/11/07 这 30 天内被下载 11,385 次，日均约 380 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bnussman/query-key 还在维护吗？

最新版本 0\.0\.8 发布于 2024/01/13（2 年前）；至今共发布 2 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/11/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。