Class: Server

Since

1.0.0

Extends

• AsyncEventEmitter<ServerEvents>

Constructors

new Server()

new Server(options: ServerOptions): Server

Parameters

Parameter	Type	Description
options	ServerOptions	The options for this server

Returns

Server

Since

1.0.0

Overrides

AsyncEventEmitter<ServerEvents>.constructor

Defined in

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

Properties

auth

readonly auth: null | Auth

The authentication system.

Since

1.0.0

Defined in

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

---

mediaParsers

readonly mediaParsers: MediaParserStore

The media parsers this server holds.

Since

1.3.0

Defined in

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

---

middlewares

readonly middlewares: MiddlewareStore

The middlewares this server holds.

Since

1.0.0

Defined in

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

---

options

readonly options: AuthLessServerOptions

The options for this server.

Since

1.0.0

Defined in

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

---

routes

readonly routes: RouteStore

The routes this server holds.

Since

1.0.0

Defined in

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

---

server

readonly server: Server<typeof IncomingMessage, typeof ServerResponse>

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

Since

1.0.0

Defined in

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

Methods

connect()

connect(): Promise<void>

Returns

Promise<void>

Defined in

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

---

disconnect()

disconnect(): Promise<void>

Returns

Promise<void>

Defined in

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