Class HttpServerUtils

Http server utils are used to start the AdonisJS HTTP server during testing. It provides methods to start and stop the server for integration testing.

Example

const testUtils = new TestUtils(app)
const httpUtils = testUtils.httpServer()

const closeServer = await httpUtils.start()
// Make HTTP requests to test endpoints
await closeServer() // Clean up

Index

Constructors

constructor

Methods

start

Constructors

constructor

new HttpServerUtils(utils: TestUtils): HttpServerUtils
Creates a new HttpServerUtils instance
Parameters
- utils: TestUtils
  The test utils instance
Returns HttpServerUtils
- Defined in src/test_utils/http.ts:44

Methods

start

start(
    serverCallback?: (
        handler: (req: IncomingMessage, res: ServerResponse) => any,
    ) =>
        | Server<typeof IncomingMessage, typeof ServerResponse>
        | Server<typeof IncomingMessage, typeof ServerResponse>,
): Promise<() => Promise<void>>
Testing hook to start the HTTP server to listen for new request. The return value is a function to close the HTTP server.
Parameters
- OptionalserverCallback: (
      handler: (req: IncomingMessage, res: ServerResponse) => any,
  ) =>
      | Server<typeof IncomingMessage, typeof ServerResponse>
      | Server<typeof IncomingMessage, typeof ServerResponse>
  Optional callback to create custom HTTP server instance
Returns Promise<() => Promise<void>>
- Defined in src/test_utils/http.ts:78

Class HttpServerUtils

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns HttpServerUtils

Methods

start

Parameters

Returns Promise<() => Promise<void>>

Settings

On This Page