Class BaseServer

Hierarchy

ComponentGroup
- BaseServer

Implements

Component

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseServer(options: BaseServerOptions): BaseServer

Overrides ComponentGroup.constructor
- Defined in BaseServer.ts:8
Parameters
- options: BaseServerOptions
Returns BaseServer

Properties

app

app: Express.Application

children

children: Component[]

logger

logger: LoggerInstance

options

options: BaseServerOptions

type

type: GROUP

Methods

Abstract close

close(): Promise<void>

- Defined in BaseServer.ts:23
Closes the current server, if listening.

Returns Promise<void>

component

component(component: Component): number

Inherited from ComponentGroup.component
- Defined in component/ComponentGroup.ts:99
Register a new component.

Parameters
- component: Component
Returns number

components

components(): Component[]

Inherited from ComponentGroup.components
- Defined in component/ComponentGroup.ts:92
Gets currently registered components.

Returns Component[]

describe

describe(): ComponentGroupDescription

Implementation of Component.describe

Inherited from ComponentGroup.describe
- Defined in component/ComponentGroup.ts:33
Describes current component group.

Returns ComponentGroupDescription

Abstract listen

listen(): Promise<BaseServerOptions>

- Defined in BaseServer.ts:18
Starts listening in configured port.

Returns Promise<BaseServerOptions>

onInit

onInit(server: BaseServer): Promise<void>

Implementation of Component.onInit

Inherited from ComponentGroup.onInit
- Defined in component/ComponentGroup.ts:62
Handles pre initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onMount

onMount(server: BaseServer): void

Implementation of Component.onMount

Inherited from ComponentGroup.onMount
- Defined in component/ComponentGroup.ts:52
Handles post mount routines.

Parameters
- server: BaseServer
Returns void

onReady

onReady(server: BaseServer): Promise<void>

Implementation of Component.onReady

Inherited from ComponentGroup.onReady
- Defined in component/ComponentGroup.ts:72
Handles post initialization routines.

Parameters
- server: BaseServer
Returns Promise<void>

onUnmount

onUnmount(server: BaseServer): void

Implementation of Component.onUnmount

Inherited from ComponentGroup.onUnmount
- Defined in component/ComponentGroup.ts:83
Handles post unmount routines.

Parameters
- server: BaseServer
Returns void

Generated using TypeDoc