UrlMatcherFactory | angular-ui-router
Options
Menu

Class UrlMatcherFactory

Factory for UrlMatcher instances.

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

Hierarchy

  • UrlMatcherFactory

Implements

Index

Constructors

Methods

  • caseInsensitive(value?: boolean): boolean
  • Defines whether URL matching should be case sensitive (the default behavior), or not.

  • compile(pattern: string, config?: object): UrlMatcher
  • Creates a UrlMatcher for the specified pattern.

  • 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.

    Parameters

    • value: Optional  string | true | false

    Returns string | true | false

    :

    the current value of defaultSquashPolicy

    Example:

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

  • dispose(): 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).

Object literals

paramFactory: object
  • fromConfig(id: string, type: ParamType, config: any): Param
  • Creates a new Param from a CONFIG block

  • fromPath(id: string, type: ParamType, config: any): Param
  • Creates a new Param from a url PATH

  • fromSearch(id: string, type: ParamType, config: any): Param
  • Creates a new Param from a url SEARCH

Generated using TypeDoc