# @comapeo/schema 中文文档

规范地址：https://npmcn.com/package/%40comapeo/schema/

版本：2\.3\.0
npm 元数据更新时间：2026-05-05T19:46:43.910Z
中文译文更新时间：2026-11-10T11:52:14.327Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.4 MB，95 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2024-09-17T15:14:28.408Z
- 最新版本发布：2026-05-05T19:46:43.455Z
- 近 30 天下载量：3815（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 1 个）

## 中文简介

CoMapeo 的 JSON Schema 和类型脚本类型

## 安装

```sh
npm install @comapeo/schema
```

也可以使用：`pnpm add @comapeo/schema`、`yarn add @comapeo/schema`、`bun add @comapeo/schema`

## README

# @ comapeo/ schema

CoMapeo的JSON Schema和TypeScript类型.

原件:https://hackmd.io/wlMcMM65TmuPXGYOEBOR2g#

## 目录

-   [安装](https://npmcn.com/package/%40comapeo/schema/#readme-install)
-   [使用量](https://npmcn.com/package/%40comapeo/schema/#readme-usage)
-   [API 密码](https://npmcn.com/package/%40comapeo/schema/#readme-api)
-   [维护者](https://npmcn.com/package/%40comapeo/schema/#readme-maintainers)
-   [许可证](https://npmcn.com/package/%40comapeo/schema/#readme-license)

## 安装

```sh
npm install --save @comapeo/schema
```

## 使用量

### 联合来文审定职能

```js
import { validate } from '@comapeo/schema'

const testObservation = {
  /* ... */
}

const isValid = validate('observation', testObservation)
// returns true if validates against schema, false otherwise.
```

### 类型脚本

```typescript
import type { Observation } from '@comapeo/schema'

const myObs: Observation = {
  /* ... */
}
```

## API 密码

## 添加新值

-   在里面找到JSON计划 `schemas/{name}/v1.json`
-   添加您描述的字段
-   更新内部相应的协议缓冲方案 `proto/{name}/v1.proto`
-   添加新字段为 `src/lib/decode-conversions.js` 财务报告和审定财务报表 `src/lib/encode-conversions.js`
-   运行 `npm run build` 用于构建类型和编码器.
-   将字段添加到 `test/fixtures/good-docs-completed.js`
-   如果出现额外校验, 则将一个失败的文档添加到 `test/fixtures/bad-docs.js`
-   运行 `npm run test` 并且确保考试和结业

## 维护者

[@ digidem (英语)](https://github.com/digidem)

## 许可证

麻省理工学院 2024 Awana数字

## 常见问题

### @comapeo/schema 是什么？

CoMapeo 的 JSON Schema 和类型脚本类型

### 如何安装 @comapeo/schema？

在项目目录运行 npm install @comapeo/schema，或使用 pnpm add / yarn add / bun add。

### @comapeo/schema 支持 TypeScript 吗？

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

### @comapeo/schema 支持 ESM 还是 CommonJS？

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

### @comapeo/schema 可以商用吗？

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

### @comapeo/schema 的下载量有多少？

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

### @comapeo/schema 还在维护吗？

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