Class Location

constructor

• new Location(
      appBase: string,
      appBaseNoFile: string,
      html5?: boolean,
      prefix?: string,
  ): Location

  Parameters

  • appBase: string

    application base URL

  • appBaseNoFile: string

    application base URL stripped of any filename

  • Optionalhtml5: boolean = true

    Defaults to true

  • Optionalprefix: string

    URL path prefix for html5 mode or hash prefix for hashbang mode

  Returns Location

absUrl

appBase

appBaseNoFile

OptionalbasePrefix

OptionalhashPrefix

html5

getHash

• getHash(): string

  Returns the hash fragment when called without any parameters.

  Returns string

  The current hash fragment.

getPath

• getPath(): string

  Returns the path of the current URL.

  Returns string

getSearch

• getSearch(): Record<string, unknown>

  Returns the search part of the current URL as an object.

  Returns Record<string, unknown>

  The current search object.

getState

• getState(): unknown

  Returns the current history state object.

  Returns unknown

getUrl

• getUrl(): string

  Return URL (e.g. /path?a=b#hash) when called without any parameter.

  Returns string

  The current path/search/hash string.

hash

• hash(): string

  Returns string

• hash(hash: string | number | null): this

  Parameters

  • hash: string | number | null

  Returns this

parse

• parse(url: string): void

  Parse given HTML5 (regular) URL string into properties

  Parameters

  • url: string

    HTML5 URL

  Returns void

parseLinkUrl

• parseLinkUrl(url: string, relHref: string | null): boolean

  Attempts to parse a clicked link into an app-relative URL update.

  Parameters

  • url: string
  • relHref: string | null

  Returns boolean

path

• path(): string

  Returns string

• path(path: string | number | null): this

  Parameters

  • path: string | number | null

  Returns this

search

• search(): Record<string, unknown>

  Returns Record<string, unknown>

• search(
      search: string | number | Record<string, unknown>,
      paramValue?: string | number | boolean | string[] | null,
  ): this

  Parameters

  • search: string | number | Record<string, unknown>
  • OptionalparamValue: string | number | boolean | string[] | null

  Returns this

setHash

• setHash(hash: string | number | null): Location

  Changes the hash fragment when called with a parameter and returns $location.

  Parameters

  • hash: string | number | null

    New hash fragment.

  Returns Location

  The Location instance.

setPath

• setPath(path: string | number | null): Location

  Changes the path parameter and returns $location.

  Parameters

  • path: string | number | null

    New path.

  Returns Location

setSearch

• setSearch(
      search: string | number | Record<string, unknown>,
      paramValue?: string | number | boolean | string[] | null,
  ): Location

  Sets the search part of the current URL as an object.

  Parameters

  • search: string | number | Record<string, unknown>

    New search params as a string or object.

  • OptionalparamValue: string | number | boolean | string[] | null

    If search is a string or number, overrides only a single search property.

  Returns Location

  The Location instance.

setState

• setState(state: unknown): Location

  Change the history state object when called with one parameter and return $location. The state object is later passed to pushState or replaceState. See https://developer.mozilla.org/en-US/docs/Web/API/History/pushState#state|History.state

  NOTE: This method is supported only in HTML5 mode and only in browsers supporting the HTML5 History API (i.e. methods pushState and replaceState). If you need to support older browsers (like IE9 or Android < 4.0), don't use this method.

  Parameters

  • state: unknown

  Returns Location

  The Location instance.

setUrl

• setUrl(url: string): Location

  Change path, search and hash, when called with parameter and return $location.

  Parameters

  • url: string

    New URL without base prefix (e.g. /path?a=b#hash).

  Returns Location

  The Location instance.

state

• state(): unknown

  Returns unknown

• state(state: unknown): this

  Parameters

  • state: unknown

  Returns this

url

• url(): string

  Returns string

• url(url: string): this

  Parameters

  • url: string

  Returns this