Class ResponseParser

ResponseParser parses and makes assertions about responses.

Constructors

constructor

Properties

afterHooks assertions response

Methods

addAfterHook awaitRequest json raw status text

Constructors

constructor

Properties

Private afterHooks

afterHooks: AfterHook[] = []

Private assertions

assertions: ResponseAssertion[] = []

Private Readonly response

response: Promise<Response>

Methods

addAfterHook

  • addAfterHook(hook): ResponseParser

  • Hook into the response lifecycle to run arbitrary logic after a response has been received. Useful, for example, if you need to automatically close a server when a response has been received.

    Parameters

    • hook: AfterHook

      An arbitrary (possibly async) function to run after the response has been received.

    Returns ResponseParser

Private awaitRequest

  • awaitRequest(): Promise<Response>

  • Returns Promise<Response>

json

  • json<T>(): Promise<T>

  • Runs assertions and returns the HTTP response body parsed as json

    Type Parameters

    • T = any

    Returns Promise<T>

    JSON response body, or throws an error if unparsable

raw

  • raw(): Promise<Response>

  • Runs assertions and returns a raw http response

    Returns Promise<Response>

    a raw HttpResponse

status

text

  • text(): Promise<string>

  • Runs assertions and returns the HTTP response body parsed as text

    Returns Promise<string>

    response body as text

Settings

Member Visibility

Theme

On This Page

constructorafterHooksassertionsresponseaddAfterHookawaitRequestjsonrawstatustext

Generated using TypeDoc