# @bpmn-io/extract-process-variables 中文文档

规范地址：https://npmcn.com/package/%40bpmn-io/extract-process-variables/

版本：2\.2\.1
npm 元数据更新时间：2026-07-08T15:54:05.278Z
中文译文更新时间：2026-11-08T13:05:21.211Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：44.6 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2020-08-10T08:53:07.880Z
- 最新版本发布：2026-02-27T09:09:53.848Z
- 近 30 天下载量：244545（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 9 个）

## 中文简介

一个 bpmn-js 的用法从 BPMN 2.0 图中提取出 Camunda BPM 过程变量 .

## 安装

```sh
npm install @bpmn-io/extract-process-variables
```

也可以使用：`pnpm add @bpmn-io/extract-process-variables`、`yarn add @bpmn-io/extract-process-variables`、`bun add @bpmn-io/extract-process-variables`

## README

# 提取-进程可变性

[![CI](https://github.com/bpmn-io/extract-process-variables/actions/workflows/CI.yml/badge.svg)](https://github.com/bpmn-io/extract-process-variables/actions/workflows/CI.yml)

一个乌蒂 [日记](https://github.com/bpmn-io/bpmn-js) 以提取 Camunda BPM [进程变量](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/) 从BPMN 2.0图.

## 安装

```sh
$ npm i --save @bpmn-io/extract-process-variables
```

## 使用量

### 卡蒙达平台7

鉴于 [此示例图](https://npmcn.com/package/%40bpmn-io/extract-process-variables/test/fixtures/sub-process-own-scope.bpmn)

```js
import {
  getProcessVariables,
  getVariablesForScope,
} from '@bpmn-io/extract-process-variables';

// For Camunda Platform 8 diagrams, use the /zeebe submodule
// import {
//   getProcessVariables,
//   getVariablesForScope,
// } from '@bpmn-io/extract-process-variables/zeebe';

const canvas = modeler.get('canvas');

const rootElement = canvas.getRootElement();

const allVariables = getProcessVariables(rootElement.businessObject);
/*
  [
    {
      "name": "variable1",
      "origin": [ "Task_1" ],
      "scope": "Process_1"
    },
    {
      "name": "variable2",
      "origin": [ "Task_1" ],
      "scope": "Process_1"
    },
    {
      "name": "variable3",
      "origin": [ "Task_2" ],
      "scope": "SubProcess_1"
    }
  ]
*/

const scopeVariables = getVariablesForScope('Process_1', rootElement.businessObject);
/*
  [
    {
      "name": "variable1",
      "origin": [ "Task_1" ],
      "scope": "Process_1"
    },
    {
      "name": "variable2",
      "origin": [ "Task_1" ],
      "scope": "Process_1"
    }
  ]
*/
```

请注意: `origin` 财务报告和审定财务报表 `scope` 检索到整个摩克元素 。 实例产出减少,因为可读性提高.

请注意: [移动相机](https://github.com/camunda/camunda-bpmn-moddle) 或者说 [{\\fn华文楷体\\fs20\\bord1\\shad1\\1che0e0e0\\2ch000000}相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相](https://github.com/camunda-cloud/zeebe-bpmn-moddle) 必须安装描述符.

## 属性支持

### 卡蒙达平台7

我们目前 [提取进程变量](https://github.com/bpmn-io/extract-process-variables/tree/main/src/camunda-platform/extractors) 从下图属性

-   `camunda:formField`
-   `camunda:outputParameter`
-   `camunda:out`
-   `camunda:resultVariable`
-   `camunda:errorCodeVariable`
-   `camunda:errorMessageVariable`
-   `camunda:escalationCodeVariable`

### 卡蒙达平台8

我们目前 [提取进程变量](https://github.com/bpmn-io/extract-process-variables/tree/main/src/zeebe/extractors) 从下图属性

-   `zeebe:input`
-   `zeebe:output`
-   `zeebe:loopCharacteristics > inputElement`
-   `zeebe:loopCharacteristics > outputCollection`
-   `zeebe:calledDecision > resultVariable`
-   `zeebe:script > resultVariable`

## 另见

-   [移动相机](https://github.com/camunda/camunda-bpmn-moddle)
-   [Camunda BPM 进程变量文档](https://docs.camunda.org/manual/latest/user-guide/process-engine/variables/)
-   [{\\fn华文楷体\\fs20\\bord1\\shad1\\1che0e0e0\\2ch000000}相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相去相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相](https://github.com/camunda-cloud/zeebe-bpmn-moddle)
-   [Camunda 平台 8 变量文档](https://docs.camunda.io/docs/components/concepts/variables)

## 许可证

麻省理工学院

## 常见问题

### @bpmn-io/extract-process-variables 是什么？

一个 bpmn-js 的用法从 BPMN 2\.0 图中提取出 Camunda BPM 过程变量 \.

### 如何安装 @bpmn-io/extract-process-variables？

在项目目录运行 npm install @bpmn-io/extract-process-variables，或使用 pnpm add / yarn add / bun add。

### @bpmn-io/extract-process-variables 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bpmn-io\_\_extract-process-variables 是否存在。

### @bpmn-io/extract-process-variables 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @bpmn-io/extract-process-variables 可以商用吗？

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

### @bpmn-io/extract-process-variables 的下载量有多少？

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

### @bpmn-io/extract-process-variables 还在维护吗？

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