Skip to main content

Class: Server

Since

1.0.0

Extends

  • EventEmitter

Constructors

new Server()

new Server(options: ServerOptions): Server

Parameters

ParameterTypeDescription
optionsServerOptionsThe options for this server

Returns

Server

Overrides

EventEmitter.constructor

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:67

Properties

auth

readonly auth: null | Auth

The authentication system.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:49


mediaParsers

readonly mediaParsers: MediaParserStore

The media parsers this server holds.

Since

1.3.0

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:43


middlewares

readonly middlewares: MiddlewareStore

The middlewares this server holds.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:37


options

readonly options: AuthLessServerOptions

The options for this server.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:61


routes

readonly routes: RouteStore

The routes this server holds.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:31


server

readonly server: Server<typeof IncomingMessage, typeof ServerResponse>

The http.Server instance that manages the recieved HTTP requests.

Since

1.0.0

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:55

Methods

connect()

connect(): Promise<void>

Returns

Promise<void>

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:86


disconnect()

disconnect(): Promise<void>

Returns

Promise<void>

Source

projects/plugins/packages/api/src/lib/structures/http/Server.ts:121