Class Server

The running HTTP/HTTPS server instance returned by ServerBuilder.listen().

Use close() to gracefully shut down the server.

Index

Constructors

Accessors

Methods

Constructors

constructor

new Server(
    router: Router,
    serviceProvider: ServiceProvider,
    contentNegotiator: ContentNegotiator,
    globalMiddlewares: Middleware[],
    healthcheck?: boolean,
    hasSubscriptions?: boolean,
    batchConfig?: ServerBatchingOptions | null,
): Server
Parameters
- router: Router
- serviceProvider: ServiceProvider
- contentNegotiator: ContentNegotiator
- globalMiddlewares: Middleware[]
- healthcheck: boolean = false
- hasSubscriptions: boolean = false
- batchConfig: ServerBatchingOptions | null = null
Returns Server
- Defined in libs/server/src/Server.ts:372

Accessors

address

get address(): { host: string; port: number } | null
The bound address after listen() resolves. Returns null if the server has been closed or not yet started.

Returns { host: string; port: number } | null
- Defined in libs/server/src/Server.ts:491

Methods

close

close(): Promise<void>
Gracefully stop the server and free the TCP port.

Returns Promise<void>
- Defined in libs/server/src/Server.ts:459

start

start(port: number, host: string, options: ServerOptions): Promise<void>
Start listening. Called internally by ServerBuilder.listen() after the server is fully configured.
Parameters
- port: number
- host: string
- options: ServerOptions
Returns Promise<void>
- Defined in libs/server/src/Server.ts:394