Class TestHttpClient

TestHttpClient

Fluent HTTP client for making test requests.

Example

const response = await module.http
  .forHost('example.com')
  .post('/api/v1/users')
  .withBody({ name: 'Test' })
  .send()

response.assertCreated()

Index

Constructors

constructor

Methods

delete forHost get patch post put withHeaders withLocale

Constructors

constructor

new TestHttpClient(
    module: TestingModule,
    host?: string | null,
    headers?: Headers,
    localeConfig?: { locale: string; strategy: DetectionStrategy } | null,
): TestHttpClient
Parameters
- module: TestingModule
- host: string | null = null
- headers: Headers = ...
- localeConfig: { locale: string; strategy: DetectionStrategy } | null = null
Returns TestHttpClient
- Defined in packages/testing/src/core/http/test-http-client.ts:27

Methods

delete

delete(path: string): TestHttpRequest
Create a DELETE request
Parameters
- path: string
Returns TestHttpRequest
- Defined in packages/testing/src/core/http/test-http-client.ts:105

forHost

forHost(host: string): TestHttpClient
Set the host for the request (returns a new client). Also sets the Host header to ensure domain routing works even when the runtime reads the header instead of the URL host.
Parameters
- host: string
Returns TestHttpClient
- Defined in packages/testing/src/core/http/test-http-client.ts:43

get

get(path: string): TestHttpRequest
Create a GET request
Parameters
- path: string
Returns TestHttpRequest
- Defined in packages/testing/src/core/http/test-http-client.ts:77

patch

patch(path: string): TestHttpRequest
Create a PATCH request
Parameters
- path: string
Returns TestHttpRequest
- Defined in packages/testing/src/core/http/test-http-client.ts:98

post

post(path: string): TestHttpRequest
Create a POST request
Parameters
- path: string
Returns TestHttpRequest
- Defined in packages/testing/src/core/http/test-http-client.ts:84

put

put(path: string): TestHttpRequest
Create a PUT request
Parameters
- path: string
Returns TestHttpRequest
- Defined in packages/testing/src/core/http/test-http-client.ts:91

withHeaders

withHeaders(headers: Record<string, string>): TestHttpClient
Set default headers for all requests (returns a new client)
Parameters
- headers: Record<string, string>
Returns TestHttpClient
- Defined in packages/testing/src/core/http/test-http-client.ts:52

withLocale

withLocale(locale: string, strategy?: DetectionStrategy): TestHttpClient
Set the locale for all requests from this client (returns a new client). If strategy is not provided, resolves from the module's I18n configuration.
Parameters
- locale: string
  Locale code (e.g., 'en', 'fr')
- Optionalstrategy: DetectionStrategy
  Detection strategy override
Returns TestHttpClient
- Defined in packages/testing/src/core/http/test-http-client.ts:67

Class TestHttpClient

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TestHttpClient

Methods

delete

Parameters

Returns TestHttpRequest

forHost

Parameters

Returns TestHttpClient

get

Parameters

Returns TestHttpRequest

patch

Parameters

Returns TestHttpRequest

post

Parameters

Returns TestHttpRequest

put

Parameters

Returns TestHttpRequest

withHeaders

Parameters

Returns TestHttpClient

withLocale

Parameters

Returns TestHttpClient

Settings

On This Page