# @asterql/schema 中文文档

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

版本：0\.5\.0
npm 元数据更新时间：2026-07-08T20:31:02.815Z
中文译文更新时间：2026-11-07T00:41:10.174Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：32.7 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-06-11T01:35:26.660Z
- 最新版本发布：2026-07-08T20:31:02.711Z
- 近 30 天下载量：5019（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 4 个）

## 中文简介

用于AsterQL数据塑造和代码生成的TypeNode schemas.

## 安装

```sh
npm install @asterql/schema
```

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

## README

# @ asterql/schema

```sh
npm install @asterql/schema
```

用于AsterQL数据塑造和代码生成的TypeNode schemas.

这个包裹是故意小的。 它给AsterQL的其余堆叠 可代表实用类型Script-形状JSON的普通JSON类型图, 包括取名参考物的递归和再利用形状.

```ts
import {
  arrayType,
  defineSchema,
  objectType,
  optionalProp,
  refType,
  stringType,
} from "@asterql/schema";

const schema = defineSchema({
  root: refType("Category"),
  definitions: {
    Category: objectType({
      id: stringType(),
      title: stringType(),
      parent: optionalProp(refType("Category")),
      children: arrayType(refType("Category")),
    }),
  },
});
```

## 型号

```ts
type TypeSchema = {
  root: TypeNode;
  definitions: Record<string, TypeNode>;
};
```

`refType("Name")` 点数 `definitions.Name`。从不扩大参考资料 在正常化期间,这保持了递归图的有限性和决定性.

## API 密码

-   `defineSchema(input)`: 使一个计划正常化, 并验证所有应答被定义 .
-   `normalizeTypeNode(node)`: 将 TypeNode 规范化 .
-   `serializeTypeNode(node)`:稳定JSON字符串用于TypeNode.
-   `serializeSchema(schema)`:稳定的JSON弦用于一个计划.
-   `collectRefs(node)`: 从 TypeNode 中收集命名的 refs .
-   构建器 : `unknownType`, (中文(简体) ), `neverType`, (中文(简体) ), `nullType`, (中文(简体) ), `booleanType`, (中文(简体) ), `numberType`, (中文(简体) ), `stringType`, (中文(简体) ), `literalType`, (中文(简体) ), `arrayType`, (中文(简体) ), `objectType`, (中文(简体) ), `prop`, (中文(简体) ), `optionalProp`, (中文(简体) ), `unionType`, (中文(简体) ), `intersectionType`, (中文(简体) ), `recordType`, (中文(简体) ), `tupleType`, (中文(简体) ), `refType`,以及 `nullableType`。 。 。 .

## 为什么叫裁判?

AsterQL代码需要保存形状特性. 如果两个字段指向 同样的命名类型,代码应该知道。 如果类型指向本身, 代码 绝不能永远扩张。 被命名的裁判员将案件简单明了.

## 常见问题

### @asterql/schema 是什么？

用于AsterQL数据塑造和代码生成的TypeNode schemas\.

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

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

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

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

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

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

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

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

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

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

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

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

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

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