Skip to main content

Class: EngineServer<T>

Server for the engine.

Type Parameters​

T​

T extends IEngineServerConfig = IEngineServerConfig

Implements​

  • IEngineServer

Constructors​

Constructor​

new EngineServer<T>(options): EngineServer<T>

Create a new instance of EngineServer.

Parameters​

options​

The options for the engine.

engineCore​

IEngineCore<T>

The engine core to serve from.

Returns​

EngineServer<T>

Properties​

CLASS_NAME​

readonly static CLASS_NAME: string

Runtime name for the class.

Methods​

addRestRouteGenerator()​

addRestRouteGenerator(type, module, method): void

Add a REST route generator.

Parameters​

type​

string

The type to add the generator for.

module​

string

The module containing the generator.

method​

string

The method to call on the module.

Returns​

void

Implementation of​

IEngineServer.addRestRouteGenerator

addSocketRouteGenerator()​

addSocketRouteGenerator(type, module, method): void

Add a socket route generator.

Parameters​

type​

string

The type to add the generator for.

module​

string

The module containing the generator.

method​

string

The method to call on the module.

Returns​

void

Implementation of​

IEngineServer.addSocketRouteGenerator

getRestRoutes()​

getRestRoutes(): IRestRoute<any, any>[]

Get the built REST routes.

Returns​

IRestRoute<any, any>[]

The REST routes.

getSocketRoutes()​

getSocketRoutes(): ISocketRoute<any, any>[]

Get the built socket routes.

Returns​

ISocketRoute<any, any>[]

The socket routes.

start()​

start(): Promise<void>

Start the engine server.

Returns​

Promise<void>

Nothing.

Implementation of​

IEngineServer.start

stop()​

stop(): Promise<void>

Stop the engine server.

Returns​

Promise<void>

Nothing.

Implementation of​

IEngineServer.stop