Class ApiResponse

constructor

• new ApiResponse(response: Response, request: ApiRequest): ApiResponse

  Constructs an instance of ApiResponse.

  Parameters

  • response: Response

    The native Fetch API Response object.

  • request: ApiRequest

    The associated ApiRequest that generated this response.

  Returns ApiResponse

Readonlyresponse

Readonlyrequest

ok

• get ok(): boolean

  Indicates whether the HTTP response status is within the successful range (200–299).

  Returns boolean

  true if the response is successful, otherwise false.

status

• get status(): number

  Returns the numeric HTTP status code of the response.

  Returns number

  Example

  200, 404, 500, etc.
  Copy

statusText

• get statusText(): string

  Returns the HTTP status text of the response.

  Returns string

  Example

  "OK", "Not Found", "Internal Server Error"
  Copy

headers

• get headers(): Headers

  Returns all response headers as a Headers object.

  Returns Headers

getData

• getData<T = unknown>(): Promise<T>

  Retrieves and parses the response body automatically based on the request configuration.

  Type Parameters

  • T = unknown

    The expected type of the parsed data.

  Returns Promise<T>

  A promise resolving to the parsed data of type T.

  Supported response types:

  • json
  • text
  • blob
  • arrayBuffer
  • auto (default – automatically detects format)

json

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

  Parses the response as JSON.

  Type Parameters

  • T = unknown

    The expected JSON object type.

  Returns Promise<T>

  A promise resolving to parsed JSON data.

  Throws

  If the response body cannot be parsed as JSON.

text

• text(): Promise<string>

  Parses the response as plain text.

  Returns Promise<string>

  A promise resolving to a string value.

  Throws

  If the text body cannot be retrieved.

blob

• blob(): Promise<Blob>

  Parses the response as a binary Blob.

  Returns Promise<Blob>

  A promise resolving to a Blob object.

  Throws

  If the blob body cannot be retrieved.

arrayBuffer

• arrayBuffer(): Promise<ArrayBuffer>

  Parses the response as an ArrayBuffer.

  Returns Promise<ArrayBuffer>

  A promise resolving to an ArrayBuffer.

  Throws

  If the array buffer cannot be retrieved.