5 lines
363 KiB
JSON
5 lines
363 KiB
JSON
{
|
|
"id": "api/common/http/HttpClient",
|
|
"title": "HttpClient",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/common\", \"name\": \"@angular/common\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/common/http\", \"name\": \"@angular/common/http\" } },\n { \"@type\": \"ListItem\", \"position\": 4, \"item\": { \"@id\": \"https://angular.io/api/common/http/HttpClient\", \"name\": \"HttpClient\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a> > <a href=\"api/common/http\">@angular/common/http</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L54-L2873\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L54-L2873\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"httpclient\">HttpClient<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#httpclient\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Performs HTTP requests.\nThis service is available as an injectable class, with methods to perform HTTP requests.\nEach request method has multiple signatures, and the return type varies based on\nthe signature that is called (mainly the values of <code>observe</code> and <code>responseType</code>).</p>\n\n <p><a href=\"api/common/http/HttpClient#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/common/http/HttpClient\" class=\"code-anchor\">HttpClient</a> {\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#request\"><span class=\"member-name\">request</span>(first: string | HttpRequest<any>, url?: string, options: { body?: any; headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#delete\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#get\"><span class=\"member-name\">get</span>(url: string, options: { headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#head\"><span class=\"member-name\">head</span>(url: string, options: { headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#jsonp\"><span class=\"member-name\">jsonp</span><T>(url: string, callbackParam: string): Observable<T></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#options\"><span class=\"member-name\">options</span>(url: string, options: { headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#patch\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#post\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpClient#put\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: HttpHeaders | { [header: string]: string | string[]; }; context?: HttpContext; observe?: \"body\" | \"events\" | \"response\"; params?: HttpParams | { ...; }; reportProgress?: boolean; responseType?: \"arraybuffer\" | ... 2 more ... | \"json\"; withCredentials?: boolean; } = {}): Observable<any></a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n<section class=\"see-also\">\n <h2 id=\"see-also\">See also<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><p><a href=\"guide/http\">HTTP Guide</a></p>\n</li>\n <li><p><a href=\"api/common/http/HttpRequest\">HTTP Request</a></p>\n</li>\n </ul>\n</section>\n\n\n \n \n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>Note that the <code>responseType</code> <em>options</em> value is a String that identifies the\nsingle data type of the response.\nA single overload version of the method handles each response type.\nThe value of <code>responseType</code> cannot be a union, as the combined signature could imply.</p>\n\n <p>Further information available in the <a href=\"api/common/http/HttpClient#usage-notes\">Usage Notes</a>...</p>\n</section>\n\n \n\n\n\n\n\n\n\n\n\n\n\n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"request\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"request\">\n request()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#request\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L459-L603\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L459-L603\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an observable for a generic HTTP request that, when subscribed,\nfires the request through the chain of registered interceptors and on to the\nserver.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"17-overloads\">17 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Sends an <code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a></code> and returns a stream of <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span><R>(req: <a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a><any>): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><R>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>req</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a><any></any></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><R>></code>: An <code>Observable</code> of the response, with the response body as a stream of <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request that interprets the body as an <code>ArrayBuffer</code> and returns the response in\nan <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boo...): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>{ body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boo...</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request that interprets the body as a blob and returns\nthe response as a blob.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response, with the response body of type <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request that interprets the body as a text string and\nreturns a string value.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-3\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-3\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request that interprets the body as an <code>ArrayBuffer</code> and returns the\nthe full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; observe: \"events\"; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: bo...): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-4\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>{ body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; observe: \"events\"; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: bo...</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-4\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of the response, with the response body as an array of <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for\nthe request.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request that interprets the body as a <code>Blob</code> and returns\nthe full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-5\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-5\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body of type <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a text string and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-6\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-6\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a JSON object and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; observe: \"events\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { ...; }; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><any>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-7\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-7\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><any>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a JSON object and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span><R>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; observe: \"events\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { ...; }; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><R>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-8\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-8\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><R>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body of type <code>R</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as an <code>ArrayBuffer</code>\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: ...): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-9\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>{ body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: ...</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-9\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a <code>Blob</code> and returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean...): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-10\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>{ body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean...</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-10\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of type <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a text stream and returns the full\n<code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean...): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-11\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>{ body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean...</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-11\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the HTTP response, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a JSON object and returns the full\n<code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; observe: \"response\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { ...; }; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-12\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-12\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>,\nwith the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a JSON object and returns\nthe full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> with the response body in the requested type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span><R>(method: string, url: string, options: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; observe: \"response\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { ...; }; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><R>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-13\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-13\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><R>></code>: An <code>Observable</code> of the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of type <code>R</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a JSON object and returns the full\n<code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> as a JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options?: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; responseType?: \"json\"; reportProgress?: boolean; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-14\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-14\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-16\">Overload #16</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request which interprets the body as a JSON object\nwith the response body of the requested type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span><R>(method: string, url: string, options?: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; responseType?: \"json\"; reportProgress?: boolean; withCredentials?: boolean; }): Observable<R></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-15\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-15\">Returns</h6>\n <p><code>Observable<R></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of type <code>R</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-17\">Overload #17</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a request where response type and requested observable are not known statically.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">request</span>(method: string, url: string, options?: { body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; observe?: \"body\" | ... 1 more ... | \"response\"; reportProgress?: boolean; responseType?: \"arra...): Observable<any></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-16\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The HTTP method.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>{ body?: any; headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; observe?: \"body\" | ... 1 more ... | \"response\"; reportProgress?: boolean; responseType?: \"arra...</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-16\">Returns</h6>\n <p><code>Observable<any></code>: An <code>Observable</code> of the reuested response, wuth body of type <code>any</code>.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n <tr>\n <td class=\"description\">\n <p>You can pass an <code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a></code> directly as the only parameter. In this case,\nthe call returns an observable of the raw <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code> stream.</p>\n<p>Alternatively you can pass an HTTP method as the first parameter,\na URL string as the second, and an options hash containing the request body as the third.\nSee <code>addBody()</code>. In this case, the specified <code>responseType</code> and <code>observe</code> options determine the\ntype of returned observable.</p>\n<ul>\n<li>The <code>responseType</code> value determines how a successful response body is parsed.</li>\n<li>If <code>responseType</code> is the default <code><a href=\"api/common/JsonPipe\" class=\"code-anchor\">json</a></code>, you can pass a type interface for the resulting\nobject as a type parameter to the call.</li>\n</ul>\n<p>The <code>observe</code> value determines the return type, according to what you are interested in\nobserving.</p>\n<ul>\n<li>An <code>observe</code> value of events returns an observable of the raw <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code> stream, including\nprogress events by default.</li>\n<li>An <code>observe</code> value of response returns an observable of <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse<T></a></code>,\nwhere the <code>T</code> parameter depends on the <code>responseType</code> and any optionally provided type\nparameter.</li>\n<li>An <code>observe</code> value of body returns an observable of <code><T></code> with the same <code>T</code> body type.</li>\n</ul>\n\n </td>\n </tr>\n\n \n </tbody>\n</table>\n\n \n <a id=\"delete\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"delete\">\n delete()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#delete\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L892-L913\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L892-L913\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an observable that, when subscribed, causes the configured\n<code>DELETE</code> request to execute on the server. See the individual overloads for\ndetails on the return type.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"15-overloads\">15 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1-1\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as an <code>ArrayBuffer</code>\nand returns the response as an <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-17\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-17\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2-1\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a <code>Blob</code> and returns\nthe response as a <code>Blob</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-18\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-18\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3-1\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a text string and returns\na string.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-19\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-19\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4-1\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as an <code>ArrayBuffer</code>\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-20\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-20\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5-1\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a <code>Blob</code>\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-21\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-21\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with the response body as a\n<code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6-1\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a text string\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-22\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-22\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with the response\nbody of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7-1\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a JSON object\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-23\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-23\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with response body of\ntype <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8-1\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code>request that interprets the body as a JSON object\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-24\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-24\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with a response\nbody in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9-1\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as an <code>ArrayBuffer</code> and returns\nthe full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-25\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-25\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10-1\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a <code>Blob</code> and returns the full\n<code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-26\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-26\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of type <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11-1\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a text stream and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-27\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-27\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12-1\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request the interprets the body as a JSON object and returns\nthe full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-28\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-28\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13-1\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a JSON object\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-29\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-29\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with the response body of the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14-1\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>DELETE</code> request that interprets the body as a JSON object and\nreturns the response body as a JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-30\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-30\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response, with the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15-1\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a DELETE request that interprets the body as a JSON object and returns\nthe response in a given type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">delete</span><T>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-31\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-31\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"get\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"get\">\n get()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#get\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1203-L1220\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1203-L1220\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an observable that, when subscribed, causes the configured\n<code>GET</code> request to execute on the server. See the individual overloads for\ndetails on the return type.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"15-overloads-1\">15 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1-2\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as an <code>ArrayBuffer</code> and returns the\nresponse in an <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-32\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-32\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2-2\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a <code>Blob</code>\nand returns the response as a <code>Blob</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-33\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-33\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response, with the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3-2\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a text string\nand returns the response as a string value.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-34\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-34\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4-2\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as an <code>ArrayBuffer</code> and returns\nthe full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-35\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-35\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with the response\nbody as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5-2\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a <code>Blob</code> and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-36\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-36\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of the response, with the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6-2\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a text string and returns\nthe full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-37\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-37\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of the response, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7-2\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a JSON object\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-38\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-38\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code>: An <code>Observable</code> of the response, with the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8-2\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a JSON object and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-39\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-39\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code>: An <code>Observable</code> of the response, with a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9-2\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as an <code>ArrayBuffer</code> and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-40\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-40\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10-2\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a <code>Blob</code> and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-41\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-41\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11-2\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a text stream and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-42\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-42\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12-2\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a JSON object and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-43\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-43\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>,\nwith the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13-2\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a JSON object and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-44\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-44\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code>: An <code>Observable</code> of the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14-2\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a JSON object and\nreturns the response body as a JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-45\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-45\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response body as a JSON object.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15-2\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>GET</code> request that interprets the body as a JSON object and returns\nthe response body in a given type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">get</span><T>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-46\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-46\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"head\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"head\">\n head()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#head\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1515-L1534\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1515-L1534\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an observable that, when subscribed, causes the configured\n<code>HEAD</code> request to execute on the server. The <code>HEAD</code> method returns\nmeta information about the resource without transferring the\nresource itself. See the individual overloads for\ndetails on the return type.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"15-overloads-2\">15 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1-3\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as an <code>ArrayBuffer</code> and\nreturns the response as an <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-47\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-47\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2-3\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a <code>Blob</code> and returns\nthe response as a <code>Blob</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-48\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-48\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response, with the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3-3\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a text string and returns the response\nas a string value.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-49\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-49\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4-3\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as an <code>ArrayBuffer</code>\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-50\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-50\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5-3\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a <code>Blob</code> and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-51\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-51\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6-3\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a text string\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-52\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-52\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with the response body of type\nstring.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7-3\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a JSON object\nand returns the full HTTP event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-53\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-53\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with a response body of\ntype <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8-3\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a JSON object and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-54\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-54\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9-3\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as an <code>ArrayBuffer</code>\nand returns the full HTTP response.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-55\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-55\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10-3\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a <code>Blob</code> and returns\nthe full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-56\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-56\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as a blob.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11-3\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as text stream\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-57\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-57\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12-3\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a JSON object and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-58\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-58\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13-3\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a JSON object\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-59\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-59\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a responmse body of the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14-3\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a JSON object and\nreturns the response body as a JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-60\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-60\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response, with the response body as a JSON object.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15-3\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>HEAD</code> request that interprets the body as a JSON object and returns\nthe response in a given type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">head</span><T>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-61\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The HTTP options to send with the request.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-61\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body of the given type.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"jsonp\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"jsonp\">\n jsonp()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#jsonp\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1559-L1584\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1559-L1584\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an <code>Observable</code> that, when subscribed, causes a request with the special method\n<code>JSONP</code> to be dispatched via the interceptor pipeline.\nThe <a href=\"https://en.wikipedia.org/wiki/JSONP\">JSONP pattern</a> works around limitations of certain\nAPI endpoints that don't support newer,\nand preferable <a href=\"https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS\">CORS</a> protocol.\nJSONP treats the endpoint API as a JavaScript file and tricks the browser to process the\nrequests even if the API endpoint is not located on the same domain (origin) as the client-side\napplication making the request.\nThe endpoint API must support JSONP callback for JSONP requests to work.\nThe resource API returns the JSON response wrapped in a callback function.\nYou can pass the callback function name as one of the query parameters.\nNote that JSONP requests can only be used with <code>GET</code> requests.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>JSONP</code> request for the given URL and name of the callback parameter.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">jsonp</span>(url: string, callbackParam: string): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-62\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The resource URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>callbackParam</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The callback function name.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-62\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response object, with response body as an object.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n <tr>\n <td>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>JSONP</code> request for the given URL and name of the callback parameter.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">jsonp</span><T>(url: string, callbackParam: string): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-63\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The resource URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>callbackParam</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The callback function name.</p>\n<p>You must install a suitable interceptor, such as one provided by <code><a href=\"api/common/http/HttpClientJsonpModule\" class=\"code-anchor\">HttpClientJsonpModule</a></code>.\nIf no such interceptor is reached,\nthen the <code>JSONP</code> request can be rejected by the configured backend.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-63\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the response object, with response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"options\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"options\">\n options()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#options\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1876-L1895\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1876-L1895\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an <code>Observable</code> that, when subscribed, causes the configured\n<code>OPTIONS</code> request to execute on the server. This method allows the client\nto determine the supported HTTP methods and other capabilites of an endpoint,\nwithout implying a resource action. See the individual overloads for\ndetails on the return type.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"15-overloads-3\">15 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1-4\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as an\n<code>ArrayBuffer</code> and returns the response as an <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-64\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-64\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2-4\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a <code>Blob</code> and returns\nthe response as a <code>Blob</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-65\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-65\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response, with the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3-4\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a text string and\nreturns a string value.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-66\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-66\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4-4\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as an <code>ArrayBuffer</code>\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-67\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-67\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5-4\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a <code>Blob</code> and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-68\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-68\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6-4\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a text string\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-69\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-69\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7-4\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a JSON object\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-70\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-70\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request with the response\nbody of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8-4\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a JSON object and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-71\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-71\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9-4\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as an <code>ArrayBuffer</code>\nand returns the full HTTP response.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-72\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-72\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10-4\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a <code>Blob</code>\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-73\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-73\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11-4\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as text stream\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-74\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-74\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12-4\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a JSON object\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-75\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-75\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13-4\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a JSON object and\nreturns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span><T>(url: string, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-76\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-76\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14-4\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a JSON object and returns the\nresponse body as a JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-77\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-77\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response, with the response body as a JSON object.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15-4\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs an <code>OPTIONS</code> request that interprets the body as a JSON object and returns the\nresponse in a given type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">options</span><T>(url: string, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-78\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-78\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>, with a response body of the given type.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"patch\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"patch\">\n patch()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#patch\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L2204-L2221\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L2204-L2221\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an observable that, when subscribed, causes the configured\n<code>PATCH</code> request to execute on the server. See the individual overloads for\ndetails on the return type.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"15-overloads-4\">15 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1-5\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as an <code>ArrayBuffer</code> and returns\nthe response as an <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-79\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-79\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2-5\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a <code>Blob</code> and returns the response\nas a <code>Blob</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-80\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-80\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response, with the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3-5\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a text string and\nreturns the response as a string value.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-81\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-81\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with a response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4-5\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as an <code>ArrayBuffer</code> and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-82\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-82\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5-5\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a <code>Blob</code>\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-83\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-83\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with the\nresponse body as <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6-5\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a text string and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-84\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-84\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with a\nresponse body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7-5\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a JSON object\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-85\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-85\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8-5\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a JSON object\nand returns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span><T>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-86\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-86\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code>: An <code>Observable</code> of all the <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9-5\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as an <code>ArrayBuffer</code>\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-87\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-87\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10-5\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a <code>Blob</code> and returns the full\n<code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-88\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-88\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11-5\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a text stream and returns the\nfull <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-89\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-89\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12-5\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a JSON object\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-90\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-90\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13-5\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a JSON object\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span><T>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-91\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-91\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body in the given type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14-5\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a JSON object and\nreturns the response body as a JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span>(url: string, body: any, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-92\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-92\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response, with the response body as a JSON object.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15-5\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PATCH</code> request that interprets the body as a JSON object\nand returns the response in a given type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">patch</span><T>(url: string, body: any, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-93\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to edit.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-93\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body in the given type.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"post\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"post\">\n post()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#post\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L2529-L2547\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L2529-L2547\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an observable that, when subscribed, causes the configured\n<code>POST</code> request to execute on the server. The server responds with the location of\nthe replaced resource. See the individual overloads for\ndetails on the return type.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"15-overloads-5\">15 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1-6\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as an <code>ArrayBuffer</code> and returns\nan <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-94\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-94\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2-6\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a <code>Blob</code> and returns the\nresponse as a <code>Blob</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-95\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-95\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response, with the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3-6\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a text string and\nreturns the response as a string value.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-96\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-96\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with a response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4-6\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as an <code>ArrayBuffer</code> and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-97\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-97\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5-6\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a <code>Blob</code>\nand returns the response in an observable of the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-98\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-98\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with the response body as <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6-6\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a text string and returns the full\nevent stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-99\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-99\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7-6\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a POST request that interprets the body as a JSON object and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-100\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-100\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body of type <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8-6\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a POST request that interprets the body as a JSON object and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span><T>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-101\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-101\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9-6\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a POST request that interprets the body as an <code>ArrayBuffer</code>\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-102\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-102\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request, with the response body as an\n<code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10-6\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a <code>Blob</code> and returns the full\n<code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-103\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-103\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11-6\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a text stream and returns\nthe full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-104\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-104\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12-6\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a JSON object\nand returns the full <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-105\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-105\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request, with a response body of type\n<code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13-6\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a JSON object and returns the full\n<code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span><T>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-106\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-106\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request, with a response body in the\nrequested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14-6\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a\nJSON object and returns the response body as a JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span>(url: string, body: any, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-107\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-107\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response, with the response body as a JSON object.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15-6\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>POST</code> request that interprets the body as a JSON object\nand returns an observable of the response.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">post</span><T>(url: string, body: any, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-108\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The content to replace with.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-108\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request, with a response body in the\nrequested type.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"put\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"put\">\n put()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#put\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L2854-L2872\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L2854-L2872\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Constructs an observable that, when subscribed, causes the configured\n<code>PUT</code> request to execute on the server. The <code>PUT</code> method replaces an existing resource\nwith a new set of values.\nSee the individual overloads for details on the return type.</p>\n\n </td>\n </tr>\n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"15-overloads-6\">15 overloads...</h4>\n <span class=\"actions\">\n <span class=\"show-all\">Show All</span>\n <span class=\"collapse-all\">Hide All</span>\n <i class=\"material-icons expand\">expand_more</i>\n </span>\n </div>\n </summary>\n <div class=\"detail-contents\">\n \n \n <h5 class=\"no-anchor\" id=\"overload-1-7\">Overload #1</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as an <code>ArrayBuffer</code> and returns the\nresponse as an <code>ArrayBuffer</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<ArrayBuffer></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-109\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-109\">Returns</h6>\n <p><code>Observable<ArrayBuffer></code>: An <code>Observable</code> of the response, with the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-2-7\">Overload #2</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a <code>Blob</code> and returns\nthe response as a <code>Blob</code>.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<Blob></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-110\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-110\">Returns</h6>\n <p><code>Observable<Blob></code>: An <code>Observable</code> of the response, with the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-3-7\">Overload #3</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a text string and\nreturns the response as a string value.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<string></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-111\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-111\">Returns</h6>\n <p><code>Observable<string></code>: An <code>Observable</code> of the response, with a response body of type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-4-7\">Overload #4</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as an <code>ArrayBuffer</code> and\nreturns the full event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-112\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-112\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><ArrayBuffer>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as an <code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-5-7\">Overload #5</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a <code>Blob</code> and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-113\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-113\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Blob>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-6-7\">Overload #6</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a text string and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-114\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-114\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><string>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with a response body\nof type string.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-7-7\">Overload #7</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a JSON object and returns the full event\nstream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-115\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-115\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><Object>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request, with a response body of\ntype <code>Object</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-8-7\">Overload #8</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a JSON object and returns the\nfull event stream.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span><T>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"events\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-116\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-116\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a><T>></code>: An <code>Observable</code> of all <code><a href=\"api/common/http/HttpEvent\" class=\"code-anchor\">HttpEvent</a></code>s for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-9-7\">Overload #9</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as an\n<code>ArrayBuffer</code> and returns an observable of the full HTTP response.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"arraybuffer\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-117\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-117\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><ArrayBuffer>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request, with the response body as an\n<code>ArrayBuffer</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-10-7\">Overload #10</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a <code>Blob</code> and returns the\nfull HTTP response.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"blob\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-118\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-118\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Blob>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith the response body as a <code>Blob</code>.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-11-7\">Overload #11</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a text stream and returns the\nfull HTTP response.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType: \"text\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-119\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-119\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><string>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request, with a response body of type\nstring.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-12-7\">Overload #12</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a JSON object and returns the full HTTP\nresponse.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-120\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-120\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><Object>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request, with a response body\nof type 'Object`.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-13-7\">Overload #13</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as an instance of the requested type and\nreturns the full HTTP response.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span><T>(url: string, body: any, options: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; observe: \"response\"; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-121\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-121\">Returns</h6>\n <p><code>Observable<<a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a><T>></code>: An <code>Observable</code> of the <code><a href=\"api/common/http/HttpResponse\" class=\"code-anchor\">HttpResponse</a></code> for the request,\nwith a response body in the requested type.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-14-7\">Overload #14</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as a JSON object\nand returns an observable of JSON object.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span>(url: string, body: any, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<Object></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-122\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-122\">Returns</h6>\n <p><code>Observable<Object></code>: An <code>Observable</code> of the response as a JSON object.</p>\n\n \n\n\n \n\n \n</div>\n <hr class=\"hr-margin\">\n \n <h5 class=\"no-anchor\" id=\"overload-15-7\">Overload #15</h5>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Constructs a <code>PUT</code> request that interprets the body as an instance of the requested type\nand returns an observable of the requested type.</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">put</span><T>(url: string, body: any, options?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a> | { [header: string]: string | string[]; }; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; observe?: \"body\"; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a> | { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | ... 1 more ... | boolean)[]; }; reportProgress?: boolean; responseType?: \"json\"; withCredentials?: boolean; }): Observable<T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-123\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The endpoint URL.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>The resources to add/update.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>options</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>HTTP options</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-123\">Returns</h6>\n <p><code>Observable<T></code>: An <code>Observable</code> of the requested type.</p>\n\n \n\n\n \n\n \n</div>\n \n \n </div>\n </details>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n\n \n<section class=\"usage-notes\">\n <h2 id=\"usage-notes\">Usage notes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#usage-notes\"><i class=\"material-icons\">link</i></a></h2>\n <p>Sample HTTP requests for the <a href=\"/tutorial/toh-pt0\">Tour of Heroes</a> application.</p>\n<h3 id=\"http-request-example\">HTTP Request Example<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#http-request-example\"><i class=\"material-icons\">link</i></a></h3>\n<code-example>\n // GET heroes whose name contains search term\nsearchHeroes(term: string): observable<Hero[]>{\n\n const params = new <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a>({fromString: 'name=term'});\n return this.httpClient.request('GET', this.heroesUrl, {responseType:'json', params});\n}\n</code-example>\n<p>Alternatively, the parameter string can be used without invoking HttpParams\nby directly joining to the URL.</p>\n<code-example>\nthis.httpClient.request('GET', this.heroesUrl + '?' + 'name=term', {responseType:'json'});\n</code-example>\n<h3 id=\"jsonp-example\">JSONP Example<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#jsonp-example\"><i class=\"material-icons\">link</i></a></h3>\n<code-example>\nrequestJsonp(url, callback = 'callback') {\n return this.httpClient.jsonp(this.heroesURL, callback);\n}\n</code-example>\n<h3 id=\"patch-example\">PATCH Example<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpClient#patch-example\"><i class=\"material-icons\">link</i></a></h3>\n<code-example>\n// PATCH one of the heroes' name\npatchHero (id: number, heroName: string): Observable<{}> {\nconst url = `${this.heroesUrl}/${id}`; // PATCH api/heroes/42\n return this.httpClient.patch(url, {name: heroName}, httpOptions)\n .pipe(catchError(this.handleError('patchHero')));\n}\n</code-example>\n\n</section>\n\n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/common/http\n - api/common/http/HttpBackend\n - api/common/http/HttpClientJsonpModule\n - api/common/http/HttpClientModule\n - api/common/http/testing\n - api/common/http/testing/HttpClientTestingModule\n - api/core/APP_INITIALIZER\n - guide/architecture-next-steps\n - guide/architecture-services\n - guide/example-apps-list\n - guide/http\n - guide/observables-in-angular\n - guide/pipes\n - guide/schematics-for-libraries\n - guide/security\n - guide/styleguide\n - guide/testing-components-scenarios\n - guide/testing-services\n - guide/universal\n - guide/upgrade\n - guide/zone\n - start/start-data\n - tutorial/toh-pt4\n - tutorial/toh-pt6\n-->\n<!-- links from this doc:\n - /api\n - /tutorial/toh-pt0\n - api/common\n - api/common/DecimalPipe\n - api/common/JsonPipe\n - api/common/http\n - api/common/http/HttpClient#delete\n - api/common/http/HttpClient#description\n - api/common/http/HttpClient#get\n - api/common/http/HttpClient#head\n - api/common/http/HttpClient#http-request-example\n - api/common/http/HttpClient#httpclient\n - api/common/http/HttpClient#jsonp\n - api/common/http/HttpClient#jsonp-example\n - api/common/http/HttpClient#methods\n - api/common/http/HttpClient#options\n - api/common/http/HttpClient#patch\n - api/common/http/HttpClient#patch-example\n - api/common/http/HttpClient#post\n - api/common/http/HttpClient#put\n - api/common/http/HttpClient#request\n - api/common/http/HttpClient#see-also\n - api/common/http/HttpClient#usage-notes\n - api/common/http/HttpClientJsonpModule\n - api/common/http/HttpContext\n - api/common/http/HttpEvent\n - api/common/http/HttpHeaders\n - api/common/http/HttpParams\n - api/common/http/HttpRequest\n - api/common/http/HttpResponse\n - guide/http\n - https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS\n - https://en.wikipedia.org/wiki/JSONP\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1203-L1220\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1515-L1534\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1559-L1584\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L1876-L1895\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L2204-L2221\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L2529-L2547\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L2854-L2872\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L459-L603\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L54-L2873\n - https://github.com/angular/angular/edit/master/packages/common/http/src/client.ts?message=docs(common)%3A%20describe%20your%20change...#L892-L913\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1203-L1220\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1515-L1534\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1559-L1584\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L1876-L1895\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L2204-L2221\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L2529-L2547\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L2854-L2872\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L459-L603\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L54-L2873\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/client.ts#L892-L913\n-->"
|
|
} |