token

bpmn-server / Token

Class: Token

Implements

• IToken

Table of contents

Constructors

• constructor

Properties

• currentNode
• dataPath
• execution
• id
• input
• loop
• messageMatchingKey
• originItem
• output
• parentToken
• path
• processId
• startNodeId
• status
• type

Accessors

• childrenTokens
• currentItem
• data
• firstItem
• lastItem

Methods

• appendData
• continue
• end
• error
• execute
• getChildrenTokens
• getFullPath
• getSubProcessToken
• goNext
• hasNode
• log
• preExecute
• preNext
• processError
• processEscalation
• restored
• resume
• save
• setCurrentNode
• signal
• stop
• terminate
• load
• startNewToken

Constructors

constructor

• new Token(type, execution, startNode, dataPath?, parentToken?, originItem?): Token

Parameters

Name	Type
type	TOKEN_TYPE
execution	Execution
startNode	Node
dataPath?	any
parentToken?	Token
originItem?	Item

Returns

Token

Defined in

engine/Token.ts:115

Properties

currentNode

• currentNode: Node

Implementation of

IToken.currentNode

Defined in

engine/Token.ts:68

---

dataPath

• dataPath: string

Implementation of

IToken.dataPath

Defined in

engine/Token.ts:61

---

execution

• execution: IExecution

Implementation of

IToken.execution

Defined in

engine/Token.ts:60

---

id

• id: any

Implementation of

IToken.id

Defined in

engine/Token.ts:58

---

input

• input: Object

Defined in

engine/Token.ts:71

---

loop

• loop: Loop

Implementation of

IToken.loop

Defined in

engine/Token.ts:67

---

messageMatchingKey

• messageMatchingKey: Object

Defined in

engine/Token.ts:73

---

originItem

• originItem: Item

Implementation of

IToken.originItem

Defined in

engine/Token.ts:65

---

output

• output: Object

Defined in

engine/Token.ts:72

---

parentToken

• Optional parentToken: Token

Implementation of

IToken.parentToken

Defined in

engine/Token.ts:63

---

path

• path: Item[]

Implementation of

IToken.path

Defined in

engine/Token.ts:66

---

processId

• processId: any

Implementation of

IToken.processId

Defined in

engine/Token.ts:69

---

startNodeId

• startNodeId: any

Implementation of

IToken.startNodeId

Defined in

engine/Token.ts:62

---

status

• status: TOKEN_STATUS

Implementation of

IToken.status

Defined in

engine/Token.ts:70

---

type

• type: TOKEN_TYPE

Implementation of

IToken.type

Defined in

engine/Token.ts:59

Accessors

childrenTokens

• get childrenTokens(): Token[]

Returns

Token[]

Implementation of

IToken.childrenTokens

Defined in

engine/Token.ts:103

---

currentItem

• get currentItem(): Item

Returns

Item

Implementation of

IToken.currentItem

Defined in

engine/Token.ts:78

---

data

• get data(): any

Returns

any

Implementation of

IToken.data

Defined in

engine/Token.ts:75

---

firstItem

• get firstItem(): Item

Returns

Item

Implementation of

IToken.firstItem

Defined in

engine/Token.ts:81

---

lastItem

• get lastItem(): Item

Returns

Item

Implementation of

IToken.lastItem

Defined in

engine/Token.ts:93

Methods

appendData

▸ appendData(inputData, item): void

renamed from applyInput to appendData

Parameters

Name	Type
inputData	any
item	any

Returns

void

Implementation of

IToken.appendData

Defined in

engine/Token.ts:358

---

continue

▸ continue(): Promise<void>

is called by events to cancel current token

Returns

Promise<void>

Defined in

engine/Token.ts:375

---

end

▸ end(cancel?): Promise<void>

Parameters

Name	Type	Default value
cancel	Boolean	false

Returns

Promise<void>

Implementation of

IToken.end

Defined in

engine/Token.ts:416

---

error

▸ error(msg): void

Parameters

Name	Type
msg	any

Returns

void

Implementation of

IToken.error

Defined in

engine/Token.ts:526

---

execute

▸ execute(input): Promise<void>

this is the primary exectuion method for a token Pre-Conditions: currentNode is set status!= end

Parameters

Name	Type
input	any

Returns

Promise<void>

Implementation of

IToken.execute

Defined in

engine/Token.ts:238

---

getChildrenTokens

▸ getChildrenTokens(): any[]

Returns

any[]

Implementation of

IToken.getChildrenTokens

Defined in

engine/Token.ts:208

---

getFullPath

▸ getFullPath(path?): Item[]

Parameters

Name	Type	Default value
path	any[]	[]

Returns

Item[]

Implementation of

IToken.getFullPath

Defined in

engine/Token.ts:109

---

getSubProcessToken

▸ getSubProcessToken(): Token

Returns

Token

Implementation of

IToken.getSubProcessToken

Defined in

engine/Token.ts:199

---

goNext

▸ goNext(): Promise<void>

Returns

Promise<void>

Implementation of

IToken.goNext

Defined in

engine/Token.ts:454

---

hasNode

▸ hasNode(nodeId): Boolean

Parameters

Name	Type
nodeId	any

Returns

Boolean

Defined in

engine/Token.ts:85

---

log

▸ log(msg): void

Parameters

Name	Type
msg	any

Returns

void

Implementation of

IToken.log

Defined in

engine/Token.ts:523

---

preExecute

▸ preExecute(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

IToken.preExecute

Defined in

engine/Token.ts:220

---

preNext

▸ preNext(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

IToken.preNext

Defined in

engine/Token.ts:227

---

processError

▸ processError(): Promise<void>

Returns

Promise<void>

Implementation of

IToken.processError

Defined in

engine/Token.ts:300

---

processEscalation

▸ processEscalation(): Promise<void>

Returns

Promise<void>

Defined in

engine/Token.ts:330

---

restored

▸ restored(): void

Returns

void

Implementation of

IToken.restored

Defined in

engine/Token.ts:194

---

resume

▸ resume(): void

Returns

void

Implementation of

IToken.resume

Defined in

engine/Token.ts:190

---

save

▸ save(): Object

Returns

Object

Name	Type
currentNode	any
dataPath	string
id	any
loopId	any
originItem	any
parentToken	any
startNodeId	any
status	TOKEN_STATUS
type	TOKEN_TYPE

Implementation of

IToken.save

Defined in

engine/Token.ts:153

---

setCurrentNode

▸ setCurrentNode(newCurrentNode): void

Parameters

Name	Type
newCurrentNode	Node

Returns

void

Defined in

engine/Token.ts:444

---

signal

▸ signal(data, options?): Promise<void>

Parameters

Name	Type
data	any
options	Object

Returns

Promise<void>

Implementation of

IToken.signal

Defined in

engine/Token.ts:384

---

stop

▸ stop(): void

Returns

void

Implementation of

IToken.stop

Defined in

engine/Token.ts:181

---

terminate

▸ terminate(): Promise<void>

is called by Gateways to cancel current token

Returns

Promise<void>

Implementation of

IToken.terminate

Defined in

engine/Token.ts:365

---

load

▸ load(execution, da): Token

Parameters

Name	Type
execution	Execution
da	any

Returns

Token

Defined in

engine/Token.ts:168

---

startNewToken

▸ startNewToken(type, execution, startNode, dataPath, parentToken, originItem, loop, data?, noExecute?): Promise<Token>

Parameters

Name	Type	Default value
type	TOKEN_TYPE	undefined
execution	any	undefined
startNode	any	undefined
dataPath	any	undefined
parentToken	Token	undefined
originItem	Item	undefined
loop	Loop	undefined
data	any	null
noExecute	boolean	false

Returns

Promise<Token>

Defined in

engine/Token.ts:141