# @castore/event-type-json-schema 中文文档

规范地址：https://npmcn.com/package/%40castore/event-type-json-schema/

版本：2\.4\.2
npm 元数据更新时间：2025-04-18T15:45:05.506Z
中文译文更新时间：2026-11-09T09:48:16.948Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：103 kB，17 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@castore/core ^2\.0\.0，json-schema-to-ts ^2\.0\.0
- 首次发布：2023-10-27T17:25:05.662Z
- 最新版本发布：2025-04-18T15:45:05.250Z
- 近 30 天下载量：3066（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

DRY Castore事件 Type 定义使用 JSON Schemas 和 json-schema- to-ts

## 安装

```sh
npm install @castore/event-type-json-schema
```

也可以使用：`pnpm add @castore/event-type-json-schema`、`yarn add @castore/event-type-json-schema`、`bun add @castore/event-type-json-schema`

## README

# JSON 舍马事件

德里·卡斯托尔 [`EventType`](https://castore-dev.github.io/castore/docs/event-sourcing/events/) 使用定义 [JSON 谢马斯](http://json-schema.org/understanding-json-schema/reference/index.html) 财务报告和审定财务报表 [`json-schema-to-ts`](https://github.com/ThomasAribart/json-schema-to-ts)

## \* 安装

```bash
# npm
npm install @castore/event-type-json-schema

# yarn
yarn add @castore/event-type-json-schema
```

这个软件包 `@castore/core` 财务报告和审定财务报表 `json-schema-to-ts` (以上 v2) 作为对等依赖, 您也必须安装它们 :

```bash
# npm
npm install @castore/core json-schema-to-ts

# yarn
yarn add @castore/core json-schema-to-ts
```

## 使用量

```ts
import { JSONSchemaEventType } from '@castore/event-type-json-schema';

const pokemonAppearedPayloadSchema = {
  type: 'object',
  properties: {
    name: { type: 'string' },
    level: { type: 'integer' },
  },
  required: ['name', 'level'],
  additionalProperties: false,
} as const; // 👈 Don't forget the "as const" statement
// (Cf json-schema-to-ts documentation)

const pokemonAppearedMetadataSchema = {
  type: 'object',
  properties: {
    trigger: { enum: ['random', 'scripted'] },
  },
  additionalProperties: false,
} as const;

// 👇 generics are correctly inferred
const pokemonAppearedEventType = new JSONSchemaEventType({
  type: 'POKEMON_APPEARED',
  payloadSchema: pokemonAppearedPayloadSchema,
  metadataSchema: pokemonAppearedMetadataSchema,
});
```

等于:

```ts
import { EventType } from '@castore/core';

const pokemonAppearedEventType = new EventType<
  'POKEMON_APPEARED',
  { name: string; level: number },
  { trigger?: 'random' | 'scripted' }
>({ type: 'POKEMON_APPEARED' });
```

## 属性方法( M)

`JSONSchemaEventType` 执行 [`EventType`](https://castore-dev.github.io/castore/docs/event-sourcing/events/) 分类并添加以下属性:

-   `payloadSchema _(?object)_`:事件类型的载荷 JSON schema

```ts
const payloadSchema = pokemonAppearedEventType.payloadSchema;
// => pokemonAppearedPayloadSchema
```

-   `metadataSchema _(?object)_`: 事件类型元数据 JSON schema

```ts
const metadataSchema = pokemonAppearedEventType.metadataSchema;
// => pokemonAppearedMetadataSchema
```

## 常见问题

### @castore/event-type-json-schema 是什么？

DRY Castore事件 Type 定义使用 JSON Schemas 和 json-schema- to-ts

### 如何安装 @castore/event-type-json-schema？

在项目目录运行 npm install @castore/event-type-json-schema，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@castore/core（^2\.0\.0）、json-schema-to-ts（^2\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @castore/event-type-json-schema 支持 TypeScript 吗？

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

### @castore/event-type-json-schema 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @castore/event-type-json-schema 可以商用吗？

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

### @castore/event-type-json-schema 的下载量有多少？

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

### @castore/event-type-json-schema 还在维护吗？

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