UrlMatcherFactory | @uirouter/angular

Class UrlMatcherFactory

Factory for UrlMatcher instances.

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

Hierarchy

UrlMatcherFactory

Index

Constructors

constructor

Properties

paramFactory

Methods

Constructors

new UrlMatcherFactory(router: UIRouter): UrlMatcherFactory

Parameters
- router UIRouter
Returns UrlMatcherFactory
- Defined in ui-router-core/src/url/urlMatcherFactory.ts:36

Properties

paramFactory: ParamFactory = new ParamFactory(this.router)

Methods

caseInsensitive(value?: boolean): boolean

Parameters
- value: Optional boolean
Returns boolean
- Defined in ui-router-core/src/url/urlMatcherFactory.ts:86

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

Creates a UrlMatcher for the specified pattern.

Parameters
- pattern string
  :
  
  The URL pattern.
- config: Optional UrlMatcherCompileConfig
  :
  
  The config object hash.
Returns UrlMatcher
:
The UrlMatcher.
- Defined in ui-router-core/src/url/urlMatcherFactory.ts:50

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

Parameters
- value: Optional boolean | string
Returns string | false | true
- Defined in ui-router-core/src/url/urlMatcherFactory.ts:89

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.
- Defined in ui-router-core/src/url/urlMatcherFactory.ts:66

strictMode(value?: boolean): boolean

Parameters
- value: Optional boolean
Returns boolean
- Defined in ui-router-core/src/url/urlMatcherFactory.ts:92

type(name: string, definition?: ParamTypeDefinition, definitionFn?: function): any

Parameters
- name string
- definition: Optional ParamTypeDefinition
- definitionFn: Optional function
  - - (): ParamTypeDefinition
    - Returns ParamTypeDefinition
Returns any
- Defined in ui-router-core/src/url/urlMatcherFactory.ts:95

Generated using TypeDoc