This is the archived documentation for Angular v6. Please visit angular.io to see documentation for the current version of Angular.

Response

Creates Response instances from provided values.

See more...

Deprecated: see https://angular.io/guide/http

      
      class Response extends Body {
  constructor(responseOptions: ResponseOptions)
  type: ResponseType
  ok: boolean
  url: string
  status: number
  statusText: string | null
  bytesLoaded: number
  totalBytes: number
  headers: Headers | null
  toString(): string
}
    

Description

Though this object isn't usually instantiated by end-users, it is the primary object interacted with when it comes time to add data to a view.

Constructor

constructor(responseOptions: ResponseOptions)
      
      constructor(responseOptions: ResponseOptions)
    

Parameters

responseOptions

Type: ResponseOptions.

Properties

Property Description
type: ResponseType

One of "basic", "cors", "default", "error", or "opaque".

Defaults to "default".

ok: boolean

True if the response's status is within 200-299

url: string

URL of response.

Defaults to empty string.

status: number

Status code returned by server.

Defaults to 200.

statusText: string | null

Text representing the corresponding reason phrase to the status, as defined in ietf rfc 2616 section 6.1.1

Defaults to "OK"

bytesLoaded: number

Non-standard property

Denotes how many of the response body's bytes have been loaded, for example if the response is the result of a progress event.

totalBytes: number

Non-standard property

Denotes how many bytes are expected in the final response body.

headers: Headers | null

Headers object based on the Headers class in the Fetch Spec.

Methods

toString(): string
      
      toString(): string
    

Parameters

There are no parameters.

Returns

string

Usage notes

Example

http.request('my-friends.txt').subscribe(response => this.friends = response.text());
      
      http.request('my-friends.txt').subscribe(response => this.friends = response.text());
    

The Response's interface is inspired by the Response constructor defined in the Fetch Spec, but is considered a static value whose body can be accessed many times. There are other differences in the implementation, but this is the most significant.