Class: Server

Defined in: packages/api/src/lib/structures/http/Server.ts:40

Since

1.0.0

Extends

• AsyncEventEmitter<ServerEvents>

Constructors

Constructor

new Server(options: ServerOptions): Server

Defined in: packages/api/src/lib/structures/http/Server.ts:75

Parameters

Parameter	Type	Description
options	ServerOptions	The options for this server

Returns

Server

Since

1.0.0

Overrides

AsyncEventEmitter<ServerEvents>.constructor

Properties

auth

readonly auth: null | Auth

Defined in: packages/api/src/lib/structures/http/Server.ts:57

The authentication system.

Since

1.0.0

---

middlewares

readonly middlewares: MiddlewareStore

Defined in: packages/api/src/lib/structures/http/Server.ts:51

The middlewares this server holds.

Since

1.0.0

---

options

readonly options: AuthLessServerOptions

Defined in: packages/api/src/lib/structures/http/Server.ts:69

The options for this server.

Since

1.0.0

---

routes

readonly routes: RouteStore

Defined in: packages/api/src/lib/structures/http/Server.ts:45

The routes this server holds.

Since

1.0.0

---

server

readonly server: Server

Defined in: packages/api/src/lib/structures/http/Server.ts:63

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

Since

1.0.0

Methods

connect()

connect(): Promise<void>

Defined in: packages/api/src/lib/structures/http/Server.ts:93

Returns

Promise<void>

---

disconnect()

disconnect(): Promise<void>

Defined in: packages/api/src/lib/structures/http/Server.ts:128

Returns

Promise<void>