Class Server

Hierarchy

BaseServer
- Server

Implements

Component

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Server(options: ServerOptions, app?: express.Application): Server

Overrides BaseServer.__constructor
- Defined in server/index.ts:20
Parameters
- options: ServerOptions
- Optional app: express.Application
Returns Server

Properties

app

app: express.Application

children

children: Component[]

logger

logger: LoggerInstance

options

options: ServerOptions

Optional sentry

sentry: NodeClient

Protected Optional server

server: Server

type

type: GROUP

Methods

close

close(exitOnClose?: boolean): Promise<void>

Overrides BaseServer.close
- Defined in server/index.ts:98
Stops the server and closes the connection to the port.

Parameters
- Default value exitOnClose: boolean = false
Returns Promise<void>

component

component(component: Component): number

Inherited from ComponentGroup.component
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:50
Register a new component.

Parameters
- component: Component
Returns number

components

components(): Component[]

Inherited from ComponentGroup.components
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:46
Gets currently registered components.

Returns Component[]

describe

describe(): ComponentGroupDescription

Inherited from ComponentGroup.describe
- Defined in /Users/luiseduardobrito/Projects/nxtep-io/ts-framework/node_modules/ts-framework-common/dist/types/component/ComponentGroup.d.ts:26
Describes current component group.

Returns ComponentGroupDescription

listen

listen(): Promise<ServerOptions>

Overrides BaseServer.listen
- Defined in server/index.ts:78
Starts listening on the configured port.

Returns Promise<ServerOptions>

onInit

onInit(): Promise<void>

Overrides ComponentGroup.onInit
- Defined in server/index.ts:54
Returns Promise<void>

onMount

onMount(): void

Overrides ComponentGroup.onMount
- Defined in server/index.ts:49
Returns void

onReady

onReady(): Promise<void>

Overrides ComponentGroup.onReady
- Defined in server/index.ts:115
Handles post-startup routines, may be extended for initializing databases and services.

Returns Promise<void>

onUnmount

onUnmount(): Promise<void>

Overrides ComponentGroup.onUnmount
- Defined in server/index.ts:122
Handles pre-shutdown routines, may be extended for disconnecting from databases and services.

Returns Promise<void>