Skip to main content

Function: start()

start(nodeOptions, nodeEngineConfig, envVars, cliCommand?, availableContextIdKeys?): Promise<{ engine: Engine<IEngineServerConfig, INodeEngineState>; server: EngineServer; shutdown: () => Promise<void>; } | undefined>

Start the engine server.

Parameters​

nodeOptions​

INodeOptions | undefined

Optional run options for the engine server.

nodeEngineConfig​

INodeEngineConfig

The configuration for the engine server.

envVars​

INodeEnvironmentVariables

The environment variables.

cliCommand?​

ICliCommand

The constructed CLI command (optional).

availableContextIdKeys?​

object[]

The context ID keys available for operation.

Returns​

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

The engine server.