5 lines
5.7 KiB
JSON
5 lines
5.7 KiB
JSON
{
|
|
"id": "api/common/http/HttpParamsOptions",
|
|
"title": "HttpParamsOptions",
|
|
"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/HttpParamsOptions\", \"name\": \"HttpParamsOptions\" } }\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...#L113-L131\" 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#L113-L131\" 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=\"httpparamsoptions\">HttpParamsOptions<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpParamsOptions#httpparamsoptions\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label interface\">interface</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>Options used to construct an <code><a href=\"api/common/http/HttpParams\" class=\"code-anchor\">HttpParams</a></code> instance.</p>\n\n \n </section>\n \n \n <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/common/http/HttpParamsOptions\" class=\"code-anchor\">HttpParamsOptions</a> {\n <a class=\"code-anchor\" href=\"api/common/http/HttpParamsOptions#fromString\"><span class=\"member-name\">fromString</span>?: string</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParamsOptions#fromObject\"><span class=\"member-name\">fromObject</span>?: {...}</a>\n <a class=\"code-anchor\" href=\"api/common/http/HttpParamsOptions#encoder\"><span class=\"member-name\">encoder</span>?: HttpParameterCodec</a>\n}\n</code-example>\n\n \n \n\n\n \n \n\n</section>\n\n \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/HttpParamsOptions#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=\"fromString\"></a>\n <code class=\"\"><span class=\"member-name\">fromString</span>?: string</code>\n </td>\n <td>\n \n <p>String representation of the HTTP parameters in URL-query-string format.\nMutually exclusive with <code>fromObject</code>.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"fromObject\"></a>\n <code class=\"\"><span class=\"member-name\">fromObject</span>?: {\n [param: string]: string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean | ReadonlyArray<string | <a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a> | boolean>;\n}</code>\n </td>\n <td>\n \n <p>Object map of the HTTP parameters. Mutually exclusive with <code>fromString</code>.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"encoder\"></a>\n <code class=\"\"><span class=\"member-name\">encoder</span>?: <a href=\"api/common/http/HttpParameterCodec\" class=\"code-anchor\">HttpParameterCodec</a></code>\n </td>\n <td>\n \n <p>Encoding codec used to parse and serialize the parameters.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\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/HttpParams\n - api/common/http/HttpRequest\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/DecimalPipe\n - api/common/http\n - api/common/http/HttpParameterCodec\n - api/common/http/HttpParams\n - api/common/http/HttpParamsOptions#encoder\n - api/common/http/HttpParamsOptions#fromObject\n - api/common/http/HttpParamsOptions#fromString\n - api/common/http/HttpParamsOptions#httpparamsoptions\n - api/common/http/HttpParamsOptions#properties\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L113-L131\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L113-L131\n-->"
|
|
} |