{
  "id": "api/common/http/HttpUrlEncodingCodec",
  "title": "HttpUrlEncodingCodec",
  "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/HttpUrlEncodingCodec\", \"name\": \"HttpUrlEncodingCodec\" } }\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...#L23-L70\" 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#L23-L70\" 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=\"httpurlencodingcodec\">HttpUrlEncodingCodec<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpUrlEncodingCodec#httpurlencodingcodec\"><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>Provides encoding and decoding of URL parameter and query-string values.</p>\n\n    <p><a href=\"api/common/http/HttpUrlEncodingCodec#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/HttpUrlEncodingCodec\" class=\"code-anchor\">HttpUrlEncodingCodec</a> implements <a class=\"code-anchor\" href=\"api/common/http/HttpParameterCodec\">HttpParameterCodec</a> {\n  <a class=\"code-anchor\" href=\"api/common/http/HttpUrlEncodingCodec#encodeKey\"><span class=\"member-name\">encodeKey</span>(key: string): string</a>\n  <a class=\"code-anchor\" href=\"api/common/http/HttpUrlEncodingCodec#encodeValue\"><span class=\"member-name\">encodeValue</span>(value: string): string</a>\n  <a class=\"code-anchor\" href=\"api/common/http/HttpUrlEncodingCodec#decodeKey\"><span class=\"member-name\">decodeKey</span>(key: string): string</a>\n  <a class=\"code-anchor\" href=\"api/common/http/HttpUrlEncodingCodec#decodeValue\"><span class=\"member-name\">decodeValue</span>(value: 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/HttpUrlEncodingCodec#description\"><i class=\"material-icons\">link</i></a></h2>\n  <p>Serializes and parses URL parameter keys and values to encode and decode them.\nIf you pass URL query parameters without encoding,\nthe query parameters can be misinterpreted at the receiving end.</p>\n\n  \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/HttpUrlEncodingCodec#methods\"><i class=\"material-icons\">link</i></a></h2>\n  \n    <a id=\"encodeKey\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"encodekey\">\n      encodeKey()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpUrlEncodingCodec#encodekey\"><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...#L35-L42\" 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#L35-L42\" 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>Encodes a key name for a URL parameter or query-string.</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\">encodeKey</span>(key: string): string</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>key</code>\n      </td>\n      <td class=\"param-type\"><code>string</code></td>\n      <td class=\"param-description\">\n      <p>The key 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>string</code>: The encoded key name.</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=\"encodeValue\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"encodevalue\">\n      encodeValue()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpUrlEncodingCodec#encodevalue\"><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...#L43-L51\" 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#L43-L51\" 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>Encodes the value of a URL parameter or query-string.</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\">encodeValue</span>(value: string): string</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>value</code>\n      </td>\n      <td class=\"param-type\"><code>string</code></td>\n      <td class=\"param-description\">\n      <p>The value.</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</code>: The encoded 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=\"decodeKey\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"decodekey\">\n      decodeKey()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpUrlEncodingCodec#decodekey\"><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...#L52-L60\" 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#L52-L60\" 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>Decodes an encoded URL parameter or query-string key.</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\">decodeKey</span>(key: string): string</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>key</code>\n      </td>\n      <td class=\"param-type\"><code>string</code></td>\n      <td class=\"param-description\">\n      <p>The encoded key 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</code>: The decoded key name.</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=\"decodeValue\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"decodevalue\">\n      decodeValue()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/http/HttpUrlEncodingCodec#decodevalue\"><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...#L61-L69\" 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#L61-L69\" 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>Decodes an encoded URL parameter or query-string value.</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\">decodeValue</span>(value: 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>value</code>\n      </td>\n      <td class=\"param-type\"><code>string</code></td>\n      <td class=\"param-description\">\n      <p>The encoded value.</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</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/HttpParameterCodec\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/http\n - api/common/http/HttpParameterCodec\n - api/common/http/HttpUrlEncodingCodec#decodeKey\n - api/common/http/HttpUrlEncodingCodec#decodeValue\n - api/common/http/HttpUrlEncodingCodec#decodekey\n - api/common/http/HttpUrlEncodingCodec#decodevalue\n - api/common/http/HttpUrlEncodingCodec#description\n - api/common/http/HttpUrlEncodingCodec#encodeKey\n - api/common/http/HttpUrlEncodingCodec#encodeValue\n - api/common/http/HttpUrlEncodingCodec#encodekey\n - api/common/http/HttpUrlEncodingCodec#encodevalue\n - api/common/http/HttpUrlEncodingCodec#httpurlencodingcodec\n - api/common/http/HttpUrlEncodingCodec#methods\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L23-L70\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L35-L42\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L43-L51\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L52-L60\n - https://github.com/angular/angular/edit/master/packages/common/http/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L61-L69\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L23-L70\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L35-L42\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L43-L51\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L52-L60\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/http/src/params.ts#L61-L69\n-->"
}