UrlMatcherFactory | @uirouter/angularjs
Options
Menu

Class UrlMatcherFactory

Factory for UrlMatcher instances.

The factory is available to ng1 services as $urlMatcherFactory or ng1 providers as $urlMatcherFactoryProvider.

Hierarchy

  • UrlMatcherFactory

Implements

Index

Constructors

Methods

Object literals

Constructors

  • Returns UrlMatcherFactory

Methods

  • caseInsensitive(value?: boolean): boolean

  • Defines whether URL matching should be case sensitive (the default behavior), or not.

  • Defines whether URL matching should be case sensitive (the default behavior), or not.

    Example:

    // Allow case insensitive url matches
urlService.config.caseInsensitive(true);

    Parameters

    • value: Optional  boolean

    Returns boolean

    :

    the current value of caseInsensitive

  • compile(pattern: string, config?: object): UrlMatcher

  • Creates a UrlMatcher for the specified pattern.

  • Creates a UrlMatcher for the specified pattern.

    Parameters

    • pattern string
      :

      The URL pattern.

    • config: Optional  object
      :

      The config object hash.

      • [key: string]: any

    Returns UrlMatcher

    :

    The UrlMatcher.

  • defaultSquashPolicy(value?: string | true | false): string | true | false

  • Sets the default behavior when generating or matching URLs with default parameter values.

  • Sets the default behavior when generating or matching URLs with default parameter values.

    Example:

    // Remove default parameter values from the url
urlService.config.defaultSquashPolicy(true);

    Parameters

    • value: Optional  string | true | false

    Returns string | true | false

    :

    the current value of defaultSquashPolicy

  • dispose(): void

  • Returns void

  • isMatcher(object: any): boolean

  • Returns true if the specified object is a UrlMatcher, or false otherwise.

  • Returns true if the specified object is a UrlMatcher, or false otherwise.

    Parameters

    • object any
      :

      The object to perform the type check against.

    Returns boolean

    :

    true if the object matches the UrlMatcher interface, by implementing all the same methods.

  • strictMode(value?: boolean): boolean

  • Defines whether URLs should match trailing slashes, or not (the default behavior).

  • Defines whether URLs should match trailing slashes, or not (the default behavior).

    Example:

    // Allow optional trailing slashes
urlService.config.strictMode(false);

    Parameters

    • value: Optional  boolean

    Returns boolean

    :

    the current value of strictMode

  • Creates and registers a custom ParamType object

    A ParamType can be used to generate URLs with typed parameters.

    Parameters

    Returns any

    :
    • if a type was registered: the UrlMatcherFactory
      • if only the name parameter was specified: the currently registered ParamType object, or undefined

    Note: Register custom types before using them in a state definition.

    See ParamTypeDefinition for examples

Object literals

paramFactory: object
  • fromConfig(id: string, type: ParamType, config: any): Param

  • Creates a new Param from a CONFIG block

  • Creates a new Param from a CONFIG block

    Parameters

    Returns Param

  • fromPath(id: string, type: ParamType, config: any): Param

  • Creates a new Param from a url PATH

  • Creates a new Param from a url PATH

    Parameters

    Returns Param

  • fromSearch(id: string, type: ParamType, config: any): Param

  • Creates a new Param from a url SEARCH

  • Creates a new Param from a url SEARCH

    Parameters

    Returns Param

Generated using TypeDoc