LocationStrategy

LocationStrategy

class

LocationStrategy is responsible for representing and reading route state from the browser's URL. Angular provides two strategies: HashLocationStrategy and PathLocationStrategy.

See more...

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

Subclasses

• HashLocationStrategy
• PathLocationStrategy
• MockLocationStrategy

Description

This is used under the hood of the Location service.

Applications should use the Router or Location services to interact with application route state.

For instance, HashLocationStrategy produces URLs like http://example.com#/foo, and PathLocationStrategy produces http://example.com/foo as an equivalent URL.

See these two classes for more.

Methods

path()
abstract path(includeHash?: boolean): string Parameters includeHash boolean Optional. Default is undefined. Returns string

prepareExternalUrl()
abstract prepareExternalUrl(internal: string): string Parameters internal string Returns string

pushState()
abstract pushState(state: any, title: string, url: string, queryParams: string): void Parameters state any title string url string queryParams string Returns void

replaceState()
abstract replaceState(state: any, title: string, url: string, queryParams: string): void Parameters state any title string url string queryParams string Returns void

forward()
abstract forward(): void Parameters There are no parameters. Returns void

back()
abstract back(): void Parameters There are no parameters. Returns void

onPopState()
abstract onPopState(fn: LocationChangeListener): void Parameters fn LocationChangeListener Returns void

getBaseHref()
abstract getBaseHref(): string Parameters There are no parameters. Returns string

© 2010–2019 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v7.angular.io/api/common/LocationStrategy