# @bufbuild/connect-query 中文文档

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

版本：0\.4\.1
npm 元数据更新时间：2026-09-16T06:38:27.719Z
中文译文更新时间：2026-11-08T18:25:28.157Z
软件包许可：Apache-2\.0

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

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

弃用说明：Connect has moved to its own org @connectrpc and has a stable v1\. Run \`npx @connectrpc/connect-migrate@latest\` to update\. See https://github\.com/connectrpc/connect-es/releases/tag/v0\.13\.1 for details\.

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

- 包体积（解压后）：141 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：react ^18\.2\.0，react-dom ^18\.2\.0，@bufbuild/connect \>=0\.12\.0，@bufbuild/protobuf \>=1\.3\.0，@tanstack/react-query ^4\.20\.4
- 首次发布：2022-12-13T18:00:20.593Z
- 最新版本发布：2023-08-11T21:32:39.646Z
- 近 30 天下载量：133089（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 0 个）

## 中文简介

这是Connect-Query的运行时库软件包 。 你会发现它的代码生成器在 [@bufbuilding/protoc-gen-connect-query (英语)](https://www.npmjs.com/package/@bufbuild/protoc-gen-connect-query)。 。 。 .

## 安装

```sh
npm install @bufbuild/connect-query
```

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

## README

# @ bufbuilding/ 连接- query

这是Connect-Query的运行时库软件包 。 你会发现它的代码生成器在 [@bufbuilding/protoc-gen-connect-query (英语)](https://www.npmjs.com/package/@bufbuild/protoc-gen-connect-query)。 。 。 .

连接查询是一个扩展包 [TanStack 查询](https://tanstack.com/query) (react-query),用TypeScript书写并经过彻底测试. 它能与会说话的服务器进行无心交流 [连接协议](https://connectrpc.com/docs/protocol)。 。 。 .

程序的定义载于 [协议缓冲](https://developers.google.com/protocol-buffers) 由您的后端执行的 schema, 而 Connect-Query 生成客户端和相关类型以使用 TanStack Query 访问后端 。 客户端支持两个协议:gRPC-web,和Connect自己的协议.

为开始,去那边 [文档](https://connectrpc.com/docs/query/getting-started) 用于教学,或查看 [我们的榜样](https://github.com/bufbuild/connect-query/examples) 与各种框架相结合.

## 常见问题

### @bufbuild/connect-query 是什么？

这是Connect-Query的运行时库软件包 。 你会发现它的代码生成器在 @bufbuilding/protoc-gen-connect-query \(英语\)。 。 。 \.注意：该包已被作者标记为弃用——Connect has moved to its own org @connectrpc and has a stable v1\. Run \`npx @connectrpc/connect-migrate@latest\` to update\. See https://github\.com/connectrpc/connect-es/releases/tag/v0\.13\.1 for details\.

### 如何安装 @bufbuild/connect-query？

在项目目录运行 npm install @bufbuild/connect-query，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0）、react-dom（^18\.2\.0）、@bufbuild/connect（\>=0\.12\.0）、@bufbuild/protobuf（\>=1\.3\.0）、@tanstack/react-query（^4\.20\.4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bufbuild/connect-query 支持 TypeScript 吗？

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

### @bufbuild/connect-query 支持 ESM 还是 CommonJS？

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

### @bufbuild/connect-query 可以商用吗？

@bufbuild/connect-query 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bufbuild/connect-query 的下载量有多少？

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

### @bufbuild/connect-query 还在维护吗？

最新版本 0\.4\.1 发布于 2023/08/12（3 年前）；至今共发布 23 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/12/14。作者已将其标记为弃用，新项目建议寻找替代方案。