Class TestResponse

TestResponse

Wrapper around Response with assertion methods.

Example

response
  .assertOk()
  .assertStatus(200)
  .assertJsonPath('data.id', userId)

Hierarchy

Macroable
- TestResponse

Indexable

[key: string | symbol]: unknown

Constructors

constructor

new TestResponse(response: Response): TestResponse
Parameters
- response: Response
Returns TestResponse
Overrides Macroable.constructor
- Defined in packages/testing/src/core/http/test-response.ts:22

Properties

`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().

Accessors

headers

get headers(): Headers
Get response headers.

Returns Headers
- Defined in packages/testing/src/core/http/test-response.ts:43

raw

get raw(): Response
Get the raw Response object.

Returns Response
- Defined in packages/testing/src/core/http/test-response.ts:29

status

get status(): number
Get the response status code.

Returns number
- Defined in packages/testing/src/core/http/test-response.ts:36

Methods

assertBadRequest

assertBadRequest(): this
Assert response status is 400 Bad Request.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:93

assertCreated

assertCreated(): this
Assert response status is 201 Created.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:79

assertForbidden

assertForbidden(): this
Assert response status is 403 Forbidden.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:107

assertHeader

assertHeader(name: string, expected?: string): this
Assert response has the given header.
Parameters
- name: string
- Optionalexpected: string
Returns this
- Defined in packages/testing/src/core/http/test-response.ts:358

assertHeaderMissing

assertHeaderMissing(name: string): this
Assert response does not have the given header.
Parameters
- name: string
Returns this
- Defined in packages/testing/src/core/http/test-response.ts:379

assertJson

assertJson(expected: Record<string, unknown>): Promise<TestResponse>
Assert JSON response contains the given data.
Parameters
- expected: Record<string, unknown>
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:161

assertJsonPath

assertJsonPath(path: string, expected: unknown): Promise<TestResponse>
Assert JSON response has value at the given path.
Parameters
- path: string
  Dot-notation path (e.g., 'data.user.id')
- expected: unknown
  Expected value at path
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:180

assertJsonPathContains

assertJsonPathContains(path: string, substring: string): Promise<TestResponse>
Assert string value at path contains a substring.
Parameters
- path: string
  Dot-notation path (e.g., 'data.message')
- substring: string
  Substring to search for
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:269

assertJsonPathCount

assertJsonPathCount(path: string, count: number): Promise<TestResponse>
Assert array length at path equals the expected count.
Parameters
- path: string
  Dot-notation path (e.g., 'data.items')
- count: number
  Expected array length
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:315

assertJsonPathExists

assertJsonPathExists(path: string): Promise<TestResponse>
Assert a JSON path exists (value can be anything, including null).
Parameters
- path: string
  Dot-notation path (e.g., 'data.user.id')
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:213

assertJsonPathIncludes

assertJsonPathIncludes(path: string, item: unknown): Promise<TestResponse>
Assert array value at path includes a specific item.
Parameters
- path: string
  Dot-notation path (e.g., 'data.tags')
- item: unknown
  Item to search for in the array
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:292

assertJsonPathMatches

assertJsonPathMatches(
path: string,
matcher: (value: unknown) => boolean,
): Promise<TestResponse>
Assert JSON value at path matches a custom predicate.
Parameters
- path: string
  Dot-notation path (e.g., 'data.items')
- matcher: (value: unknown) => boolean
  Predicate function to validate the value
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:248

assertJsonPathMissing

assertJsonPathMissing(path: string): Promise<TestResponse>
Assert a JSON path does not exist.
Parameters
- path: string
  Dot-notation path (e.g., 'data.user.deletedAt')
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:230

assertJsonPaths

assertJsonPaths(expectations: Record<string, unknown>): Promise<TestResponse>
Assert multiple JSON paths at once (batch assertion).
Parameters
- expectations: Record<string, unknown>
  Object mapping paths to expected values
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:337

assertJsonStructure

assertJsonStructure(structure: string[]): Promise<TestResponse>
Assert JSON response structure matches the given schema.
Parameters
- structure: string[]
Returns Promise<TestResponse>
- Defined in packages/testing/src/core/http/test-response.ts:195

assertNoContent

assertNoContent(): this
Assert response status is 204 No Content.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:86

assertNotFound

assertNotFound(): this
Assert response status is 404 Not Found.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:114

assertOk

assertOk(): this
Assert response status is 200 OK.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:72

assertServerError

assertServerError(): this
Assert response status is 500 Internal Server Error.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:128

assertStatus

assertStatus(expected: number): this
Assert response has the given status code.
Parameters
- expected: number
Returns this
- Defined in packages/testing/src/core/http/test-response.ts:135

assertSuccessful

assertSuccessful(): this
Assert response status is in the 2xx success range.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:146

assertUnauthorized

assertUnauthorized(): this
Assert response status is 401 Unauthorized.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:100

assertUnprocessable

assertUnprocessable(): this
Assert response status is 422 Unprocessable Entity.

Returns this
- Defined in packages/testing/src/core/http/test-response.ts:121

json

json<T = unknown>(): Promise<T>
Get the response body as JSON.
Type Parameters
- T = unknown
Returns Promise<T>
- Defined in packages/testing/src/core/http/test-response.ts:50

text

text(): Promise<string>
Get the response body as text.

Returns Promise<string>
- Defined in packages/testing/src/core/http/test-response.ts:60

`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 TestResponse

Example

Hierarchy

Indexable

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TestResponse

Properties

Protected StaticgetterNames

Protected StaticinstanceMacros

Protected StaticmacroNames

Accessors

headers

Returns Headers

raw

Returns Response

status

Returns number

Methods

assertBadRequest

Returns this

assertCreated

Returns this

assertForbidden

Returns this

assertHeader

Parameters

Returns this

assertHeaderMissing

Parameters

Returns this

assertJson

Parameters

Returns Promise<TestResponse>

assertJsonPath

Parameters

Returns Promise<TestResponse>

assertJsonPathContains

Parameters

Returns Promise<TestResponse>

assertJsonPathCount

Parameters

Returns Promise<TestResponse>

assertJsonPathExists

Parameters

Returns Promise<TestResponse>

assertJsonPathIncludes

Parameters

Returns Promise<TestResponse>

assertJsonPathMatches

Parameters

Returns Promise<TestResponse>

assertJsonPathMissing

Parameters

Returns Promise<TestResponse>

assertJsonPaths

Parameters

Returns Promise<TestResponse>

assertJsonStructure

Parameters

Returns Promise<TestResponse>

assertNoContent

Returns this

assertNotFound

Returns this

assertOk

Returns this

assertServerError

Returns this

assertStatus

Parameters

Returns this

assertSuccessful

Returns this

`Protected` `Static`getterNames

`Protected` `Static`instanceMacros

`Protected` `Static`macroNames

`Static`flushMacros

`Static`getter

`Static`hasMacro

`Static`instanceProperty

`Static`macro