# @clipboard-health/rules-engine 中文文档

规范地址：https://npmcn.com/package/%40clipboard-health/rules-engine/

版本：3\.12\.15
npm 元数据更新时间：2026-11-05T04:58:37.744Z
中文译文更新时间：2026-11-10T01:56:04.906Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40clipboard-health/rules-engine
原文对照：https://npmcn.com/package/%40clipboard-health/rules-engine/?lang=original
项目主页：https://github.com/ClipboardHealth/core-utils#readme
源码仓库：https://github.com/ClipboardHealth/core-utils

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

- 包体积（解压后）：11.9 kB，23 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：type-fest ^4 \|\| ^5\.0\.0
- 首次发布：2023-12-20T17:53:05.392Z
- 最新版本发布：2026-11-05T04:58:37.362Z
- 近 30 天下载量：14551（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：486（近 12 个月 378 个）

## 中文简介

一个纯粹的功能规则引擎,以保持逻辑通情达理的代码简单,可靠,可理解和可解释.

## 安装

```sh
npm install @clipboard-health/rules-engine
```

也可以使用：`pnpm add @clipboard-health/rules-engine`、`yarn add @clipboard-health/rules-engine`、`bun add @clipboard-health/rules-engine`

## README

# @clippboard-health/rules-engine (英语)

一个纯粹的功能规则引擎,以保持逻辑通情达理的代码简单,可靠,可理解和可解释.

引擎使用代码中创建的静态规则,而不是将动态规则序列化到数据库,因为我们还没有需要后者.

## 目录

-   [安装](https://npmcn.com/package/%40clipboard-health/rules-engine/#readme-install)
-   [使用量](https://npmcn.com/package/%40clipboard-health/rules-engine/#readme-usage)
-   [地方发展指挥部](https://npmcn.com/package/%40clipboard-health/rules-engine/#readme-local-development-commands)

## 安装

```bash
npm install @clipboard-health/rules-engine
```

## 使用量

```ts
import { deepEqual } from "node:assert/strict";

import {
  all,
  allIf,
  appendOutput,
  firstMatch,
  type Rule,
  type RuleContext,
} from "@clipboard-health/rules-engine";

interface Input {
  a: number;
  b: number;
}

interface Output {
  result: number;
}

const exampleContext: RuleContext<Input, Output> = {
  input: {
    a: 2,
    b: 5,
  },
  output: [],
};

const addNumbersIfPositiveRule: Rule<Input, Output> = {
  runIf: (input) => input.a > 0 && input.b > 0,
  run: (context) => {
    const { a, b } = context.input;
    return appendOutput(context, { result: a + b });
  },
};

const multiplyNumbersIfPositiveRule: Rule<Input, Output> = {
  runIf: (input) => input.a > 0 && input.b > 0,
  run: (context) => {
    const { a, b } = context.input;
    return appendOutput(context, { result: a * b });
  },
};

const divideNumbersIfNegative: Rule<Input, Output> = {
  runIf: (input) => input.a < 0 && input.b < 0,
  run: (context) => {
    const { a, b } = context.input;
    return appendOutput(context, { result: a / b });
  },
};

// Using all() applies all the rules to the context
const allResult = all(
  addNumbersIfPositiveRule,
  divideNumbersIfNegative,
  multiplyNumbersIfPositiveRule,
).run(exampleContext);

deepEqual(allResult.output, [{ result: 7 }, { result: 10 }]);

// Using firstMatch() applies the first the rules to the context
const firstMatchResult = firstMatch(
  divideNumbersIfNegative,
  addNumbersIfPositiveRule,
  multiplyNumbersIfPositiveRule,
).run(exampleContext);

deepEqual(firstMatchResult.output, [{ result: 7 }]);

// Using allIf() applies all the rules that return true for `runIf` to the context when the predicate
// (a function received as firs argument) returns true
const allIfResult = allIf(
  (input) => input.a === 2,
  divideNumbersIfNegative,
  addNumbersIfPositiveRule,
  multiplyNumbersIfPositiveRule,
).run(exampleContext);

deepEqual(allIfResult.output, [{ result: 7 }, { result: 10 }]);
```

## 地方发展指挥部

见 [`package.json`](https://npmcn.com/package/%40clipboard-health/rules-engine/package.json) `scripts` 用于命令列表.

## 常见问题

### @clipboard-health/rules-engine 是什么？

一个纯粹的功能规则引擎,以保持逻辑通情达理的代码简单,可靠,可理解和可解释\.

### 如何安装 @clipboard-health/rules-engine？

在项目目录运行 npm install @clipboard-health/rules-engine，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：type-fest（^4 \|\| ^5\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @clipboard-health/rules-engine 支持 TypeScript 吗？

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

### @clipboard-health/rules-engine 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @clipboard-health/rules-engine 可以商用吗？

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

### @clipboard-health/rules-engine 的下载量有多少？

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

### @clipboard-health/rules-engine 还在维护吗？

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