BaseLocationServices | @uirouter/angular
Options
All
  • Public
  • Public/Protected
  • All
Menu

A base LocationServices

Hierarchy

Implements

Index

Constructors

constructor

  • Parameters

    • router: UIRouter
    • fireAfterUpdate: boolean

    Returns BaseLocationServices

Properties

_history

_history: HistoryLike

_location

_location: LocationLike

fireAfterUpdate

fireAfterUpdate: boolean

Methods

Protected Abstract _get

  • _get(): string
  • This should return the current internal URL representation.

    The internal URL includes only the portion that UI-Router matches. It does not include:

    • protocol
    • server
    • port
    • base href or hash

    Returns string

_listener

  • _listener(evt: any): void
  • Parameters

    • evt: any

    Returns void

Protected Abstract _set

  • _set(state: any, title: string, url: string, replace: boolean): any
  • This should set the current URL.

    The url param should include only the portion that UI-Router matches on. It should not include:

    • protocol
    • server
    • port
    • base href or hash

    However, after this function completes, the browser URL should reflect the entire (fully qualified) HREF including those data.

    Parameters

    • state: any
    • title: string
    • url: string
    • replace: boolean

    Returns any

dispose

  • Parameters

    Returns void

hash

  • hash(): any
  • Returns any

onChange

  • onChange(cb: EventListener): (Anonymous function)
  • Parameters

    • cb: EventListener

    Returns (Anonymous function)

path

  • path(): any
  • Returns any

search

  • search(): any
  • Returns any

url

  • url(url?: string, replace?: boolean): string
  • Parameters

    • Optional url: string
    • Default value replace: boolean = true

    Returns string

Generated using TypeDoc