bpmn-server / Loop
Class: Loop#
Table of contents#
Constructors#
Properties#
Methods#
- isSequential
- isStandard
- save
- end
- load
- getKeyName
- getItems
- isDone
- getNext
- roundKey
- roundData
- completes
- checkStart
- cancel
- checkNext
Constructors#
constructor#
• new Loop(node, token, dataObject?): Loop
Parameters#
| Name | Type |
|---|---|
node |
Node |
token |
Token |
dataObject? |
any |
Returns#
Defined in#
packages/bpmn-server/src/engine/Loop.ts:25
Properties#
id#
• id: any
Defined in#
packages/bpmn-server/src/engine/Loop.ts:14
node#
• node: any
Defined in#
packages/bpmn-server/src/engine/Loop.ts:15
ownerToken#
• ownerToken: any
Defined in#
packages/bpmn-server/src/engine/Loop.ts:16
definition#
• definition: LoopBehaviour
Defined in#
packages/bpmn-server/src/engine/Loop.ts:17
sequence#
• sequence: any
Defined in#
packages/bpmn-server/src/engine/Loop.ts:18
dataPath#
• dataPath: any
Defined in#
packages/bpmn-server/src/engine/Loop.ts:19
_items#
• _items: any[]
Defined in#
packages/bpmn-server/src/engine/Loop.ts:20
completed#
• completed: number = 1
Defined in#
packages/bpmn-server/src/engine/Loop.ts:21
endFlag#
• endFlag: boolean = false
Defined in#
packages/bpmn-server/src/engine/Loop.ts:58
Methods#
isSequential#
▸ isSequential(): any
Returns#
any
Defined in#
packages/bpmn-server/src/engine/Loop.ts:22
isStandard#
▸ isStandard(): boolean
Returns#
boolean
Defined in#
packages/bpmn-server/src/engine/Loop.ts:23
save#
▸ save(): Object
Returns#
Object
| Name | Type |
|---|---|
id |
any |
nodeId |
any |
ownerTokenId |
any |
dataPath |
any |
items |
any[] |
endFlag |
boolean |
completed |
number |
sequence |
any |
Defined in#
packages/bpmn-server/src/engine/Loop.ts:50
end#
▸ end(): void
Returns#
void
Defined in#
packages/bpmn-server/src/engine/Loop.ts:59
load#
▸ load(execution, dataObject): Loop
Parameters#
| Name | Type |
|---|---|
execution |
any |
dataObject |
any |
Returns#
Defined in#
packages/bpmn-server/src/engine/Loop.ts:62
getKeyName#
▸ getKeyName(): string
Returns#
string
Defined in#
packages/bpmn-server/src/engine/Loop.ts:73
getItems#
▸ getItems(): Promise\<any[]>
Returns#
Promise\<any[]>
Defined in#
packages/bpmn-server/src/engine/Loop.ts:76
isDone#
▸ isDone(): Promise\<boolean>
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/engine/Loop.ts:87
getNext#
▸ getNext(): Promise\<any>
Returns#
Promise\<any>
Defined in#
packages/bpmn-server/src/engine/Loop.ts:91
roundKey#
▸ roundKey(entry, index): any
A round's key in the loop's data: its element, or its index when the element is an object.
Parameters#
| Name | Type |
|---|---|
entry |
any |
index |
number |
Returns#
any
Defined in#
packages/bpmn-server/src/engine/Loop.ts:99
roundData#
▸ roundData(entry, index): { loopCounter: number = index } | { loopCounter?: undefined = index }
A round's own data: its element under the loop's elementVariable, and its index (loopCounter).
Parameters#
| Name | Type |
|---|---|
entry |
any |
index |
number |
Returns#
{ loopCounter: number = index } | { loopCounter?: undefined = index }
Defined in#
packages/bpmn-server/src/engine/Loop.ts:103
completes#
▸ completes(token): Promise\<boolean>
After a round: the completion condition, given Camunda's counts (nrOfInstances, nrOfCompletedInstances,
nrOfActiveInstances) and rounds, each round's data; true: no more rounds. The values are written into
the expression, so any script handler (the sandbox too) sees them.
Parameters#
| Name | Type |
|---|---|
token |
Token |
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/engine/Loop.ts:112
checkStart#
▸ checkStart(token): Promise\<boolean>
Parameters#
| Name | Type | Description |
|---|---|---|
token |
any |
is called before Node execute and before an item is created |
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/engine/Loop.ts:140
cancel#
▸ cancel(fromItem): Promise\<void>
Parameters#
| Name | Type |
|---|---|
fromItem |
any |
Returns#
Promise\<void>
Defined in#
packages/bpmn-server/src/engine/Loop.ts:227
checkNext#
▸ checkNext(token): Promise\<boolean>
is called just before moving to next item in the flow
checks if there is more items to be executed in the loop if more items are needed: execute return false returns true only if no loop for the token
Parameters#
| Name | Type |
|---|---|
token |
Token |
Returns#
Promise\<boolean>
Defined in#
packages/bpmn-server/src/engine/Loop.ts:278