Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Server

Hierarchy

  • Server

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns Server

Properties

_server

_server: any

Optional app

app: any

config

config: ServerOptions

logger

logger: LoggerInstance

Methods

listen

  • Starts listening on the configured port.

    Returns Promise<ServerOptions>

onAppReady

  • onAppReady(): void

  • Handles middleware initialization stuff.

    Returns void

onShutdown

  • onShutdown(): Promise<void>

  • Handles pre-shutdown routines, may be extended for disconnecting from databases and services.

    Returns Promise<void>

onStartup

  • onStartup(): Promise<void>

  • Handles post-startup routines, may be extended for initializing databases and services.

    Returns Promise<void>

Protected register

  • register(): void

  • Registers the server routes and error handlers.

    Returns void

Protected runStartupJobs

  • runStartupJobs(): Promise<void>

  • Runs the server statup jobs, wil crash if any fails.

    Returns Promise<void>

stop

  • stop(): Promise<any>

  • Stops the server and closes the connection to the port.

    Returns Promise<any>

Generated using TypeDoc