W3cubDocs

/Angular

$locationShimProvider

class final

The factory function used to create an instance of the $locationShim in Angular, and provides an API-compatible $locationProvider for AngularJS.

class $locationShimProvider {
  constructor(ngUpgrade: UpgradeModule, location: Location, platformLocation: PlatformLocation, urlCodec: UrlCodec, locationStrategy: LocationStrategy)
  $get()
  hashPrefix(prefix?: string)
  html5Mode(mode?: any)
}

Constructor

`constructor(ngUpgrade: UpgradeModule, location: Location, platformLocation: PlatformLocation, urlCodec: UrlCodec, locationStrategy: LocationStrategy)`

Parameters

`ngUpgrade`	`UpgradeModule`
`location`	`Location`
`platformLocation`	`PlatformLocation`
`urlCodec`	`UrlCodec`
`locationStrategy`	`LocationStrategy`

Methods

$get()
Factory method that returns an instance of the $locationShim
`$get()` Parameters There are no parameters.

hashPrefix()

Stub method used to keep API compatible with AngularJS. This setting is configured through the LocationUpgradeModule's config method in your Angular app.

`hashPrefix(prefix?: string)`

Parameters

prefix

string

Optional. Default is undefined.

html5Mode()

Stub method used to keep API compatible with AngularJS. This setting is configured through the LocationUpgradeModule's config method in your Angular app.

`html5Mode(mode?: any)`

Parameters

mode

any

Optional. Default is undefined.

© 2010–2023 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/api/common/upgrade/$locationShimProvider