5 lines
112 KiB
JSON
5 lines
112 KiB
JSON
{
|
|
"id": "api/common/upgrade/$locationShimProvider",
|
|
"title": "$locationShimProvider",
|
|
"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/$locationShimProvider\", \"name\": \"$locationShimProvider\" } }\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_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L706-L743\" 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_shim.ts#L706-L743\" 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=\"locationshimprovider\">$locationShimProvider<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/$locationShimProvider#locationshimprovider\"><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>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 \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass $locationShimProvider {\n <a class=\"code-anchor\" href=\"api/common/upgrade/$locationShimProvider#constructor()\"><span class=\"member-name\">constructor</span>(ngUpgrade: UpgradeModule, location: Location, platformLocation: PlatformLocation, urlCodec: UrlCodec, locationStrategy: LocationStrategy)</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/$locationShimProvider#%24get\"><span class=\"member-name\">$get</span>()</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/$locationShimProvider#hashPrefix\"><span class=\"member-name\">hashPrefix</span>(prefix?: string)</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/$locationShimProvider#html5Mode\"><span class=\"member-name\">html5Mode</span>(mode?: any)</a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n\n \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/upgrade/$locationShimProvider#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>(ngUpgrade: <a href=\"api/upgrade/static/UpgradeModule\" class=\"code-anchor\">UpgradeModule</a>, location: <a href=\"api/common/Location\" class=\"code-anchor\">Location</a>, platformLocation: <a href=\"api/common/PlatformLocation\" class=\"code-anchor\">PlatformLocation</a>, urlCodec: <a href=\"api/common/upgrade/UrlCodec\" class=\"code-anchor\">UrlCodec</a>, locationStrategy: <a href=\"api/common/LocationStrategy\" class=\"code-anchor\">LocationStrategy</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>ngUpgrade</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/upgrade/static/UpgradeModule\" class=\"code-anchor\">UpgradeModule</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>location</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/Location\" class=\"code-anchor\">Location</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>platformLocation</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/PlatformLocation\" class=\"code-anchor\">PlatformLocation</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>urlCodec</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/upgrade/UrlCodec\" class=\"code-anchor\">UrlCodec</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>locationStrategy</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/common/LocationStrategy\" class=\"code-anchor\">LocationStrategy</a></code></td>\n <td class=\"param-description\">\n \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/upgrade/$locationShimProvider#methods\"><i class=\"material-icons\">link</i></a></h2>\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/upgrade/$locationShimProvider#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/upgrade/src/location_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L718-L726\" 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_shim.ts#L718-L726\" 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>Factory method that returns an instance of the $locationShim</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>()</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <p>There are no parameters.</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=\"hashPrefix\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"hashprefix\">\n hashPrefix()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/$locationShimProvider#hashprefix\"><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/upgrade/src/location_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L727-L734\" 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_shim.ts#L727-L734\" 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>Stub method used to keep API compatible with AngularJS. This setting is configured through\nthe LocationUpgradeModule's <code>config</code> method in your Angular app.</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\">hashPrefix</span>(prefix?: 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>prefix</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>undefined</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 <a id=\"html5Mode\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"html5mode\">\n html5Mode()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/$locationShimProvider#html5mode\"><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/upgrade/src/location_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L735-L742\" 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_shim.ts#L735-L742\" 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>Stub method used to keep API compatible with AngularJS. This setting is configured through\nthe LocationUpgradeModule's <code>config</code> method in your Angular app.</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\">html5Mode</span>(mode?: any)</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>mode</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>Optional. Default is <code>undefined</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</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/common/upgrade\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/Location\n - api/common/LocationStrategy\n - api/common/PlatformLocation\n - api/common/upgrade\n - api/common/upgrade/$locationShim\n - api/common/upgrade/$locationShimProvider#%24get\n - api/common/upgrade/$locationShimProvider#constructor\n - api/common/upgrade/$locationShimProvider#constructor()\n - api/common/upgrade/$locationShimProvider#get\n - api/common/upgrade/$locationShimProvider#hashPrefix\n - api/common/upgrade/$locationShimProvider#hashprefix\n - api/common/upgrade/$locationShimProvider#html5Mode\n - api/common/upgrade/$locationShimProvider#html5mode\n - api/common/upgrade/$locationShimProvider#locationshimprovider\n - api/common/upgrade/$locationShimProvider#methods\n - api/common/upgrade/UrlCodec\n - api/upgrade/static/UpgradeModule\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/location_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L706-L743\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/location_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L718-L726\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/location_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L727-L734\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/location_shim.ts?message=docs(common)%3A%20describe%20your%20change...#L735-L742\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/location_shim.ts#L706-L743\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/location_shim.ts#L718-L726\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/location_shim.ts#L727-L734\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/location_shim.ts#L735-L742\n-->"
|
|
} |