@bufbuild/connect-query

中文文档
0.4.1发布于 2023/08/12Apache-2.0TypeScriptESM + CJS近 30 天下载 13.3万

This is the runtime library package for Connect-Query. You'll find its code generator at @bufbuild/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

This is the runtime library package for Connect-Query. You'll find its code generator at @bufbuild/protoc-gen-connect-query.

Connect-Query is an expansion pack for TanStack Query (react-query), written in TypeScript and thoroughly tested. It enables effortless communication with servers that speak the Connect Protocol.

The procedures are defined in a Protocol Buffer schema implemented by your backend, and Connect-Query generates the clients and related types to access the backend with TanStack Query. The clients support two protocols: gRPC-web, and Connect's own protocol.

To get started, head over to the docs for a tutorial, or take a look at our examples for integration with various frameworks.

版本与发布记录

@bufbuild/connect-query 共发布 23 个版本,首次发布于 2022/12/14;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.4.1latest2023/08/123 年前
0.4.02023/07/063 年前
0.3.02023/06/153 年前
0.2.32023/05/253 年前
0.2.22023/05/243 年前
0.2.12023/04/263 年前

其他发布通道:alpha → 0.2.0-alpha.5。

关于 @bufbuild/connect-query 的常见问题

@bufbuild/connect-query 是什么?

This is the runtime library package for Connect-Query. You'll find its code generator at @bufbuild/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。作者已将其标记为弃用,新项目建议寻找替代方案。