• Overview
@angular/common/http

HttpResponse

Class
stable

A full HTTP response, including a typed response body (which may be null if one was not returned).

API

    
      class HttpResponse<T> extends HttpResponseBase {
}

constructor

HttpResponse<T>

Construct a new HttpResponse.

@paraminit{ body?: T | null | undefined; headers?: HttpHeaders | undefined; status?: number | undefined; statusText?: string | undefined; url?: string | undefined; redirected?: boolean | undefined; responseType?: ResponseType | undefined; }
@returnsHttpResponse<T>

body

T | null

The response body, or null if one was not returned.

clone

3 overloads
@returnsHttpResponse<T>
@paramupdate{ headers?: HttpHeaders | undefined; status?: number | undefined; statusText?: string | undefined; url?: string | undefined; redirected?: boolean | undefined; responseType?: ResponseType | undefined; }
@returnsHttpResponse<T>
@paramupdate{ body?: V | null | undefined; headers?: HttpHeaders | undefined; status?: number | undefined; statusText?: string | undefined; url?: string | undefined; redirected?: boolean | undefined; responseType?: ResponseType | undefined; }
@returnsHttpResponse<V>

headers

HttpHeaders

All response headers.

status

number

Response status code.

statusText

string
@deprecated

With HTTP/2 and later versions, this will incorrectly remain set to 'OK' even when the status code of a response is not 200.

Textual description of response status code, defaults to OK.

Do not depend on this.

url

string | null

URL of the resource retrieved, or null if not available.

ok

boolean

Whether the status code falls in the 2xx range.

redirected

boolean | undefined

Indicates whether the HTTP response was redirected during the request. This property is only available when using the Fetch API using withFetch() When using the default XHR Request this property will be undefined

responseType

ResponseType | undefined

Indicates the type of the HTTP response, based on how the request was made and how the browser handles the response.

This corresponds to the type property of the Fetch API's Response object, which can indicate values such as:

  • 'basic': A same-origin response, allowing full access to the body and headers.
  • 'cors': A cross-origin response with CORS enabled, exposing only safe response headers.
  • 'opaque': A cross-origin response made with no-cors, where the response body and headers are inaccessible.
  • 'opaqueredirect': A response resulting from a redirect followed in no-cors mode.
  • 'error': A response representing a network error or similar failure.

This property is only available when using the Fetch-based backend (via withFetch()). When using Angular's (XHR) backend, this value will be undefined.

Description

A full HTTP response, including a typed response body (which may be null if one was not returned).

HttpResponse is a HttpEvent available on the response event stream.

Jump to details