bpmn-server / LaunchedEngine

Class: LaunchedEngine

The engine, from outside it: what it can be asked (engineCalls), each answering data.

Table of contents

Constructors

• constructor

Properties

• #call

Accessors

• running

Methods

• #ask
• start
• get
• cancel
• retry
• restart
• invoke
• assign
• startEvent
• throwMessage
• throwSignal
• deleteInstances
• tagInstance
• upgrade
• upgradeRunning
• invokeDecision
• facts
• checkModel
• call
• live
• status

Constructors

constructor

• new LaunchedEngine(call): LaunchedEngine

Parameters

Name	Type
call	EngineCall

Returns

LaunchedEngine

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:53

Properties

#call

• Private #call: EngineCall

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:51

Accessors

running

• get running(): boolean

Whether there is an engine to ask.

Returns

boolean

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:56

Methods

#ask

▸ #ask(method, args): Promise\<any>

Parameters

Name	Type
method	string
args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:58

---

start

▸ start(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:63

---

get

▸ get(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:64

---

cancel

▸ cancel(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:65

---

retry

▸ retry(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:66

---

restart

▸ restart(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:67

---

invoke

▸ invoke(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:68

---

assign

▸ assign(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:69

---

startEvent

▸ startEvent(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:70

---

throwMessage

▸ throwMessage(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:71

---

throwSignal

▸ throwSignal(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:72

---

deleteInstances

▸ deleteInstances(query): Promise\<any>

Parameters

Name	Type
query	any

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:73

---

tagInstance

▸ tagInstance(instanceId, tag): Promise\<any>

Parameters

Name	Type
instanceId	string
tag	any

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:74

---

upgrade

▸ upgrade(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:75

---

upgradeRunning

▸ upgradeRunning(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:76

---

invokeDecision

▸ invokeDecision(...args): Promise\<any>

Parameters

Name	Type
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:77

---

facts

▸ facts(): Promise\<any>

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:78

---

checkModel

▸ checkModel(name, source): Promise\<any>

Parameters

Name	Type
name	string
source	string

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:79

---

call

▸ call(method, ...args): Promise\<any>

A call added to the engine's (calls of launch, and of startEngineService where the engine is).

Parameters

Name	Type
method	string
...args	any[]

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:81

---

live

▸ live(): Promise\<any[]>

What is being run now; nothing when no engine is running.

Returns

Promise\<any[]>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:84

---

status

▸ status(): Promise\<any>

Returns

Promise\<any>

Defined in

packages/bpmn-server/src/server/LaunchedServer.ts:85

Comments