# @antelopejs/interface-dms-automation 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/interface-dms-automation/

版本：0\.6\.0
npm 元数据更新时间：2026-11-04T20:55:14.635Z
中文译文更新时间：2026-11-06T06:27:22.674Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/interface-dms-automation
原文对照：https://npmcn.com/package/%40antelopejs/interface-dms-automation/?lang=original
项目主页：https://dms.antelopejs.com/docs/modules/automation/extending
源码仓库：https://github.com/AntelopeJS/dms-automation

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

- 包体积（解压后）：65.2 kB，10 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：@antelopejs/interface-core \>=0\.2\.4 \<1\.0\.0
- 首次发布：2026-09-16T22:55:09.311Z
- 最新版本发布：2026-11-04T20:55:14.076Z
- 近 30 天下载量：10356（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 10 个）

## 中文简介

DMS自动化模块的羚羊JS接口:从任何模块中声明触发,动作和数据节点类型.

## 安装

```sh
npm install @antelopejs/interface-dms-automation
```

也可以使用：`pnpm add @antelopejs/interface-dms-automation`、`yarn add @antelopejs/interface-dms-automation`、`bun add @antelopejs/interface-dms-automation`

## README

# `@antelopejs/interface-dms-automation`

[![npm](https://img.shields.io/npm/v/@antelopejs/interface-dms-automation?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/interface-dms-automation) [![License](https://img.shields.io/npm/l/@antelopejs/interface-dms-automation?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/interface-dms-automation/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/g4pFt6eXqu) [![Documentation](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://dms.antelopejs.com/docs/modules/automation/extending)

羚羊JS接口将触发器,动作和数据节点添加到DMS自动化构建器上.

## 它会做什么

-   宣告任何模块的触发、动作和数据节点类型 `RegisterTriggerType`, (中文(简体) ), `RegisterActionType`, (中文(简体) ), `RegisterDataNodeType` 联合国 `Unregister*` 对口单位.
-   在自动化模块附加并重放之前进行排队登记,因此负载顺序不重要.
-   列出可用节点类型 `ListTriggerTypes`, (中文(简体) ), `ListActionTypes` 财务报告和审定财务报表 `ListDataNodeTypes`。 。 。 .
-   从代码开始程序 . `InvokeProcedure` 从手动触发器开始. `RunProcedure` 从任何触发器开始, 如 **快点跑** 在建造者做.
-   船舶程序作为 `DeclareProcedure`。自动化模块在稳定的ID下创建程序一次,之后再也不会改变.
-   保持您的模块独立于执行, [`@antelopejs/dms-automation`](https://www.npmjs.com/package/@antelopejs/dms-automation)。 。 。 .

## 安装

将接口添加到宣布节点的模块中 :

```bash
pnpm add @antelopejs/interface-dms-automation
```

如果您的模块没有自动化功能, 请移动接口到 `optionalDependencies`。由于未加载执行,注册等待一个附件,您的模块继续工作。 如果您的模块需要自动化运行, 请将接口保留在 `dependencies`。使用广泛的消费者范围,从您创建的界面发布到 `<1.0.0`,因此软件包管理器可以将其复制。 实施模块将其自身的依赖性限制在下一个接口次要部分以下.

## 快开始

注册每个节点 `start()` 并解除注册 `stop()`数字 :

```ts
import { RegisterActionType, UnregisterActionType } from "@antelopejs/interface-dms-automation";

const NOTIFY_ID = "my-module.notify";

export function start(): void {
  RegisterActionType({
    id: NOTIFY_ID,
    name: "Send notification",
    description: "Send a notification to a user",
    icon: "i-lucide-bell",
    inputSchema: {
      type: "object",
      properties: { userId: { type: "string" }, message: { type: "string" } },
      required: ["userId", "message"],
    },
    outputSchema: { type: "object", properties: { delivered: { type: "boolean" } } },
    async execute(input: { userId: string; message: string }, ctx) {
      ctx.log("info", "notifying", input);
      return { delivered: true };
    },
  });
}

export function stop(): void {
  UnregisterActionType(NOTIFY_ID);
}
```

触发器也声明需要 `cluster` 模式。 A 类 `"singleton"` 触发,如时间表,只向当选领导人开火。 A 类 `"replicated"` 触发器,比如网钩, 点燃每一个实例。 命名空间节点ID为 `<module>.<node>`,并保持平面图案,每个港口有一个地产.

## 兼容性

兼容块 [模块读取器](https://npmcn.com/package/%40antelopejs/dms-automation/README.md#compatibility) 列出每个接口范围 `@antelopejs/dms-automation` 释放工具。 界面宣布此对等依赖 :

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-core` | `>=0.2.4 <1.0.0` | `0.4.0` |

`InvokeProcedure`, (中文(简体) ), `RunProcedure`, (中文(简体) ), `DeclareProcedure` 编辑 `List*Types` 函数排入他们的调用,直到一个执行附加。 由于未装入执行文件,退还的承诺仍未兑现。 默认情况下,每个函数的队列最多为1,000个调用,而下一个调用 `ProviderQueueFullError`。一个排队的呼叫,其呼叫模块停止拒绝 `ModuleContextInvalidatedError` 当执行时。 前往可用性处, 请检查 `GetInterfaceInstances("@antelopejs/interface-dms-automation")` 从 `@antelopejs/interface-core`。 。 。 .

## 文档

-   [消费者参考](https://npmcn.com/package/%40antelopejs/interface-dms-automation/docs/1.index.md) 包括节点合同、生命周期、集群、援引和失败.
-   [扩展自动化模块](https://dms.antelopejs.com/docs/modules/automation/extending) 包括节点类型、所需成员和从代码运行程序.
-   这个 [自动化模块指南](https://dms.antelopejs.com/docs/modules/automation) 覆盖模块的其余部分.

包裹还装了 `dms-automation-interface` Claude代码技巧 [`skills/`](https://github.com/AntelopeJS/dms-automation/tree/main/packages/interface-dms-automation/skills),在 `antelopeJs.skills`。 。 。 .

## 捐款

这个包裹住在 [`AntelopeJS/dms-automation`](https://github.com/AntelopeJS/dms-automation) pnpm 工作空间,位于执行它的模块旁边. 读取 [捐款额](https://github.com/AntelopeJS/dms-automation/blob/main/CONTRIBUTING.md) 编辑 [仓库读取器](https://github.com/AntelopeJS/dms-automation#contributing) 用于开发命令。 在模块执行之前释放此软件包 .

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/interface-dms-automation/LICENSE)

## 常见问题

### @antelopejs/interface-dms-automation 是什么？

DMS自动化模块的羚羊JS接口:从任何模块中声明触发,动作和数据节点类型\.

### 如何安装 @antelopejs/interface-dms-automation？

在项目目录运行 npm install @antelopejs/interface-dms-automation，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@antelopejs/interface-core（\>=0\.2\.4 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @antelopejs/interface-dms-automation 支持 TypeScript 吗？

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

### @antelopejs/interface-dms-automation 支持 ESM 还是 CommonJS？

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

### @antelopejs/interface-dms-automation 可以商用吗？

@antelopejs/interface-dms-automation 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @antelopejs/interface-dms-automation 的下载量有多少？

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

### @antelopejs/interface-dms-automation 还在维护吗？

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

