bpmn-server / LaunchedServer
Class: LaunchedServer#
What BPMNServer.launch(...) gives: a server seen from outside its engine, with data only.
new BPMNServer(...) embeds the engine instead: the caller is inside, and gets running executions.
Where its engine is: in this process (by default), at an address (engine: 'http://...', startEngineService there), or
nowhere (engine: 'none'). All the same from here, but that without one what would run says so.
Known gap: dataStore and definitions are the engine's own classes, each with a .server that leads to a server of
this process (holding the engine, when it is the one in this process).
Table of contents#
Constructors#
Properties#
Accessors#
Methods#
Constructors#
constructor#
• new LaunchedServer(server, options?): LaunchedServer
Parameters#
| Name | Type |
|---|---|
server |
BPMNServer |
options |
Object |
options.engine? |
string |
options.engineKey? |
string |
options.engineTimeout? |
number |
options.calls? |
(server: BPMNServer) => Record\<string, (...args: any[]) => Promise\<any>> |
Returns#
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:155
Properties#
#server#
• Private #server: BPMNServer
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:150
#ready#
• Private #ready: any
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:151
engine#
• Readonly engine: LaunchedEngine
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:152
appDelegate#
• Readonly appDelegate: ApplicationFacts
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:153
Accessors#
ready#
• get ready(): any
Returns#
any
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:168
configuration#
• get configuration(): IConfiguration
Returns#
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:169
logger#
• get logger(): ILogger
Returns#
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:170
dataStore#
• get dataStore(): IDataStore
Returns#
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:171
definitions#
• get definitions(): any
Returns#
any
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:172
connectors#
• get connectors(): Connectors
Returns#
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:173
scriptHandler#
• get scriptHandler(): IScriptHandler
Which handler checks a model's scripts, and the variables it adds.
Returns#
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:175
Methods#
status#
▸ status(): Object
Returns#
Object
| Name | Type |
|---|---|
version |
any |
cache |
any |
engineRunning |
number |
engineCalls |
number |
timers |
{ pending: number ; scheduled: number = 0; fired: number = 0; skipped: number = 0; failed: number = 0 } |
timers.pending |
number |
timers.scheduled |
number |
timers.fired |
number |
timers.skipped |
number |
timers.failed |
number |
memoryUsage |
MemoryUsage |
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:176
shutdown#
▸ shutdown(): Promise\<void>
Returns#
Promise\<void>
Defined in#
packages/bpmn-server/src/server/LaunchedServer.ts:177