Class Server

The Server class provides the core HTTP server implementation for AdonisJS.

It handles incoming HTTP requests by processing them through middleware pipelines, routing them to appropriate handlers, and managing response generation. The server supports custom error handling, middleware registration, and various Node.js HTTP server configurations.

Example

const server = new Server(app, encryption, emitter, logger, config)
server.use([AuthMiddleware, CorsMiddleware])
server.errorHandler(() => import('./error_handler.ts'))
await server.boot()

http.createServer(server.handle.bind(server))

Index

Constructors

constructor

new Server(
    app: Application<any>,
    encryption: Encryption,
    emitter: EmitterLike<HttpServerEvents>,
    logger: Logger,
    config: ServerConfig,
): Server
Creates a new Server instance
Parameters
- app: Application<any>
  AdonisJS application instance
- encryption: Encryption
  Encryption service for secure operations
- emitter: EmitterLike<HttpServerEvents>
  Event emitter for server lifecycle events
- logger: Logger
  Logger instance for server operations
- config: ServerConfig
  Server configuration settings
Returns Server
- Defined in src/server/main.ts:174

Accessors

booted

get booted(): boolean
Indicates whether the server has completed its boot process

Returns boolean
- Defined in src/server/main.ts:154

usingAsyncLocalStorage

get usingAsyncLocalStorage(): boolean
Indicates whether async local storage is enabled for request context

Returns boolean
- Defined in src/server/main.ts:161

Methods

pipeline

pipeline(middleware: MiddlewareAsClass[]): TestingMiddlewarePipeline
Creates a testing middleware pipeline for unit/integration testing
Parameters
- middleware: MiddlewareAsClass[]
  Array of middleware classes to include in pipeline
Returns TestingMiddlewarePipeline
TestingMiddlewarePipeline instance for test execution
- Defined in src/server/main.ts:240

use

use(middleware: LazyImport<MiddlewareAsClass>[]): this
Registers global middleware to run on all incoming HTTP requests
Parameters
- middleware: LazyImport<MiddlewareAsClass>[]
  Array of lazy-imported middleware classes
Returns this
The Server instance for method chaining
- Defined in src/server/main.ts:275

errorHandler

errorHandler(handler: LazyImport<ErrorHandlerAsAClass>): this
Registers a custom error handler for HTTP request processing
Parameters
- handler: LazyImport<ErrorHandlerAsAClass>
  Lazy import of the error handler class
Returns this
The Server instance for method chaining
- Defined in src/server/main.ts:292

boot

boot(): Promise<void>
Initializes the server by compiling middleware, committing routes, and resolving handlers

Performs the following operations:
- Compiles the middleware stack
- Commits registered routes to the router
- Resolves and instantiates the custom error handler
Returns Promise<void>
- Defined in src/server/main.ts:305

setNodeServer

setNodeServer(
    server:
        | Server<typeof IncomingMessage, typeof ServerResponse>
        | Server<typeof IncomingMessage, typeof ServerResponse>,
): void
Configures the underlying Node.js HTTP/HTTPS server with timeout settings
Parameters
- server:
  | Server<typeof IncomingMessage, typeof ServerResponse>
  | Server<typeof IncomingMessage, typeof ServerResponse>
  Node.js HTTP or HTTPS server instance
Returns void
- Defined in src/server/main.ts:342

getNodeServer

getNodeServer(): | undefined
| Server<typeof IncomingMessage, typeof ServerResponse>
| Server<typeof IncomingMessage, typeof ServerResponse>
Gets the underlying Node.js HTTP/HTTPS server instance

Returns
    | undefined
    | Server<typeof IncomingMessage, typeof ServerResponse>
    | Server<typeof IncomingMessage, typeof ServerResponse>
The configured server instance or undefined if not set
- Defined in src/server/main.ts:355

getRouter

getRouter(): Router
Gets the router instance used for route registration and matching

Returns Router
The Router instance
- Defined in src/server/main.ts:364

createRequest

createRequest(req: IncomingMessage, res: ServerResponse): Request
Creates a Request instance from Node.js request/response objects
Parameters
- req: IncomingMessage
  Node.js IncomingMessage
- res: ServerResponse
  Node.js ServerResponse
Returns Request
New Request instance
- Defined in src/server/main.ts:375

createResponse

createResponse(req: IncomingMessage, res: ServerResponse): Response
Creates a Response instance from Node.js request/response objects
Parameters
- req: IncomingMessage
  Node.js IncomingMessage
- res: ServerResponse
  Node.js ServerResponse
Returns Response
New Response instance
- Defined in src/server/main.ts:386

createHttpContext

createHttpContext(
    request: Request,
    response: Response,
    resolver: ContainerResolver<any>,
): HttpContext
Creates an HttpContext instance with request-specific logger
Parameters
- request: Request
  Request instance
- response: Response
  Response instance
- resolver: ContainerResolver<any>
  Container resolver for dependency injection
Returns HttpContext
New HttpContext instance
- Defined in src/server/main.ts:398

getMiddlewareList

getMiddlewareList(): ParsedGlobalMiddleware[]
Gets the list of registered global middleware

Returns ParsedGlobalMiddleware[]
Array of parsed global middleware
- Defined in src/server/main.ts:412

handle

handle(req: IncomingMessage, res: ServerResponse): Promise<any>
Handles an incoming HTTP request by creating context and processing through pipeline
Parameters
- req: IncomingMessage
  Node.js IncomingMessage
- res: ServerResponse
  Node.js ServerResponse
Returns Promise<any>
Promise that resolves when request processing is complete
- Defined in src/server/main.ts:425

Class Server

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Server

Accessors

booted

Returns boolean

usingAsyncLocalStorage

Returns boolean

Methods

pipeline

Parameters

Returns TestingMiddlewarePipeline

use

Parameters

Returns this

errorHandler

Parameters

Returns this

boot

Returns Promise<void>

setNodeServer

Parameters

Returns void

getNodeServer

Returns | undefined | Server<typeof IncomingMessage, typeof ServerResponse> | Server<typeof IncomingMessage, typeof ServerResponse>

getRouter

Returns Router

createRequest

Parameters

Returns Request

createResponse

Parameters

Returns Response

createHttpContext

Parameters

Returns HttpContext

getMiddlewareList

Returns ParsedGlobalMiddleware[]

handle

Parameters

Returns Promise<any>

Settings

On This Page

Returns
| undefined
| Server<typeof IncomingMessage, typeof ServerResponse>
| Server<typeof IncomingMessage, typeof ServerResponse>