bpmn-server / Definition

Class: Definition

Implements

• IDefinition

Table of contents

Constructors

• constructor

Properties

• moddles
• name
• processes
• rootElements
• nodes
• flows
• source
• logger
• server
• moddle
• accessRules

Methods

• moddleFor
• loadProcess
• load
• getJson
• getDefinition
• getFields
• getStartNodes
• getStartNode
• getNodeById
• getNodeInfo

Constructors

constructor

• new Definition(name, source, server): Definition

Parameters

Name	Type
name	string
source	string
server	IBPMNServer

Returns

Definition

Defined in

packages/bpmn-server/src/elements/Definition.ts:46

Properties

moddles

▪ Static Private moddles: Map\<object, BpmnModdle>

One BpmnModdle per extension set: building one registers every BPMN type (about 190 KB and the bulk of a load's time), and parsing does not change it.

Defined in

packages/bpmn-server/src/elements/Definition.ts:26

---

name

• name: any

Implementation of

IDefinition.name

Defined in

packages/bpmn-server/src/elements/Definition.ts:36

---

processes

• processes: Map\<any, any>

Implementation of

IDefinition.processes

Defined in

packages/bpmn-server/src/elements/Definition.ts:37

---

rootElements

• rootElements: any

Implementation of

IDefinition.rootElements

Defined in

packages/bpmn-server/src/elements/Definition.ts:38

---

nodes

• nodes: Map\<any, any>

Implementation of

IDefinition.nodes

Defined in

packages/bpmn-server/src/elements/Definition.ts:39

---

flows

• flows: any[] = []

Implementation of

IDefinition.flows

Defined in

packages/bpmn-server/src/elements/Definition.ts:40

---

source

• source: any

Implementation of

IDefinition.source

Defined in

packages/bpmn-server/src/elements/Definition.ts:41

---

logger

• logger: any

Implementation of

IDefinition.logger

Defined in

packages/bpmn-server/src/elements/Definition.ts:42

---

server

• server: any

Defined in

packages/bpmn-server/src/elements/Definition.ts:43

---

moddle

• moddle: any

Defined in

packages/bpmn-server/src/elements/Definition.ts:44

---

accessRules

• accessRules: any[] = []

Implementation of

IDefinition.accessRules

Defined in

packages/bpmn-server/src/elements/Definition.ts:45

Methods

moddleFor

▸ moddleFor(moddleOptions): BpmnModdle

Parameters

Name	Type
moddleOptions	any

Returns

BpmnModdle

Defined in

packages/bpmn-server/src/elements/Definition.ts:27

---

loadProcess

▸ loadProcess(definition, processElement, parentProcess): Process

Parameters

Name	Type
definition	any
processElement	any
parentProcess	any

Returns

Process

Defined in

packages/bpmn-server/src/elements/Definition.ts:56

---

load

▸ load(): Promise\<any>

Returns

Promise\<any>

Implementation of

IDefinition.load

Defined in

packages/bpmn-server/src/elements/Definition.ts:159

---

getJson

▸ getJson(): string

Returns

string

Implementation of

IDefinition.getJson

Defined in

packages/bpmn-server/src/elements/Definition.ts:308

---

getDefinition

▸ getDefinition(source, logger): Promise\<any>

Parameters

Name	Type
source	any
logger	any

Returns

Promise\<any>

Implementation of

IDefinition.getDefinition

Defined in

packages/bpmn-server/src/elements/Definition.ts:336

---

getFields

▸ getFields(elementId): Promise\<any>

Parameters

Name	Type
elementId	any

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/elements/Definition.ts:349

---

getStartNodes

▸ getStartNodes(userInvokable?): any[]

Parameters

Name	Type	Default value
userInvokable	boolean	false

Returns

any[]

Defined in

packages/bpmn-server/src/elements/Definition.ts:360

---

getStartNode

▸ getStartNode(): any

Where a start with no start event named begins: one a user can start (not a message, signal, timer or error start), else the first.

Returns

any

Implementation of

IDefinition.getStartNode

Defined in

packages/bpmn-server/src/elements/Definition.ts:372

---

getNodeById

▸ getNodeById(id): any

Parameters

Name	Type
id	any

Returns

any

Implementation of

IDefinition.getNodeById

Defined in

packages/bpmn-server/src/elements/Definition.ts:375

---

getNodeInfo

▸ getNodeInfo(elementId): Object

Parameters

Name	Type
elementId	any

Returns

Object

Name	Type
node	any
fields	any
formKey	any

Defined in

packages/bpmn-server/src/elements/Definition.ts:378

Comments