Interface ApiResponse<T>

The http library agnostic response.

Type parameters

T = any[] | Record<string, any> | string | null

Hierarchy

Pick<Response, "headers" | "status" | "statusText">
- ApiResponse

Indexable

[key: string]: any

Additional information.

Index

Properties

Methods

json

Properties

Optional data

data?: T

The parsed response content. (in case of libraries like axios)

Readonly headers

headers: Headers

Optional request

request?: (Record<string, any> & RequestInit) & (Record<string, any> & XMLHttpRequest)

The request that got this response.

Readonly status

status: number

Readonly statusText

statusText: string

Optional url

url?: string

The url the request was sent to.

Methods

Optional json

json(): Promise<Exclude<T, null | string>>

- Defined in src/Contracts/HandlesApiResponse.ts:31
The fetch json method resolving to the given type.

Returns Promise<Exclude<T, null | string>>

Generated using TypeDoc