HttpHeaderResponse | @alterior/http

A partial HTTP response which only includes the status and header data, but no response body.

HttpHeaderResponse is a HttpEvent available on the response event stream, only when progress events are requested.

Hierarchy

HttpResponseBase
- HttpHeaderResponse

Index

Constructors

constructor

Properties

Methods

clone

Constructors

constructor

new HttpHeaderResponse(init?: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string }): HttpHeaderResponse

Overrides HttpResponseBase.constructor
- Defined in response.ts:212
Create a new HttpHeaderResponse with the given parameters.

Parameters
- Default value init: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string } = {}
  - Optional headers?: HttpHeaders
  - Optional status?: number
  - Optional statusText?: string
  - Optional url?: string
Returns HttpHeaderResponse

Properties

Readonly headers

headers: HttpHeaders

All response headers.

Readonly ok

ok: boolean

Whether the status code falls in the 2xx range.

Readonly status

status: number

Response status code.

Readonly statusText

statusText: string

Textual description of response status code.

Do not depend on this.

Readonly type

type: ResponseHeader = HttpEventType.ResponseHeader

Readonly url

url: string | null

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

Methods

clone

clone(update?: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string }): HttpHeaderResponse

- Defined in response.ts:231
Copy this HttpHeaderResponse, overriding its contents with the given parameter hash.

Parameters
- Default value update: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string } = {}
  - Optional headers?: HttpHeaders
  - Optional status?: number
  - Optional statusText?: string
  - Optional url?: string
Returns HttpHeaderResponse

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Default value init: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string } = {}

Optional headers?: HttpHeaders

Optional status?: number

Optional statusText?: string

Optional url?: string

Returns HttpHeaderResponse

Properties

Readonly headers

Readonly ok

Readonly status

Readonly statusText

Readonly type

Readonly url

Methods

clone

Parameters

Default value update: { headers?: HttpHeaders; status?: number; statusText?: string; url?: string } = {}

Optional headers?: HttpHeaders

Optional status?: number

Optional statusText?: string

Optional url?: string

Returns HttpHeaderResponse