{
  "id": "api/common/upgrade/LocationUpgradeConfig",
  "title": "LocationUpgradeConfig",
  "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            { \"@type\": \"ListItem\", \"position\": 4, \"item\": { \"@id\": \"https://angular.io/api/common/upgrade/LocationUpgradeConfig\", \"name\": \"LocationUpgradeConfig\" } }\n          ]\n        }\n      </script>\n        <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a> > <a href=\"api/common/upgrade\">@angular/common/upgrade</a>\n    </div>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/location_upgrade_module.ts?message=docs(common)%3A%20describe%20your%20change...#L15-L44\" 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/src/location_upgrade_module.ts#L15-L44\" 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=\"locationupgradeconfig\">LocationUpgradeConfig<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/LocationUpgradeConfig#locationupgradeconfig\"><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>Configuration options for LocationUpgrade.</p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/common/upgrade/LocationUpgradeConfig\" class=\"code-anchor\">LocationUpgradeConfig</a> {\n  <a class=\"code-anchor\" href=\"api/common/upgrade/LocationUpgradeConfig#useHash\"><span class=\"member-name\">useHash</span>?: boolean</a>\n  <a class=\"code-anchor\" href=\"api/common/upgrade/LocationUpgradeConfig#hashPrefix\"><span class=\"member-name\">hashPrefix</span>?: string</a>\n  <a class=\"code-anchor\" href=\"api/common/upgrade/LocationUpgradeConfig#urlCodec\"><span class=\"member-name\">urlCodec</span>?: typeof UrlCodec</a>\n  <a class=\"code-anchor\" href=\"api/common/upgrade/LocationUpgradeConfig#serverBaseHref\"><span class=\"member-name\">serverBaseHref</span>?: string</a>\n  <a class=\"code-anchor\" href=\"api/common/upgrade/LocationUpgradeConfig#appBaseHref\"><span class=\"member-name\">appBaseHref</span>?: string</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/upgrade/LocationUpgradeConfig#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=\"useHash\"></a>\n          <code class=\"\"><span class=\"member-name\">useHash</span>?: boolean</code>\n        </td>\n        <td>\n          \n          <p>Configures whether the location upgrade module should use the <code><a href=\"api/common/HashLocationStrategy\" class=\"code-anchor\">HashLocationStrategy</a></code>\nor the <code><a href=\"api/common/PathLocationStrategy\" class=\"code-anchor\">PathLocationStrategy</a></code></p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"hashPrefix\"></a>\n          <code class=\"\"><span class=\"member-name\">hashPrefix</span>?: string</code>\n        </td>\n        <td>\n          \n          <p>Configures the hash prefix used in the URL when using the <code><a href=\"api/common/HashLocationStrategy\" class=\"code-anchor\">HashLocationStrategy</a></code></p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"urlCodec\"></a>\n          <code class=\"\"><span class=\"member-name\">urlCodec</span>?: typeof <a href=\"api/common/upgrade/UrlCodec\" class=\"code-anchor\">UrlCodec</a></code>\n        </td>\n        <td>\n          \n          <p>Configures the URL codec for encoding and decoding URLs. Default is the <code>AngularJSCodec</code></p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"serverBaseHref\"></a>\n          <code class=\"\"><span class=\"member-name\">serverBaseHref</span>?: string</code>\n        </td>\n        <td>\n          \n          <p>Configures the base href when used in server-side rendered applications</p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"appBaseHref\"></a>\n          <code class=\"\"><span class=\"member-name\">appBaseHref</span>?: string</code>\n        </td>\n        <td>\n          \n          <p>Configures the base href when used in client-side rendered applications</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/upgrade\n - api/common/upgrade/LOCATION_UPGRADE_CONFIGURATION\n - api/common/upgrade/LocationUpgradeModule\n - guide/upgrade\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/HashLocationStrategy\n - api/common/PathLocationStrategy\n - api/common/upgrade\n - api/common/upgrade/LocationUpgradeConfig#appBaseHref\n - api/common/upgrade/LocationUpgradeConfig#hashPrefix\n - api/common/upgrade/LocationUpgradeConfig#locationupgradeconfig\n - api/common/upgrade/LocationUpgradeConfig#properties\n - api/common/upgrade/LocationUpgradeConfig#serverBaseHref\n - api/common/upgrade/LocationUpgradeConfig#urlCodec\n - api/common/upgrade/LocationUpgradeConfig#useHash\n - api/common/upgrade/UrlCodec\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/location_upgrade_module.ts?message=docs(common)%3A%20describe%20your%20change...#L15-L44\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/location_upgrade_module.ts#L15-L44\n-->"
}