• Overview
@angular/common/http

HttpClient

Class
stable

Performs HTTP requests. This service is available as an injectable class, with methods to perform HTTP requests. Each request method has multiple signatures, and the return type varies based on the signature that is called (mainly the values of observe and responseType).

API

  
    class HttpClient {
}

constructor

HttpClient
@paramhandlerHttpHandler
@returnsHttpClient

request

17 overloads

Sends an HttpRequest and returns a stream of HttpEvents.

@paramreqHttpRequest<any>
@returnsObservable<HttpEvent<R>>

Constructs a request that interprets the body as an ArrayBuffer and returns the response in an ArrayBuffer.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<ArrayBuffer>

Constructs a request that interprets the body as a blob and returns the response as a blob.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<Blob>

Constructs a request that interprets the body as a text string and returns a string value.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<string>

Constructs a request that interprets the body as an ArrayBuffer and returns the the full event stream.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; observe: "events"; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<ArrayBuffer>>

Constructs a request that interprets the body as a Blob and returns the full event stream.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<Blob>>

Constructs a request which interprets the body as a text string and returns the full event stream.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<string>>

Constructs a request which interprets the body as a JavaScript object and returns the full event stream.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; observe: "events"; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<any>>

Constructs a request which interprets the body as a JavaScript object and returns the full event stream.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; observe: "events"; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<R>>

Constructs a request which interprets the body as an ArrayBuffer and returns the full HttpResponse.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<ArrayBuffer>>

Constructs a request which interprets the body as a Blob and returns the full HttpResponse.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<Blob>>

Constructs a request which interprets the body as a text stream and returns the full HttpResponse.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<string>>

Constructs a request which interprets the body as a JavaScript object and returns the full HttpResponse.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; observe: "response"; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<Object>>

Constructs a request which interprets the body as a JavaScript object and returns the full HttpResponse with the response body in the requested type.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; reportProgress?: boolean | undefined; observe: "response"; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<R>>

Constructs a request which interprets the body as a JavaScript object and returns the full HttpResponse as a JavaScript object.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; responseType?: "json" | undefined; reportProgress?: boolean | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

The HTTP options to send with the request.

@returnsObservable<Object>

Constructs a request which interprets the body as a JavaScript object with the response body of the requested type.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; responseType?: "json" | undefined; reportProgress?: boolean | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

The HTTP options to send with the request.

@returnsObservable<R>

Constructs a request where response type and requested observable are not known statically.

@parammethodstring

The HTTP method.

@paramurlstring

The endpoint URL.

@paramoptions{ body?: any; headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; observe?: "body" | "events" | "response" | undefined; reportProgress?: boolean | undefined; responseType?: "arraybuffer" | "blob" | "text" | "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

The HTTP options to send with the request.

@returnsObservable<any>

delete

15 overloads

Constructs a DELETE request that interprets the body as an ArrayBuffer and returns the response as an ArrayBuffer.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<ArrayBuffer>

Constructs a DELETE request that interprets the body as a Blob and returns the response as a Blob.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<Blob>

Constructs a DELETE request that interprets the body as a text string and returns a string.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<string>

Constructs a DELETE request that interprets the body as an ArrayBuffer and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<ArrayBuffer>>

Constructs a DELETE request that interprets the body as a Blob and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<Blob>>

Constructs a DELETE request that interprets the body as a text string and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<string>>

Constructs a DELETE request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<Object>>

Constructs a DELETErequest that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<T>>

Constructs a DELETE request that interprets the body as an ArrayBuffer and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<ArrayBuffer>>

Constructs a DELETE request that interprets the body as a Blob and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<Blob>>

Constructs a DELETE request that interprets the body as a text stream and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<string>>

Constructs a DELETE request the interprets the body as a JavaScript object and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<Object>>

Constructs a DELETE request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<T>>

Constructs a DELETE request that interprets the body as JSON and returns the response body as an object parsed from JSON.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; } | undefined

The HTTP options to send with the request.

@returnsObservable<Object>

Constructs a DELETE request that interprets the body as JSON and returns the response in a given type.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; body?: any; } | undefined

The HTTP options to send with the request.

@returnsObservable<T>

get

15 overloads

Constructs a GET request that interprets the body as an ArrayBuffer and returns the response in an ArrayBuffer.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<ArrayBuffer>

Constructs a GET request that interprets the body as a Blob and returns the response as a Blob.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<Blob>

Constructs a GET request that interprets the body as a text string and returns the response as a string value.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<string>

Constructs a GET request that interprets the body as an ArrayBuffer and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<ArrayBuffer>>

Constructs a GET request that interprets the body as a Blob and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<Blob>>

Constructs a GET request that interprets the body as a text string and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<string>>

Constructs a GET request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<Object>>

Constructs a GET request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpEvent<T>>

Constructs a GET request that interprets the body as an ArrayBuffer and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<ArrayBuffer>>

Constructs a GET request that interprets the body as a Blob and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<Blob>>

Constructs a GET request that interprets the body as a text stream and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<string>>

Constructs a GET request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<Object>>

Constructs a GET request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

The HTTP options to send with the request.

@returnsObservable<HttpResponse<T>>

Constructs a GET request that interprets the body as JSON and returns the response body as an object parsed from JSON.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

The HTTP options to send with the request.

@returnsObservable<Object>

Constructs a GET request that interprets the body as JSON and returns the response body in a given type.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

The HTTP options to send with the request.

@returnsObservable<T>

jsonp

2 overloads

Constructs a JSONP request for the given URL and name of the callback parameter.

@paramurlstring

The resource URL.

@paramcallbackParamstring

The callback function name.

@returnsObservable<Object>

Constructs a JSONP request for the given URL and name of the callback parameter.

@paramurlstring

The resource URL.

@paramcallbackParamstring

The callback function name.

You must install a suitable interceptor, such as one provided by HttpClientJsonpModule. If no such interceptor is reached, then the JSONP request can be rejected by the configured backend.

@returnsObservable<T>

options

15 overloads

Constructs an OPTIONS request that interprets the body as an ArrayBuffer and returns the response as an ArrayBuffer.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<ArrayBuffer>

Constructs an OPTIONS request that interprets the body as a Blob and returns the response as a Blob.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<Blob>

Constructs an OPTIONS request that interprets the body as a text string and returns a string value.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<string>

Constructs an OPTIONS request that interprets the body as an ArrayBuffer and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<ArrayBuffer>>

Constructs an OPTIONS request that interprets the body as a Blob and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<Blob>>

Constructs an OPTIONS request that interprets the body as a text string and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<string>>

Constructs an OPTIONS request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<Object>>

Constructs an OPTIONS request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<T>>

Constructs an OPTIONS request that interprets the body as an ArrayBuffer and returns the full HTTP response.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<ArrayBuffer>>

Constructs an OPTIONS request that interprets the body as a Blob and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<Blob>>

Constructs an OPTIONS request that interprets the body as text stream and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<string>>

Constructs an OPTIONS request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<Object>>

Constructs an OPTIONS request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<T>>

Constructs an OPTIONS request that interprets the body as JSON and returns the response body as an object parsed from JSON.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

HTTP options.

@returnsObservable<Object>

Constructs an OPTIONS request that interprets the body as JSON and returns the response in a given type.

@paramurlstring

The endpoint URL.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

HTTP options.

@returnsObservable<T>

patch

15 overloads

Constructs a PATCH request that interprets the body as an ArrayBuffer and returns the response as an ArrayBuffer.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<ArrayBuffer>

Constructs a PATCH request that interprets the body as a Blob and returns the response as a Blob.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<Blob>

Constructs a PATCH request that interprets the body as a text string and returns the response as a string value.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<string>

Constructs a PATCH request that interprets the body as an ArrayBuffer and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<ArrayBuffer>>

Constructs a PATCH request that interprets the body as a Blob and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<Blob>>

Constructs a PATCH request that interprets the body as a text string and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<string>>

Constructs a PATCH request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<Object>>

Constructs a PATCH request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpEvent<T>>

Constructs a PATCH request that interprets the body as an ArrayBuffer and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<ArrayBuffer>>

Constructs a PATCH request that interprets the body as a Blob and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<Blob>>

Constructs a PATCH request that interprets the body as a text stream and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<string>>

Constructs a PATCH request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<Object>>

Constructs a PATCH request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options.

@returnsObservable<HttpResponse<T>>

Constructs a PATCH request that interprets the body as JSON and returns the response body as an object parsed from JSON.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

HTTP options.

@returnsObservable<Object>

Constructs a PATCH request that interprets the body as JSON and returns the response in a given type.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to edit.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

HTTP options.

@returnsObservable<T>

post

15 overloads

Constructs a POST request that interprets the body as an ArrayBuffer and returns an ArrayBuffer.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options.

@returnsObservable<ArrayBuffer>

Constructs a POST request that interprets the body as a Blob and returns the response as a Blob.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<Blob>

Constructs a POST request that interprets the body as a text string and returns the response as a string value.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<string>

Constructs a POST request that interprets the body as an ArrayBuffer and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpEvent<ArrayBuffer>>

Constructs a POST request that interprets the body as a Blob and returns the response in an observable of the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpEvent<Blob>>

Constructs a POST request that interprets the body as a text string and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpEvent<string>>

Constructs a POST request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpEvent<Object>>

Constructs a POST request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpEvent<T>>

Constructs a POST request that interprets the body as an ArrayBuffer and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpResponse<ArrayBuffer>>

Constructs a POST request that interprets the body as a Blob and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpResponse<Blob>>

Constructs a POST request that interprets the body as a text stream and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpResponse<string>>

Constructs a POST request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpResponse<Object>>

Constructs a POST request that interprets the body as JSON and returns the full HttpResponse.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; }

HTTP options

@returnsObservable<HttpResponse<T>>

Constructs a POST request that interprets the body as JSON and returns the response body as an object parsed from JSON.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

HTTP options

@returnsObservable<Object>

Constructs a POST request that interprets the body as JSON and returns an observable of the response.

@paramurlstring

The endpoint URL.

@parambodyany

The content to replace with.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; transferCache?: boolean | { includeHeaders?: string[] | undefined; } | undefined; } | undefined

HTTP options

@returnsObservable<T>

put

15 overloads

Constructs a PUT request that interprets the body as an ArrayBuffer and returns the response as an ArrayBuffer.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<ArrayBuffer>

Constructs a PUT request that interprets the body as a Blob and returns the response as a Blob.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<Blob>

Constructs a PUT request that interprets the body as a text string and returns the response as a string value.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<string>

Constructs a PUT request that interprets the body as an ArrayBuffer and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpEvent<ArrayBuffer>>

Constructs a PUT request that interprets the body as a Blob and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpEvent<Blob>>

Constructs a PUT request that interprets the body as a text string and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpEvent<string>>

Constructs a PUT request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpEvent<Object>>

Constructs a PUT request that interprets the body as JSON and returns the full event stream.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "events"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpEvent<T>>

Constructs a PUT request that interprets the body as an ArrayBuffer and returns an observable of the full HTTP response.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "arraybuffer"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpResponse<ArrayBuffer>>

Constructs a PUT request that interprets the body as a Blob and returns the full HTTP response.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "blob"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpResponse<Blob>>

Constructs a PUT request that interprets the body as a text stream and returns the full HTTP response.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType: "text"; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpResponse<string>>

Constructs a PUT request that interprets the body as JSON and returns the full HTTP response.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpResponse<Object>>

Constructs a PUT request that interprets the body as an instance of the requested type and returns the full HTTP response.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; observe: "response"; context?: HttpContext | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; }

HTTP options

@returnsObservable<HttpResponse<T>>

Constructs a PUT request that interprets the body as JSON and returns an observable of JavaScript object.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

HTTP options

@returnsObservable<Object>

Constructs a PUT request that interprets the body as an instance of the requested type and returns an observable of the requested type.

@paramurlstring

The endpoint URL.

@parambodyany

The resources to add/update.

@paramoptions{ headers?: HttpHeaders | Record<string, string | string[]> | undefined; context?: HttpContext | undefined; observe?: "body" | undefined; params?: HttpParams | Record<string, string | number | boolean | readonly (string | number | boolean)[]> | undefined; reportProgress?: boolean | undefined; responseType?: "json" | undefined; withCredentials?: boolean | undefined; keepalive?: boolean | undefined; } | undefined

HTTP options

@returnsObservable<T>

Description

Performs HTTP requests. This service is available as an injectable class, with methods to perform HTTP requests. Each request method has multiple signatures, and the return type varies based on the signature that is called (mainly the values of observe and responseType).

Note that the responseType options value is a String that identifies the single data type of the response. A single overload version of the method handles each response type. The value of responseType cannot be a union, as the combined signature could imply.

Usage Notes

HTTP Request Example 

 // GET heroes whose name contains search termsearchHeroes(term: string): observable<Hero[]>{ const params = new HttpParams({fromString: 'name=term'});   return this.httpClient.request('GET', this.heroesUrl, {responseType:'json', params});}

Alternatively, the parameter string can be used without invoking HttpParams by directly joining to the URL.

this.httpClient.request('GET', this.heroesUrl + '?' + 'name=term', {responseType:'json'});

JSONP Example 

requestJsonp(url, callback = 'callback') { return this.httpClient.jsonp(this.heroesURL, callback);}

PATCH Example 

// PATCH one of the heroes' namepatchHero (id: number, heroName: string): Observable<{}> {const url = `${this.heroesUrl}/${id}`;   // PATCH api/heroes/42 return this.httpClient.patch(url, {name: heroName}, httpOptions)   .pipe(catchError(this.handleError('patchHero')));}
Jump to details