Loop.md

bpmn-server / Loop

Class: Loop

Table of contents

Constructors

• constructor

Properties

• id
• node
• ownerToken
• definition
• sequence
• dataPath
• items
• completed

Methods

• isSequential
• isStandard
• save
• load
• getKeyName
• isDone
• getNext
• checkStart
• cancel
• checkNext

Constructors

constructor

• new Loop(node, token, dataObject?): Loop

Parameters

Name	Type
node	Node
token	Token
dataObject?	any

Returns

Loop

Defined in

engine/Loop.ts:20

Properties

id

• id: any

Defined in

engine/Loop.ts:9

---

node

• node: any

Defined in

engine/Loop.ts:10

---

ownerToken

• ownerToken: any

Defined in

engine/Loop.ts:11

---

definition

• definition: LoopBehaviour

Defined in

engine/Loop.ts:12

---

sequence

• sequence: any

Defined in

engine/Loop.ts:13

---

dataPath

• dataPath: any

Defined in

engine/Loop.ts:14

---

items

• items: any[]

Defined in

engine/Loop.ts:15

---

completed

• completed: any

Defined in

engine/Loop.ts:16

Methods

isSequential

▸ isSequential(): any

Returns

any

Defined in

engine/Loop.ts:17

---

isStandard

▸ isStandard(): boolean

Returns

boolean

Defined in

engine/Loop.ts:18

---

save

▸ save(): Object

Returns

Object

Name	Type
id	any
nodeId	any
ownerTokenId	any
dataPath	any
items	any[]
completed	any
sequence	any

Defined in

engine/Loop.ts:51

---

load

▸ load(execution, dataObject): Loop

Parameters

Name	Type
execution	any
dataObject	any

Returns

Loop

Defined in

engine/Loop.ts:58

---

getKeyName

▸ getKeyName(): string

Returns

string

Defined in

engine/Loop.ts:69

---

isDone

▸ isDone(): boolean

Returns

boolean

Defined in

engine/Loop.ts:72

---

getNext

▸ getNext(): any

Returns

any

Defined in

engine/Loop.ts:75

---

checkStart

▸ checkStart(token): Promise<boolean>

Parameters

Name	Type
token	any

Returns

Promise<boolean>

Defined in

engine/Loop.ts:81

---

cancel

▸ cancel(fromItem): Promise<void>

Parameters

Name	Type
fromItem	any

Returns

Promise<void>

Defined in

engine/Loop.ts:163

---

checkNext

▸ checkNext(token): Promise<boolean>

Parameters

Name	Type
token	Token

Returns

Promise<boolean>

Defined in

engine/Loop.ts:185