@charaverse/express-utils

Index

Type aliases

Functions

Type aliases

Middleware

Middleware: RequestHandler | ErrorRequestHandler

TestServer

TestServer: Hapi.Server

TestServerInjectOptions

TestServerInjectOptions: Hapi.ServerInjectOptions

TestServerInjectResponse

TestServerInjectResponse: Hapi.ServerInjectResponse

Functions

createTestResponse

createTestResponse(middlewares: Middleware[], injectRequest?: Partial<ServerInjectOptions>): Promise<TestServerInjectResponse>

- Defined in test-utils.ts:42
Given a list of middlewares, create an app with the middlewares and inject with a request. The returned object is a ServerInjectResponse that

By default the request url is /.

Parameters
- middlewares: Middleware[]
  
  A list of middlewares to be added into the app.
- injectRequest: Partial<ServerInjectOptions> = {}
  
  The request to be injected.
Returns Promise<TestServerInjectResponse>

createTestServer

createTestServer(...middlewares: Middleware[]): Promise<TestServer>

- Defined in test-utils.ts:20
Given a list of middlewares, create a hapi Server instance with the express middlewares mounted. The resulting server then can be injected with different requests each time.

Parameters
- Rest ...middlewares: Middleware[]
  
  A list of middlewares to be added into the server.
Returns Promise<TestServer>

handle

handle<T>(fn: HandleFunction<T>): RequestHandler

- Defined in handle.ts:10
Type parameters
- T = void
Parameters
- fn: HandleFunction<T>
Returns RequestHandler

Generated using TypeDoc