5 lines
225 KiB
JSON
5 lines
225 KiB
JSON
{
|
|
"id": "api/common/http/HttpRequest",
|
|
"title": "HttpRequest",
|
|
"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/HttpRequest\", \"name\": \"HttpRequest\" } }\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/request.ts?message=docs(common)%3A%20describe%20your%20change...#L70-L426\" 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/request.ts#L70-L426\" 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=\"httprequest\">HttpRequest<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpRequest#httprequest\"><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>An outgoing HTTP request with an optional typed body.</p>\n\n <p><a href=\"api/common/http/HttpRequest#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/HttpRequest\" class=\"code-anchor\">HttpRequest</a><T> {\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#constructor()\"><span class=\"member-name\">constructor</span>(method: string, url: string, third?: T | { headers?: HttpHeaders; context?: HttpContext; reportProgress?: boolean; params?: HttpParams; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; withCredentials?: boolean; }, fourth?: { headers?: HttpHeaders; context?: HttpContext; reportProgress?: boolean; params?: HttpParams; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; withCredentials?: boolean; })</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#body\"><span class=\"member-name\">body</span>: T | null</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#headers\"><span class=\"member-name\">headers</span>: HttpHeaders</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#context\"><span class=\"member-name\">context</span>: HttpContext</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#reportProgress\"><span class=\"member-name\">reportProgress</span>: boolean</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#withCredentials\"><span class=\"member-name\">withCredentials</span>: boolean</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#responseType\"><span class=\"member-name\">responseType</span>: 'arraybuffer' | 'blob' | 'json' | 'text'</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#method\"><span class=\"member-name\">method</span>: string</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#params\"><span class=\"member-name\">params</span>: HttpParams</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#urlWithParams\"><span class=\"member-name\">urlWithParams</span>: string</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#url\"><span class=\"member-name\">url</span>: string</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#serializeBody\"><span class=\"member-name\">serializeBody</span>(): ArrayBuffer | Blob | FormData | string | null</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#detectContentTypeHeader\"><span class=\"member-name\">detectContentTypeHeader</span>(): string | null</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpRequest#clone\"><span class=\"member-name\">clone</span>(update: { headers?: HttpHeaders; context?: HttpContext; reportProgress?: boolean; params?: HttpParams; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; ... 5 more ...; setParams?: { ...; }; } = {}): HttpRequest<any></a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\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/HttpRequest#description\"><i class=\"material-icons\">link</i></a></h2>\n <p><code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a></code> represents an outgoing request, including URL, method,\nheaders, body, and other request configuration options. Instances should be\nassumed to be immutable. To modify a <code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a></code>, the <code>clone</code>\nmethod should be used.</p>\n\n \n</section>\n\n \n\n\n\n\n\n\n<h2 id=\"constructor\">Constructor<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpRequest#constructor\"><i class=\"material-icons\">link</i></a></h2>\n<a id=\"constructor()\"></a>\n<table class=\"is-full-width method-table constructor\">\n \n <tbody>\n \n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"3-overloads\">3 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\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">constructor</span>(method: \"DELETE\" | \"GET\" | \"HEAD\" | \"JSONP\" | \"OPTIONS\", url: string, init?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a>; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a>; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; withCredentials?: boolean; })</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table constructor-overload-parameters\">\n <tbody>\n \n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>\"DELETE\" | \"GET\" | \"HEAD\" | \"JSONP\" | \"OPTIONS\"</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-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 \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>init</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>undefined</code>.</p>\n \n </td>\n </tr>\n </tbody>\n</table>\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\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">constructor</span>(method: \"POST\" | \"PUT\" | \"PATCH\", url: string, body: T, init?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a>; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a>; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; withCredentials?: boolean; })</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 constructor-overload-parameters\">\n <tbody>\n \n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>method</code>\n </td>\n <td class=\"param-type\"><code>\"POST\" | \"PUT\" | \"PATCH\"</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-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 \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>T</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>init</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>undefined</code>.</p>\n \n </td>\n </tr>\n </tbody>\n</table>\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\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">constructor</span>(method: string, url: string, body: T, init?: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a>; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a>; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; withCredentials?: boolean; })</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 constructor-overload-parameters\">\n <tbody>\n \n <tr class=\"constructor-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 \n \n </td>\n </tr>\n <tr class=\"constructor-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 \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>body</code>\n </td>\n <td class=\"param-type\"><code>T</code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>init</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>undefined</code>.</p>\n \n </td>\n </tr>\n </tbody>\n</table>\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\n\n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpRequest#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"body\"></a>\n <code class=\"\"><span class=\"member-name\">body</span>: T | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The request body, or <code>null</code> if one isn't set.</p>\n\n <p>Bodies are not enforced to be immutable, as they can include a reference to any\nuser-defined data type. However, interceptors should take care to preserve\nidempotence by treating them as such.</p>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"headers\"></a>\n <code class=\"\"><span class=\"member-name\">headers</span>: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Outgoing headers for this request.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"context\"></a>\n <code class=\"\"><span class=\"member-name\">context</span>: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Shared and mutable context that can be used by interceptors</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"reportProgress\"></a>\n <code class=\"\"><span class=\"member-name\">reportProgress</span>: boolean</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Whether this request should be made in a way that exposes progress events.</p>\n\n <p>Progress events are expensive (change detection runs on each event) and so\nthey should only be requested if the consumer intends to monitor them.</p>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"withCredentials\"></a>\n <code class=\"\"><span class=\"member-name\">withCredentials</span>: boolean</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Whether this request should be sent with outgoing credentials (cookies).</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"responseType\"></a>\n <code class=\"\"><span class=\"member-name\">responseType</span>: 'arraybuffer' | 'blob' | 'json' | 'text'</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The expected response type of the server.</p>\n\n <p>This is used to parse the response appropriately before returning it to\nthe requestee.</p>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"method\"></a>\n <code class=\"\"><span class=\"member-name\">method</span>: string</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The outgoing HTTP request method.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"params\"></a>\n <code class=\"\"><span class=\"member-name\">params</span>: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Outgoing URL parameters.</p>\n\n <p>To pass a string representation of HTTP parameters in the URL-query-string format,\nthe <code><a href=\"api/common/http/HttpParamsOptions\" class=\"code-anchor\">HttpParamsOptions</a></code>' <code>fromString</code> may be used. For example:</p>\n<code-example>\nnew <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a>({fromString: 'angular=awesome'})\n</code-example>\n\n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"urlWithParams\"></a>\n <code class=\"\"><span class=\"member-name\">urlWithParams</span>: string</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The outgoing URL with all URL parameters set.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"url\"></a>\n <code class=\"\"><span class=\"member-name\">url</span>: string</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n <span class=\"from-constructor\">Declared in Constructor</span>\n \n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\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/HttpRequest#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"serializeBody\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"serializebody\">\n serializeBody()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpRequest#serializebody\"><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/request.ts?message=docs(common)%3A%20describe%20your%20change...#L263-L290\" 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/request.ts#L263-L290\" 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>Transform the free-form body into a serialized format suitable for\ntransmission to the server.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">serializeBody</span>(): ArrayBuffer | Blob | FormData | string | null</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-3\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>ArrayBuffer | Blob | FormData | string | null</code></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=\"detectContentTypeHeader\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"detectcontenttypeheader\">\n detectContentTypeHeader()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpRequest#detectcontenttypeheader\"><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/request.ts?message=docs(common)%3A%20describe%20your%20change...#L291-L332\" 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/request.ts#L291-L332\" 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>Examine the body and attempt to infer an appropriate MIME type\nfor it.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">detectContentTypeHeader</span>(): string | null</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-4\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code>string | null</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n <tr>\n <td class=\"description\">\n <p>If no such type can be inferred, this method will return <code>null</code>.</p>\n\n </td>\n </tr>\n\n \n </tbody>\n</table>\n\n \n <a id=\"clone\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"clone\">\n clone()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpRequest#clone\"><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/request.ts?message=docs(common)%3A%20describe%20your%20change...#L361-L425\" 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/request.ts#L361-L425\" 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 \n <tr>\n <td>\n <details class=\"overloads\">\n <summary>\n <div class=\"icon-action-header\">\n <h4 class=\"no-anchor\" id=\"3-overloads-1\">3 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\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">clone</span>(): <a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a><T></code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-5\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest<T></a></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\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">clone</span>(update: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a>; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a>; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; ... 5 more ...; setParams?: { ...; }; }): <a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a><T></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>update</code>\n </td>\n <td class=\"param-type\"><code>object</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-3\">Returns</h6>\n <p><code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest<T></a></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\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">clone</span><V>(update: { headers?: <a href=\"api/common/http/HttpHeaders\" class=\"code-anchor\">HttpHeaders</a>; context?: <a href=\"api/common/http/HttpContext\" class=\"code-anchor\">HttpContext</a>; reportProgress?: boolean; params?: <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a>; responseType?: \"arraybuffer\" | \"blob\" | \"text\" | \"json\"; ... 5 more ...; setParams?: { ...; }; }): <a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a><V></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>update</code>\n </td>\n <td class=\"param-type\"><code>object</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-4\">Returns</h6>\n <p><code><a href=\"api/common/http/HttpRequest\" class=\"code-anchor\">HttpRequest</a><V></code></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\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/common/http\n - api/common/http/HttpBackend\n - api/common/http/HttpClient\n - api/common/http/HttpContext\n - api/common/http/HttpHandler\n - api/common/http/HttpInterceptor\n - api/common/http/HttpXhrBackend\n - api/common/http/JsonpClientBackend\n - api/common/http/JsonpInterceptor\n - api/common/http/testing/HttpTestingController\n - api/common/http/testing/TestRequest\n - guide/http\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/http\n - api/common/http/HttpContext\n - api/common/http/HttpHeaders\n - api/common/http/HttpParams\n - api/common/http/HttpParamsOptions\n - api/common/http/HttpRequest#body\n - api/common/http/HttpRequest#clone\n - api/common/http/HttpRequest#constructor\n - api/common/http/HttpRequest#constructor()\n - api/common/http/HttpRequest#context\n - api/common/http/HttpRequest#description\n - api/common/http/HttpRequest#detectContentTypeHeader\n - api/common/http/HttpRequest#detectcontenttypeheader\n - api/common/http/HttpRequest#headers\n - api/common/http/HttpRequest#httprequest\n - api/common/http/HttpRequest#method\n - api/common/http/HttpRequest#methods\n - api/common/http/HttpRequest#params\n - api/common/http/HttpRequest#properties\n - api/common/http/HttpRequest#reportProgress\n - api/common/http/HttpRequest#responseType\n - api/common/http/HttpRequest#serializeBody\n - api/common/http/HttpRequest#serializebody\n - api/common/http/HttpRequest#url\n - api/common/http/HttpRequest#urlWithParams\n - api/common/http/HttpRequest#withCredentials\n - https://github.com/angular/angular/edit/master/packages/common/http/src/request.ts?message=docs(common)%3A%20describe%20your%20change...#L263-L290\n - https://github.com/angular/angular/edit/master/packages/common/http/src/request.ts?message=docs(common)%3A%20describe%20your%20change...#L291-L332\n - https://github.com/angular/angular/edit/master/packages/common/http/src/request.ts?message=docs(common)%3A%20describe%20your%20change...#L361-L425\n - https://github.com/angular/angular/edit/master/packages/common/http/src/request.ts?message=docs(common)%3A%20describe%20your%20change...#L70-L426\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/request.ts#L263-L290\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/request.ts#L291-L332\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/request.ts#L361-L425\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/request.ts#L70-L426\n-->"
|
|
} |