# @cratestack/adapter-tanstack-query 中文文档

规范地址：https://npmcn.com/package/%40cratestack/adapter-tanstack-query/

版本：0\.19\.3
npm 元数据更新时间：2026-11-09T15:58:17.566Z
中文译文更新时间：2026-11-10T23:49:04.452Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：13.3 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：1 个
- peer 依赖：@tanstack/query-core ^5\.105\.0
- 首次发布：2026-08-02T03:44:49.242Z
- 最新版本发布：2026-11-09T15:58:17.189Z
- 近 30 天下载量：2441（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 67 个）

## 中文简介

通用 TanStack 查询选项构建器( query/ mutation) 超过 CrateStack 生成的 TypeScript RPC 客户端.

## 安装

```sh
npm install @cratestack/adapter-tanstack-query
```

也可以使用：`pnpm add @cratestack/adapter-tanstack-query`、`yarn add @cratestack/adapter-tanstack-query`、`bun add @cratestack/adapter-tanstack-query`

## README

# @cratetack/适应器-tastack-query

常规 [TanStack 查询](https://tanstack.com/query) 选项构建器在 CrateStack 生成后 TypeScript RPC 客户端(`transport rpc` schemas),用于手写查询/修饰没有的钩子 完全通过生成 `use{Model}Query`编号 :`use{Model}Mutation` 钩子 (单位:千美元)`cratestack generate-typescript`属于自己的 `rpc-react-query.ts.j2` (产出)——例如,调用 `procedure` 生成的钩子尚未覆盖,或者使用vue-query/soli-query/svelte-query 改为 `@tanstack/react-query`。 。 。 .

框架不可知性:这里所有东西都按 `@tanstack/query-core`,每个TanStack 绑定的查询框架建立在基础之上.

## 使用量

```ts
import {
  rpcQueryOptions,
  rpcMutationOptions,
  isRpcErrorCode,
} from "@cratestack/adapter-tanstack-query";
import { useQuery, useMutation } from "@tanstack/react-query";
import { client } from "./generated/client"; // your project's generated client instance

function useWidget(id: number) {
  return useQuery({
    ...rpcQueryOptions(client.runtime, "model.Widget.get", { id }),
    retry: (failureCount, error) => !isRpcErrorCode(error, "not_found") && failureCount < 3,
  });
}

function useCreateOrder() {
  return useMutation(rpcMutationOptions(client.runtime, "model.Order.create"));
}
```

`rpcQueryOptions`编号 :`rpcMutationOptions` 拿着 `RpcCaller` - 任何具有下列特性的物体: `call<I, O>(opId, input, options?)` 方法,也就是生成客户端的形状 公开 `.runtime` 字段 (`CratestackRpcRuntime`) (中文(简体) ). 这样的要求也一样 `links` 链 (`@cratestack/link-batch`, (中文(简体) ), `@cratestack/link-logger`(等等)与所有其他呼吁一样 运行时间.

## `BigInt` 字段

A 类 `BigInt` 生成客户端的字段是 `bigint` (ADR 0019), 和谭斯塔克调查 散列a 查询密钥为 `JSON.stringify`),它投出一("不知道如何将一款大Int序列"). `rpcQueryKey`这样 `rpcQueryOptions`,存储 `bigint` 在任何深度输入中,作为 犬形小数字符串:客户端在线上发送的同文. 两个不同的值是两个 键`2n ** 53n` 财务报告和审定财务报表 `2n ** 53n + 1n` 分开 `number` 以便他们圆圆 相同的值是相同的键。 请求本身仍然得到真正的 `bigint`; 生成 运行时间编码它.

```ts
useQuery(rpcQueryOptions(client.runtime, "model.Counter.get", { id: 9007199254740993n }));

// Build the key you invalidate with through the same function: a hand-written
// key holding a raw bigint neither hashes nor matches the stored one.
queryClient.invalidateQueries({
  queryKey: rpcQueryKey("model.Counter.get", { id: 9007199254740993n }),
});
```

## 常见问题

### @cratestack/adapter-tanstack-query 是什么？

通用 TanStack 查询选项构建器\( query/ mutation\) 超过 CrateStack 生成的 TypeScript RPC 客户端\.

### 如何安装 @cratestack/adapter-tanstack-query？

在项目目录运行 npm install @cratestack/adapter-tanstack-query，或使用 pnpm add / yarn add / bun add。

### @cratestack/adapter-tanstack-query 支持 TypeScript 吗？

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

### @cratestack/adapter-tanstack-query 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cratestack/adapter-tanstack-query 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cratestack/adapter-tanstack-query 可以商用吗？

@cratestack/adapter-tanstack-query 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cratestack/adapter-tanstack-query 的下载量有多少？

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

### @cratestack/adapter-tanstack-query 还在维护吗？

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