{
  "id": "api/common/upgrade",
  "title": "@angular/common/upgrade",
  "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/upgrade\", \"name\": \"@angular/common/upgrade\" } }\n          ]\n        }\n      </script>\n        <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a>\n    </div>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/PACKAGE.md?message=docs(...)%3A%20describe%20your%20change...\" 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/upgrade/PACKAGE.md\" 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=\"angularcommonupgrade\">@angular/common/upgrade<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade#angularcommonupgrade\"><i class=\"material-icons\">link</i></a></h1>\n  <label class=\"api-type-label NaN\">entry-point</label>\n  \n  \n  \n</header>\n\n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    <p>Provides tools for upgrading from the <code>$location</code> service provided in AngularJS\nto Angular's <a href=\"guide/upgrade#using-the-unified-angular-location-service\">unified location service</a>.</p>\n\n  \n\n  \n\n\n  \n\n  <h2 id=\"entry-point-exports\">Entry point exports<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade#entry-point-exports\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"ngmodules\">NgModules<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade#ngmodules\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/common/upgrade/LocationUpgradeModule\">LocationUpgradeModule</a></code></td>\n        <td>\n          \n          <p><code><a href=\"api/core/NgModule\" class=\"code-anchor\">NgModule</a></code> used for providing and configuring Angular's Unified Location Service for upgrading.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"classes\">Classes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade#classes\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/common/upgrade/$locationShim\">$locationShim</a></code></td>\n        <td>\n          \n          <p>Location service that provides a drop-in replacement for the $location service\nprovided in AngularJS.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/common/upgrade/$locationShimProvider\">$locationShimProvider</a></code></td>\n        <td>\n          \n          <p>The factory function used to create an instance of the <code><a href=\"api/common/upgrade/$locationShim\" class=\"code-anchor\">$locationShim</a></code> in Angular,\nand provides an API-compatiable <code>$locationProvider</code> for AngularJS.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/common/upgrade/AngularJSUrlCodec\">AngularJSUrlCodec</a></code></td>\n        <td>\n          \n          <p>A <code><a href=\"api/common/upgrade/UrlCodec\" class=\"code-anchor\">UrlCodec</a></code> that uses logic from AngularJS to serialize and parse URLs\nand URL parameters.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/common/upgrade/UrlCodec\">UrlCodec</a></code></td>\n        <td>\n          \n          <p>A codec for encoding and decoding URL parts.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"structures\">Structures<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade#structures\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/common/upgrade/LocationUpgradeConfig\">LocationUpgradeConfig</a></code></td>\n        <td>\n          \n          <p>Configuration options for LocationUpgrade.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"types\">Types<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade#types\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/common/upgrade/LOCATION_UPGRADE_CONFIGURATION\">LOCATION_UPGRADE_CONFIGURATION</a></code></td>\n        <td>\n          \n          <p>A provider token used to configure the location upgrade module.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/common\n - api/common/upgrade/$locationShim\n - api/common/upgrade/$locationShimProvider\n - api/common/upgrade/AngularJSUrlCodec\n - api/common/upgrade/LOCATION_UPGRADE_CONFIGURATION\n - api/common/upgrade/LocationUpgradeConfig\n - api/common/upgrade/LocationUpgradeModule\n - api/common/upgrade/UrlCodec\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/upgrade#angularcommonupgrade\n - api/common/upgrade#classes\n - api/common/upgrade#entry-point-exports\n - api/common/upgrade#ngmodules\n - api/common/upgrade#structures\n - api/common/upgrade#types\n - api/common/upgrade/$locationShim\n - api/common/upgrade/$locationShimProvider\n - api/common/upgrade/AngularJSUrlCodec\n - api/common/upgrade/LOCATION_UPGRADE_CONFIGURATION\n - api/common/upgrade/LocationUpgradeConfig\n - api/common/upgrade/LocationUpgradeModule\n - api/common/upgrade/UrlCodec\n - api/core/NgModule\n - guide/upgrade#using-the-unified-angular-location-service\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/PACKAGE.md?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/PACKAGE.md\n-->"
}