# @castore/command-zod 中文文档

规范地址：https://npmcn.com/package/%40castore/command-zod/

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

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

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

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

- 包体积（解压后）：108 kB，21 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@castore/core ^2\.0\.0，zod ^3\.0\.0
- 首次发布：2023-11-03T14:37:31.111Z
- 最新版本发布：2025-04-18T15:45:15.490Z
- 近 30 天下载量：2355（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

使用 Zod 定义 DRY Castore 命令

## 安装

```sh
npm install @castore/command-zod
```

也可以使用：`pnpm add @castore/command-zod`、`yarn add @castore/command-zod`、`bun add @castore/command-zod`

## README

# Zod 命令

德里·卡斯托尔 [`Command`](https://castore-dev.github.io/castore/docs/event-sourcing/pushing-events/) 使用定义 [`zod`](https://github.com/colinhacks/zod)。 。 。 .

## \* 安装

```bash
# npm
npm install @castore/command-zod

# yarn
yarn add @castore/command-zod
```

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

```bash
# npm
npm install @castore/core zod

# yarn
yarn add @castore/core zod
```

## 使用量

```ts
import z from 'zod';

import { ZodCommand } from '@castore/command-zod';
import { tuple } from '@castore/core';

const pokemonAppearedInputSchema = z.object({
  name: z.string(),
  level: z.number(),
});

const pokemonAppearedOutputSchema = z.object({
  pokemonId: z.string().uuid(),
});

// 👇 generics are correctly inferred
const pokemonAppearCommand = new ZodCommand({
  commandId: 'POKEMON_APPEAR',
  requiredEventStores: tuple(pokemonsEventStore),
  inputSchema: pokemonAppearedInputSchema,
  outputSchema: pokemonAppearedOutputSchema,
  // 👇 handler input/output types are correctly inferred
  handler: async (
    commandInput,
    [pokemonsEventStore],
    { generateUuid }: { generateUuid: () => string },
  ) => {
    const { name, level } = commandInput;
    const pokemonId = generateUuid();

    await pokemonsEventStore.pushEvent({
      aggregateId: pokemonId,
      version: 1,
      type: 'POKEMON_APPEARED',
      payload: { name, level },
    });

    return { pokemonId };
  },
});
```

等于:

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

type RequiredEventStores = [typeof pokemonsEventStore];
type CommandInput = { name: string; level: number };
type CommandOutput = { pokemonId: string };

const pokemonAppearCommand = new Command<
  RequiredEventStores,
  RequiredEventStores,
  CommandInput,
  CommandOutput
>({
  commandId: 'POKEMON_APPEAR',
  requiredEventStores: [pokemonsEventStore],
  handler: async (commandInput, [pokemonsEventStore]) => {
    // ...same code
  },
});
```

## 属性方法( M)

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

-   `inputSchema _(?object)_`: 命令输入 Zod 计划

```ts
const inputSchema = pokemonAppearCommand.inputSchema;
// => pokemonAppearedInputSchema
```

-   `outputSchema _(?object)_`: 命令输出 Zod 计划

```ts
const outputSchema = pokemonAppearCommand.outputSchema;
// => pokemonAppearedOutputSchema
```

## 常见问题

### @castore/command-zod 是什么？

使用 Zod 定义 DRY Castore 命令

### 如何安装 @castore/command-zod？

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

### @castore/command-zod 支持 TypeScript 吗？

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

### @castore/command-zod 支持 ESM 还是 CommonJS？

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

### @castore/command-zod 可以商用吗？

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

### @castore/command-zod 的下载量有多少？

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

### @castore/command-zod 还在维护吗？

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