LocationConfig | @uirouter/angularjs
Options
Menu

Interface LocationConfig

This service returns the location configuration

This service returns information about the location configuration. This service is primarily used when building URLs (e.g., for hrefs)

Hierarchy

Implemented by

Index

Methods

Methods

  • baseHref(): string

  • Gets the base Href, e.g., http://localhost/approot/

  • Gets the base Href, e.g., http://localhost/approot/

    Returns string

    :

    the application's base href

  • dispose(router?: UIRouter): any

  • Instructs the Disposable to clean up any resources

  • Instructs the Disposable to clean up any resources

    Parameters

    Returns any

  • hashPrefix(): string

  • Gets the hashPrefix (when not running in pushstate mode)

  • hashPrefix(newprefix: string): string

  • Sets the hashPrefix (when not running in pushstate mode)

  • Gets the hashPrefix (when not running in pushstate mode)

    If the current url is http://localhost/app#!/uirouter/path/#anchor, it returns ! which is the prefix for the "hashbang" portion.

    Returns string

    :

    the hash prefix

  • Sets the hashPrefix (when not running in pushstate mode)

    Parameters

    • newprefix string

    Returns string

    :

    the new hash prefix

  • host(): string

  • Gets the host, e.g., localhost

  • Gets the host, e.g., localhost

    Returns string

    :

    the protocol

  • html5Mode(): boolean

  • Returns true when running in pushstate mode

  • Returns true when running in pushstate mode

    Returns boolean

    :

    true when running in pushstate mode

  • port(): number

  • Gets the port, e.g., 80

  • Gets the port, e.g., 80

    Returns number

    :

    the port number

  • protocol(): string

  • Gets the protocol, e.g., http

  • Gets the protocol, e.g., http

    Returns string

    :

    the protocol

Generated using TypeDoc