Class HttpServer

Defines the common interface and shared functionality that all Servers should have.

Hierarchy

HttpServer

Index

Constructors

constructor

Properties

Methods

Object literals

config

Constructors

constructor

new HttpServer(options?: HttpServerConfig): HttpServer

- Defined in server/http-server.ts:38
Constructs and configures a new HttpServer.

Parameters
- Optional options: HttpServerConfig
Returns HttpServer

Properties

Private httpServer

httpServer: Server = null

Internal Node.js http server.

Protected serverManagers

serverManagers: object

List of ServerManagers in charge of the server.

Type declaration

[key: string]: ServerManager

Methods

attach

attach(name: string, manager: ServerManager): this
attach(managers: object): this

- Defined in server/http-server.ts:50
Attaches a ServerManager(s) to this server.

Parameters
- name: string
- manager: ServerManager
Returns this
- Defined in server/http-server.ts:51
Parameters
- managers: object
  - [key: string]: ServerManager
Returns this

configure

configure(options: HttpServerConfig): this

- Defined in server/http-server.ts:116
Applies configurations to the HttpServer.

Parameters
- options: HttpServerConfig
Returns this

getManager

getManager(key: string): ServerManager

- Defined in server/http-server.ts:102
Returns the ServerManager with the given name.

Parameters
- key: string
Returns ServerManager

Private getOrderedServerManagerKeys

getOrderedServerManagerKeys(): string[]

- Defined in server/http-server.ts:86
Gets the keys of all the ServerManagers in order of priority.

Returns string[]

isRunning

isRunning(): boolean

- Defined in server/http-server.ts:109
Returns whether or not the server is running.

Returns boolean

start

start(): Promise<boolean>

- Defined in server/http-server.ts:127
Starts the HttpServer and returns a Promise for when it's ready.

Returns Promise<boolean>

stop

stop(): Promise<boolean>

- Defined in server/http-server.ts:143
Stops the HttpServer and returns a Promise for when it's done.

Returns Promise<boolean>

with

with(name: string, manager: ServerManager): this
with(managers: object): this

- Defined in server/http-server.ts:76
Alias for attach(...)

Parameters
- name: string
- manager: ServerManager
Returns this
- Defined in server/http-server.ts:77
Parameters
- managers: object
  - [key: string]: ServerManager
Returns this

Object literals

Protected config

config: object

Where the HttpServer configurations are stored.

host

host: string = "localhost"

port

port: number = 3000

Generated using TypeDoc