Docs4dev
Docs
angular / 13 / api / common / http / httpresponse.html

HttpResponse

class final

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

See more...

class HttpResponse<T> extends HttpResponseBase {
  constructor(init: { body?: T; headers?: HttpHeaders; status?: number; statusText?: string; url?: string; } = {})
  body: T | null
  type: HttpEventType.Response
  clone(update: { body?: any; headers?: HttpHeaders; status?: number; statusText?: string; url?: string; } = {}): HttpResponse<any>

  // inherited from common/http/HttpResponseBase
  constructor(init: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string; }, defaultStatus: number = HttpStatusCode.Ok, defaultStatusText: string = 'OK')
  headers: HttpHeaders
  status: number
  statusText: string
  url: string | null
  ok: boolean
  type: HttpEventType.Response | HttpEventType.ResponseHeader
}

Description

HttpResponse is a HttpEvent available on the response event stream.

Constructor

Construct a new HttpResponse.

This class is "final" and should not be extended. See the public API notes.

constructor(init: { body?: T; headers?: HttpHeaders; status?: number; statusText?: string; url?: string; } = {})

Parameters
init object

Optional. Default is {}.

Properties

Property Description
body: T | null Read-Only

The response body, or null if one was not returned.
type: HttpEventType.Response Read-Only

Methods

clone()

3 overloads...

Show All Hide All
Overload #1

clone(): HttpResponse<T>

Parameters

There are no parameters.

Returns

HttpResponse<T>

Overload #2

clone(update: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string; }): HttpResponse<T>

Parameters
update object
Returns

HttpResponse<T>

Overload #3

clone<V>(update: { body?: V; headers?: HttpHeaders; status?: number; statusText?: string; url?: string; }): HttpResponse<V>

Parameters
update object
Returns

HttpResponse<V>

© 2010–2022 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v13.angular.io/api/common/http/HttpResponse