Class: Server
api/src.Server
since 1.0.0
Hierarchy
EventEmitter↳
Server
Constructors
constructor
• new Server(options?)
since 1.0.0
Parameters
| Name | Type | Description |
|---|---|---|
options | ServerOptions | The options for this server |
Overrides
EventEmitter.constructor
Defined in
projects/plugins/packages/api/src/lib/structures/http/Server.ts:67
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:49
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:43
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:37
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:61
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:31
server
• Readonly server: Server
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:55
Methods
connect
▸ connect(): Promise<void>
Returns
Promise<void>
Defined in
projects/plugins/packages/api/src/lib/structures/http/Server.ts:88
disconnect
▸ disconnect(): Promise<void>
Returns
Promise<void>
Defined in
projects/plugins/packages/api/src/lib/structures/http/Server.ts:123