Class TestHttpRequest

TestHttpRequest

Request builder with fluent API for configuring test HTTP requests.

Example

const response = await module.http
  .post('/api/v1/register')
  .withBody({ name: 'Test School' })
  .withHeaders({ 'X-Custom': 'value' })
  .send()

Example: Authenticated request

const response = await module.http
  .get('/api/v1/profile')
  .actingAs({ id: user.id })
  .send()

Hierarchy

Macroable
- TestHttpRequest

Indexable

[key: string | symbol]: unknown

Index

Constructors

constructor

new TestHttpRequest(
    method: string,
    path: string,
    headers: Headers,
    module: TestingModule,
    host?: string | null,
    localeConfig?: { locale: string; strategy: DetectionStrategy } | null,
): TestHttpRequest
Parameters
- method: string
- path: string
- headers: Headers
- module: TestingModule
- host: string | null = null
- localeConfig: { locale: string; strategy: DetectionStrategy } | null = null
Returns TestHttpRequest
Overrides Macroable.constructor
- Defined in packages/testing/src/core/http/test-http-request.ts:39

Properties

`Protected`actingAsUser

actingAsUser: { id: string } | null = null

`Protected`authResolver

authResolver:
| ((module: TestingModule, user: { id: string }) => Promise<Headers>)
| null = null

`Protected`body

body: unknown = null

`Protected` `Readonly`host

host: string | null = null

`Protected`localeConfig

localeConfig: { locale: string; strategy: DetectionStrategy } | null

`Protected` `Readonly`method

method: string

`Protected` `Readonly`module

module: TestingModule

`Protected` `Readonly`path

path: string

`Protected`requestHeaders

requestHeaders: Headers

`Protected` `Static`getterNames

getterNames: Set<string | symbol>

Names registered via getter() — used by hasMacro() and flushMacros().

`Protected` `Static`instanceMacros

instanceMacros: Set<{ key: string | symbol; value: unknown }>

Per-instance properties. Each entry is applied and bound to this inside the constructor so destructuring stays safe.

`Protected` `Static`macroNames

macroNames: Set<string | symbol>

Names registered via macro() — used by hasMacro() and flushMacros().

Methods

actingAs

actingAs(user: { id: string }): this
Authenticate the request as a specific user
Parameters
- user: { id: string }
Returns this
- Defined in packages/testing/src/core/http/test-http-request.ts:95

`Protected`applyAuthentication

applyAuthentication(): Promise<void>
Returns Promise<void>
- Defined in packages/testing/src/core/http/test-http-request.ts:133

asJson

asJson(): this
Set Content-Type to application/json

Returns this
- Defined in packages/testing/src/core/http/test-http-request.ts:87

send

send(): Promise<TestResponse>
Send the request and return response

Calls module.fetch() - NOT SELF.fetch()

Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-http-request.ts:106

withBody

withBody(data: unknown): this
Set the request body
Parameters
- data: unknown
Returns this
- Defined in packages/testing/src/core/http/test-http-request.ts:55

withHeaders

withHeaders(headers: Record<string, string>): this
Add headers to the request
Parameters
- headers: Record<string, string>
Returns this
- Defined in packages/testing/src/core/http/test-http-request.ts:63

withLocale

withLocale(locale: string, strategy?: DetectionStrategy): this
Set the locale for this request. 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 this
- Defined in packages/testing/src/core/http/test-http-request.ts:77

`Static`flushMacros

flushMacros(): void
Remove all macros, instance properties, and getters registered on this class. Does not affect parent classes.

Returns void
Inherited from Macroable.flushMacros
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:96

`Static`getter

getter<T extends Constructor, K extends string | number | symbol>(
    this: T,
    name: K,
    accumulator: (this: InstanceType<T>) => InstanceType<T>[K],
    singleton?: boolean,
): void
Register a computed getter on the class prototype.
Type Parameters
- T extends Constructor
- K extends string | number | symbol
Parameters
- this: T
- name: K
  Property name
- accumulator: (this: InstanceType<T>) => InstanceType<T>[K]
  Function that computes the value (called with instance as this)
- Optionalsingleton: boolean
  If true, cache the value after first access
Returns void
Inherited from Macroable.getter
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:84
getter(
    name: string | symbol,
    accumulator: MacroFunction,
    singleton?: boolean,
): void
Register a computed getter on the class prototype.
Parameters
- name: string | symbol
  Property name
- accumulator: MacroFunction
  Function that computes the value (called with instance as this)
- Optionalsingleton: boolean
  If true, cache the value after first access
Returns void
Inherited from Macroable.getter
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:85

`Static`hasMacro

hasMacro(name: string | symbol): boolean
Check if a macro, instance property, or getter is registered.
Parameters
- name: string | symbol
  Name to check
Returns boolean
Inherited from Macroable.hasMacro
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:91

`Static`instanceProperty

instanceProperty<T extends Constructor, K extends string | number | symbol>(
    this: T,
    name: K,
    value: InstanceType<T>[K],
): void
Register a per-instance property that is bound to this in the constructor. Safe for destructuring.

When the name matches an existing property, the value type is auto-derived.
Type Parameters
- T extends Constructor
- K extends string | number | symbol
Parameters
- this: T
- name: K
  Property name
- value: InstanceType<T>[K]
  Function (will be bound) or value
Returns void
Inherited from Macroable.instanceProperty
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:75
instanceProperty(name: string | symbol, value: unknown): void
Register a per-instance property that is bound to this in the constructor. Safe for destructuring.

When the name matches an existing property, the value type is auto-derived.
Parameters
- name: string | symbol
  Property name
- value: unknown
  Function (will be bound) or value
Returns void
Inherited from Macroable.instanceProperty
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:76

`Static`macro

macro<T extends Constructor, K extends string | number | symbol>(
    this: T,
    name: K,
    value: InstanceType<T>[K],
): void
Register a macro on the class prototype. Can override existing methods.

When the name matches an existing property, the value type is auto-derived.
Type Parameters
- T extends Constructor
- K extends string | number | symbol
Parameters
- this: T
- name: K
  Method or property name
- value: InstanceType<T>[K]
  Function or value to assign
Returns void
Inherited from Macroable.macro
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:64
macro(name: string | symbol, value: unknown): void
Register a macro on the class prototype. Can override existing methods.

When the name matches an existing property, the value type is auto-derived.
Parameters
- name: string | symbol
  Method or property name
- value: unknown
  Function or value to assign
Returns void
Inherited from Macroable.macro
- Defined in packages/core/dist/index-SHx31sBJ.d.mts:65

Class TestHttpRequest

Example

Example: Authenticated request

Hierarchy

Indexable

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TestHttpRequest

Properties

ProtectedactingAsUser

ProtectedauthResolver

Protectedbody

Protected Readonlyhost

ProtectedlocaleConfig

Protected Readonlymethod

Protected Readonlymodule

Protected Readonlypath

ProtectedrequestHeaders

Protected StaticgetterNames

Protected StaticinstanceMacros

Protected StaticmacroNames

Methods

actingAs

Parameters

Returns this

ProtectedapplyAuthentication

Returns Promise<void>

asJson

Returns this

send

Returns Promise<TestResponse>

withBody

Parameters

Returns this

withHeaders

Parameters

Returns this

withLocale

Parameters

Returns this

StaticflushMacros

Returns void

Staticgetter

Type Parameters

Parameters

Returns void

Parameters

Returns void

StatichasMacro

Parameters

Returns boolean

StaticinstanceProperty

Type Parameters

Parameters

Returns void

Parameters

Returns void

Staticmacro

Type Parameters

Parameters

Returns void

Parameters

Returns void

Settings

On This Page

`Protected`actingAsUser

`Protected`authResolver

`Protected`body

`Protected` `Readonly`host

`Protected`localeConfig

`Protected` `Readonly`method

`Protected` `Readonly`module

`Protected` `Readonly`path

`Protected`requestHeaders

`Protected` `Static`getterNames

`Protected` `Static`instanceMacros

`Protected` `Static`macroNames

`Protected`applyAuthentication

`Static`flushMacros

`Static`getter

`Static`hasMacro

`Static`instanceProperty

`Static`macro