Credit to devdocs.io

angular 2.0_typescript

angular

PathLocationStrategy

Stable Class

Class Overview

class PathLocationStrategy {
  constructor(_platformLocation: PlatformLocation, href?: string)
  
  
  onPopState(fn: LocationChangeListener) : void
  getBaseHref() : string
  prepareExternalUrl(internal: string) : string
  path(includeHash?: boolean) : string
  pushState(state: any, title: string, url: string, queryParams: string)
  replaceState(state: any, title: string, url: string, queryParams: string)
  forward() : void
  back() : void
}

Class Description

PathLocationStrategy is a LocationStrategy used to configure the Location service to represent its state in the path of the browser's URL.

PathLocationStrategy is the default binding for LocationStrategy provided in ROUTER_PROVIDERS.

If you're using PathLocationStrategy, you must provide a APP_BASE_HREF or add a base element to the document. This URL prefix that will be preserved when generating and recognizing URLs.

For instance, if you provide an APP_BASE_HREF of '/my/app' and call location.go('/foo'), the browser's URL will become example.com/my/app/foo.

Similarly, if you add <base href='/my/app'/> to the document and call location.go('/foo'), the browser's URL will become example.com/my/app/foo.

Annotations

@Injectable()

Constructor

constructor(_platformLocation: PlatformLocation, href?: string)

Class Details

onPopState(fn: LocationChangeListener) : void
getBaseHref() : string
prepareExternalUrl(internal: string) : string
path(includeHash?: boolean) : string
pushState(state: any, title: string, url: string, queryParams: string)
replaceState(state: any, title: string, url: string, queryParams: string)
forward() : void
back() : void

exported from @angular/common/index, defined in @angular/common/src/location/path_location_strategy.ts

© 2010–2016 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://angular.io/docs/ts/latest/api/common/index/PathLocationStrategy-class.html