# @collidor/schema-command 中文文档

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

版本：1\.1\.3
npm 元数据更新时间：2026-10-09T21:15:14.240Z
中文译文更新时间：2026-11-10T11:09:46.730Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：55 kB，18 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：1 个
- peer 依赖：zod ^4
- 首次发布：2025-09-12T14:50:45.757Z
- 最新版本发布：2026-10-09T21:15:13.877Z
- 近 30 天下载量：7834（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：19（近 12 个月 12 个）

## 中文简介

用于相撞图书馆的伞包 .

## 安装

```sh
npm install @collidor/schema-command
```

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

## README

[![Codecov](https://codecov.io/gh/collidor/schema-command/branch/main/graph/badge.svg)](https://codecov.io/gh/collidor/schema-command) [![npm version](https://img.shields.io/npm/v/@collidor/schema-command)](https://www.npmjs.com/package/@collidor/schema-command) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

# @ collidor/ schema- 命令

由Zod 和 Zod 提供动力,用于保证类型安全、有计划验证的命令模式 `@collidor/command`。 。 。 .

## 安装

```bash
npm install @collidor/schema-command zod @collidor/command
```

## 特征

-   **运行时间计划验证** 通过 Zod 命令输入和输出
-   **编译时间类型Script推论** 用于处理器参数和返回类型
-   **Bundler/ 减轻影响复原力** 与 `createSchemaCommand`
-   与 `CommandBus` 财务报告和审定财务报表 `AsyncCommandBus`

## 使用量

### 使用 `createSchemaCommand` (邦德勒/无害安全)

当捆绑用于生产时,JavaScript分解器会将mangle类名称(例如. `class CreateUserCommand` 变成 `class a`) (中文(简体) ). 由于指挥巴士和网络插件路由命令使用其构造器名称, `createSchemaCommand` 提供一种类型安全的方法,以固定、不可忽略的名称定义计划命令:

```typescript
import { z } from "zod";
import { CommandBus } from "@collidor/command";
import { createSchemaCommand } from "@collidor/schema-command";

const InputSchema = z.object({
  name: z.string(),
  age: z.number(),
});

const OutputSchema = z.object({
  success: z.boolean(),
  id: z.string(),
});

// 1. Define command with explicit name and schemas
export const CreateUser = createSchemaCommand(
  "CreateUser",
  InputSchema,
  OutputSchema,
);

// Or using options object signature:
// export const CreateUser = createSchemaCommand("CreateUser", {
//   input: InputSchema,
//   output: OutputSchema,
// });

// 2. Register handler on bus
const bus = new CommandBus();
bus.register(CreateUser, (cmd) => {
  // cmd.data is inferred as { name: string; age: number }
  return {
    success: true,
    id: `user_${Date.now()}`,
  };
});

// 3. Execute
const result = bus.execute(new CreateUser({ name: "Alice", age: 30 }));
console.log(result.id);
```

### 使用 `schemaCommand` 有类继承

```typescript
import { z } from "zod";
import { schemaCommand, SchemaCommand } from "@collidor/schema-command";

const InputSchema = z.object({ limit: z.number() });
const OutputSchema = z.array(z.string());

class FetchItemsCommand extends schemaCommand(InputSchema, OutputSchema) {}
```

## 常见问题

### @collidor/schema-command 是什么？

用于相撞图书馆的伞包 \.

### 如何安装 @collidor/schema-command？

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

### @collidor/schema-command 支持 TypeScript 吗？

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

### @collidor/schema-command 支持 ESM 还是 CommonJS？

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

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

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

### @collidor/schema-command 可以商用吗？

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

### @collidor/schema-command 的下载量有多少？

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

### @collidor/schema-command 还在维护吗？

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