# @askrjs/schema 中文文档

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

版本：0\.5\.0
npm 元数据更新时间：2026-10-13T18:25:18.237Z
中文译文更新时间：2026-11-07T08:43:38.618Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：73.7 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：0 个
- 首次发布：2026-07-15T19:20:28.801Z
- 最新版本发布：2026-10-13T18:25:17.812Z
- 近 30 天下载量：1972（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

为 Askr 有确定性 OpenAPI 预测的可执行计划

## 安装

```sh
npm install @askrjs/schema
```

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

## README

# @ askrjs/ schema

[![CI](https://github.com/askrjs/askr-schema/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/askrjs/askr-schema/actions/workflows/ci.yml) [![npm version](https://img.shields.io/npm/v/%40askrjs%2Fschema.svg)](https://www.npmjs.com/package/@askrjs/schema)

可执行, TypeScript- first schemas 有确定性的 OpenAPI 3.1 投影. 同一声明验证运行时间输入通过 `safeParse()` 并揭露 其极易改变的文件形状 `jsonSchema`。 。 。 .

```ts
import { schema, type InferSchema } from "@askrjs/schema";

const User = schema.object({
  id: schema.uuid(),
  name: schema.string({ minLength: 1 }),
  nickname: schema.optional(schema.string()),
});

type User = InferSchema<typeof User>;
const result = User.safeParse({ id: crypto.randomUUID(), name: "Ada" });
```

验证失败包含稳定的路径数组,代码和消息. 对象 默认拒绝未申报的密钥; 选择附加密钥 `additionalProperties: true` 或者用别的计谋来证实他们.

`schema.object()` 财务报告和审定财务报表 `schema.record()` 返回时 `ObjectSchema`运输安全 由动作输入,路由搜索,和服务器操作输入所使用的schema子类型. 字符串格式仅限于运行时执行的格式. 使用 `schema.raw()` 当一个整合有意拥有自定义格式时.

`schema.raw(projection, safeParse)` 是明确的扩展接合。 这需要 可执行解析器, 所以只使用文档的声明不能伪装成一个 运行时间计划。 命名的组件引用由 `@askrjs/server` ,同时保留原图解.

见 [文件/目录](https://npmcn.com/package/%40askrjs/schema/docs/schema.md) 用于完整的内置词汇和 投影保证.

构造选项,enum成员和对象声明被快照. 计数必须是非负数整数,数值限制为有限度,以及 `multipleOf` 阳性。 空的组合器、重复的词组和非无限的词组 施工期间被拒绝。 预测必须是循环的,不得比 256个嵌入式容器;使用 JSON Schema `$ref` 与 `raw()` 用于手动重现. 在探访子女之前,被宣布的最大尺寸拒绝过多的投入.

## 0.5.0 准备

见 [完整 API 决定和迁移](https://npmcn.com/package/%40askrjs/schema/docs/0.5.0-api.md) 财务报告和审定财务报表 [已执行边界证据](https://npmcn.com/package/%40askrjs/schema/docs/0.5.0-hardening.md)。该清单仍在 0.4.x 直至协调释放资格.

## 发展

```sh
npm ci
npm run check
npm run pack:check
```

该软件包使用Vite Plus,并发布来自 `dist/`,加上其变更日志和合同/移民文件.

## 常见问题

### @askrjs/schema 是什么？

为 Askr 有确定性 OpenAPI 预测的可执行计划

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

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

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

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

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

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

### @askrjs/schema 需要什么版本的 Node\.js？

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

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

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

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

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

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

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