5 lines
30 KiB
JSON
5 lines
30 KiB
JSON
{
|
|
"id": "api/common/http/HttpParams",
|
|
"title": "HttpParams",
|
|
"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/HttpParams\", \"name\": \"HttpParams\" } }\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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L132-L324\" 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/params.ts#L132-L324\" 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=\"httpparams\">HttpParams<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#httpparams\"><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 HTTP request/response body that represents serialized parameters,\nper the MIME type <code>application/x-www-form-urlencoded</code>.</p>\n\n <p><a href=\"api/common/http/HttpParams#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/HttpParams\" class=\"code-anchor\">HttpParams</a> {\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#constructor()\"><span class=\"member-name\">constructor</span>(options: HttpParamsOptions = {} as HttpParamsOptions)</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#has\"><span class=\"member-name\">has</span>(param: string): boolean</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#get\"><span class=\"member-name\">get</span>(param: string): string | null</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#getAll\"><span class=\"member-name\">getAll</span>(param: string): string[] | null</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#keys\"><span class=\"member-name\">keys</span>(): string[]</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#append\"><span class=\"member-name\">append</span>(param: string, value: string | number | boolean): HttpParams</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#appendAll\"><span class=\"member-name\">appendAll</span>(params: { [param: string]: string | number | boolean | readonly (string | number | boolean)[]; }): HttpParams</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#set\"><span class=\"member-name\">set</span>(param: string, value: string | number | boolean): HttpParams</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#delete\"><span class=\"member-name\">delete</span>(param: string, value?: string | number | boolean): HttpParams</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParams#toString\"><span class=\"member-name\">toString</span>(): string</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/HttpParams#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>This class is immutable; all mutation operations return a new instance.</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/HttpParams#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 \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\">constructor</span>(options: <a href=\"api/common/http/HttpParamsOptions\" class=\"code-anchor\">HttpParamsOptions</a> = {} as <a href=\"api/common/http/HttpParamsOptions\" class=\"code-anchor\">HttpParamsOptions</a>)</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>options</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/http/HttpParamsOptions\" class=\"code-anchor\">HttpParamsOptions</a></code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>{} as <a href=\"api/common/http/HttpParamsOptions\" class=\"code-anchor\">HttpParamsOptions</a></code>.</p>\n \n </td>\n </tr>\n </tbody>\n</table>\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\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/HttpParams#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"has\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"has\">\n has()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#has\"><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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L164-L174\" 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/params.ts#L164-L174\" 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>Reports whether the body includes one or more values for a given parameter.</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\">has</span>(param: string): 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 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>param</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The parameter name.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>boolean</code>: True if the parameter has one or more values,\nfalse if it has no value or is not present.</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=\"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/HttpParams#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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L175-L186\" 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/params.ts#L175-L186\" 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>Retrieves the first value for a parameter.</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\">get</span>(param: string): string | null</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>param</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The parameter name.</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>string | null</code>: The first value of the given parameter,\nor <code>null</code> if the parameter is not present.</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=\"getAll\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"getall\">\n getAll()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#getall\"><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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L187-L197\" 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/params.ts#L187-L197\" 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>Retrieves all values for a parameter.</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\">getAll</span>(param: string): string[] | null</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>param</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The parameter name.</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>string[] | null</code>: All values in a string array,\nor <code>null</code> if the parameter not present.</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=\"keys\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"keys\">\n keys()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#keys\"><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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L198-L206\" 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/params.ts#L198-L206\" 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>Retrieves all the parameters for this body.</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\">keys</span>(): string[]</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-3\">Returns</h6>\n <p><code>string[]</code>: The parameter names in a string array.</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=\"append\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"append\">\n append()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#append\"><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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L207-L216\" 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/params.ts#L207-L216\" 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>Appends a new value to existing values for a parameter.</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\">append</span>(param: string, value: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean): <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></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>param</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The parameter name.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>value</code>\n </td>\n <td class=\"param-type\"><code>string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean</code></td>\n <td class=\"param-description\">\n <p>The new value to add.</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><a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></code>: A new body with the appended value.</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=\"appendAll\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"appendall\">\n appendAll()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#appendall\"><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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L217-L237\" 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/params.ts#L217-L237\" 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 a new body with appended values for the given parameter name.</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\">appendAll</span>(params: { [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | readonly (string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean)[]; }): <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></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>params</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>parameters and values</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><a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></code>: A new body with the new value.</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=\"set\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"set\">\n set()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#set\"><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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L238-L247\" 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/params.ts#L238-L247\" 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>Replaces the value for a parameter.</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\">set</span>(param: string, value: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean): <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></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>param</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The parameter name.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>value</code>\n </td>\n <td class=\"param-type\"><code>string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean</code></td>\n <td class=\"param-description\">\n <p>The new value.</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><a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></code>: A new body with the new value.</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=\"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/HttpParams#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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L248-L258\" 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/params.ts#L248-L258\" 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>Removes a given value or all values from a parameter.</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\">delete</span>(param: string, value?: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean): <a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></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>param</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The parameter name.</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>value</code>\n </td>\n <td class=\"param-type\"><code>string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean</code></td>\n <td class=\"param-description\">\n <p>The value to remove, if provided.</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-7\">Returns</h6>\n <p><code><a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></code>: A new body with the given value removed, or with all values\nremoved if no value is specified.</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=\"toString\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"tostring\">\n toString()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParams#tostring\"><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/params.ts?message=docs(common)%3A%20describe%20your%20change...#L259-L279\" 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/params.ts#L259-L279\" 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>Serializes the body to an encoded string, where key-value pairs (separated by <code>=</code>) are\nseparated by <code>&</code>s.</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\">toString</span>(): string</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-9\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-8\">Returns</h6>\n <p><code>string</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</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/HttpClient\n - api/common/http/HttpParameterCodec\n - api/common/http/HttpParamsOptions\n - api/common/http/HttpRequest\n - guide/http\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/DecimalPipe\n - api/common/http\n - api/common/http/HttpParams#append\n - api/common/http/HttpParams#appendAll\n - api/common/http/HttpParams#appendall\n - api/common/http/HttpParams#constructor\n - api/common/http/HttpParams#constructor()\n - api/common/http/HttpParams#delete\n - api/common/http/HttpParams#description\n - api/common/http/HttpParams#get\n - api/common/http/HttpParams#getAll\n - api/common/http/HttpParams#getall\n - api/common/http/HttpParams#has\n - api/common/http/HttpParams#httpparams\n - api/common/http/HttpParams#keys\n - api/common/http/HttpParams#methods\n - api/common/http/HttpParams#set\n - api/common/http/HttpParams#toString\n - api/common/http/HttpParams#tostring\n - api/common/http/HttpParamsOptions\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L132-L324\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L164-L174\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L175-L186\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L187-L197\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L198-L206\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L207-L216\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L217-L237\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L238-L247\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L248-L258\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L259-L279\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L132-L324\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L164-L174\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L175-L186\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L187-L197\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L198-L206\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L207-L216\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L217-L237\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L238-L247\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L248-L258\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L259-L279\n-->"
|
|
} |