@angular/common/http

HttpRequest

Class

stable

An outgoing HTTP request with an optional typed body.

API

  
    class HttpRequest<T> {
}

constructor

5 overloads

@parammethod"GET" | "HEAD"

@paramurlstring

@paraminit

{ headers?: HttpHeaders | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; params?: HttpParams | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

@returnsHttpRequest

@parammethod"DELETE" | "JSONP" | "OPTIONS"

@paramurlstring

@paraminit

{ headers?: HttpHeaders | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; params?: HttpParams | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

@returnsHttpRequest

@parammethod"POST"

@paramurlstring

@parambodyT | null

@paraminit

{ headers?: HttpHeaders | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; params?: HttpParams | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

@returnsHttpRequest

@parammethod"PUT" | "PATCH"

@paramurlstring

@parambodyT | null

@paraminit

{ headers?: HttpHeaders | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; params?: HttpParams | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

@returnsHttpRequest

@parammethodstring

@paramurlstring

@parambodyT | null

@paraminit

{ headers?: HttpHeaders | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; params?: HttpParams | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

@returnsHttpRequest

body

T | null

The request body, or null if one isn't set.

Bodies are not enforced to be immutable, as they can include a reference to any user-defined data type. However, interceptors should take care to preserve idempotence by treating them as such.

headers

HttpHeaders

Outgoing headers for this request.

context

HttpContext

Shared and mutable context that can be used by interceptors

reportProgress

boolean

Whether this request should be made in a way that exposes progress events.

Progress events are expensive (change detection runs on each event) and so they should only be requested if the consumer intends to monitor them.

Note: The FetchBackend doesn't support progress report on uploads.

withCredentials

boolean

Whether this request should be sent with outgoing credentials (cookies).

keepalive

boolean

When using the fetch implementation and set to true, the browser will not abort the associated request if the page that initiated it is unloaded before the request is complete.

responseType

"arraybuffer" | "blob" | "text" | "json"

The expected response type of the server.

This is used to parse the response appropriately before returning it to the requestee.

method

string

The outgoing HTTP request method.

params

HttpParams

Outgoing URL parameters.

To pass a string representation of HTTP parameters in the URL-query-string format, the HttpParamsOptions' fromString may be used. For example:

          new HttpParams({fromString: 'angular=awesome'})

urlWithParams

string

The outgoing URL with all URL parameters set.

transferCache

boolean | { includeHeaders?: string[] | undefined; } | undefined

The HttpTransferCache option for the request

serializeBody

string | ArrayBuffer | Blob | FormData | URLSearchParams | null

Transform the free-form body into a serialized format suitable for transmission to the server.

@returnsstring | ArrayBuffer | Blob | FormData | URLSearchParams | null

detectContentTypeHeader

string | null

Examine the body and attempt to infer an appropriate MIME type for it.

If no such type can be inferred, this method will return null.

@returnsstring | null

clone

3 overloads

@returnsHttpRequest<T>

@paramupdate

{ headers?: HttpHeaders | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; params?: HttpParams | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; body?: T | null | undefined; method?: string | undefined; url?: string | undefined; setHeaders?: { [name: string]: string | string[]; } | undefined; setParams?: { [param: string]: string; } | undefined; }

@returnsHttpRequest<T>

@paramupdate

{ headers?: HttpHeaders | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; params?: HttpParams | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; keepalive?: boolean | undefined; withCredentials?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; body?: V | null | undefined; method?: string | undefined; url?: string | undefined; setHeaders?: { [name: string]: string | string[]; } | undefined; setParams?: { [param: string]: string; } | undefined; }

@returnsHttpRequest<V>

Description

An outgoing HTTP request with an optional typed body.

HttpRequest represents an outgoing request, including URL, method, headers, body, and other request configuration options. Instances should be assumed to be immutable. To modify a HttpRequest, the clone method should be used.