Skip to main content

Function: run()

run(nodeOptions?, args?): Promise<{ engine: Engine<IEngineServerConfig, INodeEngineState>; server: EngineServer; shutdown: () => Promise<void>; } | undefined>

Run the TWIN Node.

Parameters​

nodeOptions?​

INodeOptions

Optional configuration options for running the server.

args?​

string[]

Optional command line arguments.

Returns​

Promise<{ engine: Engine<IEngineServerConfig, INodeEngineState>; server: EngineServer; shutdown: () => Promise<void>; } | undefined>

A promise that resolves when the server is started containing a shutdown method.