# @cheqd/ts-proto 中文文档

规范地址：https://npmcn.com/package/%40cheqd/ts-proto/

版本：4\.2\.1
npm 元数据更新时间：2026-03-09T17:39:25.998Z
中文译文更新时间：2026-11-09T12:27:59.511Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：3.5 MB，190 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.0\.0
- 运行依赖：3 个
- 首次发布：2022-07-28T10:11:17.101Z
- 最新版本发布：2026-03-09T17:39:25.872Z
- 近 30 天下载量：9620（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：102（近 12 个月 7 个）

## 中文简介

用于所有已转接的 cheqd ProtoBuf 定义的 TypeScript 包.

## 安装

```sh
npm install @cheqd/ts-proto
```

也可以使用：`pnpm add @cheqd/ts-proto`、`yarn add @cheqd/ts-proto`、`bun add @cheqd/ts-proto`

## README

# Cheqd 身份的 Protobuf 类型

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/ts-proto?color=green&label=stable%20release&style=flat-square)](https://github.com/cheqd/ts-proto/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/ts-proto?color=green&style=flat-square) [![GitHub license](https://img.shields.io/github/license/cheqd/ts-proto?color=blue&style=flat-square)](https://github.com/cheqd/ts-proto/blob/main/LICENSE)

[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/ts-proto?include_prereleases&label=dev%20release&style=flat-square)](https://github.com/cheqd/ts-proto/releases/) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/ts-proto/latest?style=flat-square) [![GitHub contributors](https://img.shields.io/github/contributors/cheqd/ts-proto?label=contributors%20%E2%9D%A4%EF%B8%8F&style=flat-square)](https://github.com/cheqd/ts-proto/graphs/contributors)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/ts-proto/dispatch.yml?label=workflows&style=flat-square)](https://github.com/cheqd/ts-proto/actions/workflows/dispatch.yml) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/ts-proto/codeql.yml?label=CodeQL&style=flat-square)](https://github.com/cheqd/ts-proto/actions/workflows/codeql.yml) ![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/ts-proto?style=flat-square)

## i️ 概览

其目的 [`@cheqd/ts-proto` 国家防范机制一揽子计划](https://www.npmjs.com/package/@cheqd/ts-proto) 即为cheqd身份功能提供可再用Protobuf定义,作为SDKs和apps使用的可再用软件包.

## 页:1

我们 [身份证件网站](https://docs.cheqd.io/identity/) 解释一下如何 `@cheqd/ts-proto` 实值 [在Veramo SDK中消费的](https://docs.cheqd.io/identity/guides/sdk/veramo-sdk-for-cheqd) (作为该套件如何被消耗的例子).

## 社区

我们 [**Discord 服务器**](http://cheqd.link/discord-github) 是我们开源社区、软件开发者和节点运营商的主要聊天渠道.

请与我们接触 在那里讨论,帮助, 和反馈项目.

## 找别的地方

[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/cheqd) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](http://cheqd.link/discord-github) [![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/intent/follow?screen_name=cheqd_io) [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](http://cheqd.link/linkedin) [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://blog.cheqd.io/) [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/)

## 常见问题

### @cheqd/ts-proto 是什么？

用于所有已转接的 cheqd ProtoBuf 定义的 TypeScript 包\.

### 如何安装 @cheqd/ts-proto？

在项目目录运行 npm install @cheqd/ts-proto，或使用 pnpm add / yarn add / bun add。

### @cheqd/ts-proto 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cheqd\_\_ts-proto 是否存在。

### @cheqd/ts-proto 支持 ESM 还是 CommonJS？

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

### @cheqd/ts-proto 需要什么版本的 Node\.js？

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

### @cheqd/ts-proto 可以商用吗？

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

### @cheqd/ts-proto 的下载量有多少？

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

### @cheqd/ts-proto 还在维护吗？

最新版本 4\.2\.1 发布于 2026/03/10（8 个月前）；至今共发布 102 个版本，其中过去 12 个月发布了 7 个；首次发布于 2022/07/28。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。