Class ServerInitializer

Creates and starts an HTTP server.

Hierarchy

Initializer
- ServerInitializer

Implements

Finalizable

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServerInitializer(serverFactory: HttpServerFactory, port: number): ServerInitializer

Overrides Initializer.constructor
- Defined in src/init/ServerInitializer.ts:16
Parameters
- serverFactory: HttpServerFactory
- port: number
Returns ServerInitializer

Properties

Private Readonly port

port: number

Private Optional server

server?: Server

Private Readonly serverFactory

serverFactory: HttpServerFactory

Methods

canHandle

canHandle(input: void): Promise<void>

Inherited from Initializer.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:13
Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

Parameters
- input: void
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.

finalize

finalize(): Promise<void>

Implementation of Finalizable.finalize
- Defined in src/init/ServerInitializer.ts:26
Returns Promise<void>

handle

handle(): Promise<void>

Overrides Initializer.handle
- Defined in src/init/ServerInitializer.ts:22
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

Returns Promise<void>
A promise resolving when handling is finished.

handleSafe

handleSafe(input: void): Promise<void>

Inherited from Initializer.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:34
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.

Parameters
- input: void
  Input data that will be handled if it can be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.