Class BpmnParser

Hierarchy

BpmnParser

Index

Constructors

Properties

mergeDedupeAndSort parser parserOptions scanBpmnObjectForMessages scanBpmnObjectForTasks taskTypes

Methods

generateConstantsForBpmnFiles getMessageNames getProcessId getTaskTypes parseBpmn scaffold

Constructors

constructor

new BpmnParser(): BpmnParser
Returns BpmnParser

Properties

`Static` `Private` mergeDedupeAndSort

mergeDedupeAndSort: any

`Static` `Private` parser

parser: any

`Static` `Private` parserOptions

parserOptions: any

`Static` `Private` scanBpmnObjectForMessages

scanBpmnObjectForMessages: any

Return an array of message names.

Param

A parsed Bpmn object.

`Static` `Private` scanBpmnObjectForTasks

scanBpmnObjectForTasks: any

Return an array of task types.

Param

A parsed Bpmn object.

`Static` taskTypes

taskTypes: any

Methods

`Static` generateConstantsForBpmnFiles

generateConstantsForBpmnFiles(filenames: string | string[]): Promise<string>
Generate TypeScript constants for task types and message names in BPMN files
Parameters
- filenames: string | string[]
  
  a BPMN file path or array of BPMN file paths
Returns Promise<string>
- Defined in node_modules/zeebe-node/dist/lib/BpmnParser.d.ts:14

`Static` getMessageNames

getMessageNames(processes: object | object[]): Promise<string[]>
Take one or more parsed BPMN objects and return an array of unique message names.
Parameters
- processes: object | object[]
  
  A parsed BPMN object, or an array of parsed BPMN objects.
Returns Promise<string[]>
- Defined in node_modules/zeebe-node/dist/lib/BpmnParser.d.ts:24

`Static` getProcessId

getProcessId(bpmnString: string): any
Parameters
- bpmnString: string
Returns any
- Defined in node_modules/zeebe-node/dist/lib/BpmnParser.d.ts:8

`Static` getTaskTypes

getTaskTypes(processes: object | object[]): Promise<string[]>
Take one or more parsed BPMN objects and return an array of unique task types.
Parameters
- processes: object | object[]
  
  A parsed BPMN object, or an array of parsed BPMN objects.
Returns Promise<string[]>
- Defined in node_modules/zeebe-node/dist/lib/BpmnParser.d.ts:19

`Static` parseBpmn

parseBpmn(filenames: string | string[]): object
Read BPMN files and return an array of one or more parsed BPMN objects.
Parameters
- filenames: string | string[]
  
  A single BPMN file path, or array of BPMN file paths.
Returns object
- Defined in node_modules/zeebe-node/dist/lib/BpmnParser.d.ts:7

`Static` scaffold

scaffold(filename: string): Promise<string>
Parameters
- filename: string
Returns Promise<string>
- Defined in node_modules/zeebe-node/dist/lib/BpmnParser.d.ts:9

Generated using TypeDoc