UrlMatcherFactory | @uirouter/react

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

Methods

Constructors

constructor

new UrlMatcherFactory(router: UIRouter): UrlMatcherFactory

- Defined in @uirouter/core/src/url/urlMatcherFactory.ts:35
Parameters
- router: UIRouter
Returns UrlMatcherFactory

Properties

Param

Param: typeof Param = Param

UrlMatcher

UrlMatcher: typeof UrlMatcher = UrlMatcher

paramFactory

paramFactory: ParamFactory = new ParamFactory(this.router)

Creates a new Param for a given location (DefType)

Methods

caseInsensitive

caseInsensitive(value?: boolean): boolean

- Defined in @uirouter/core/src/url/urlMatcherFactory.ts:87
deprecated

use UrlConfig.caseInsensitive

Parameters
- Optional value: boolean
Returns boolean

compile

compile(pattern: string, config?: UrlMatcherCompileConfig): UrlMatcher

- Defined in @uirouter/core/src/url/urlMatcherFactory.ts:47
Creates a UrlMatcher for the specified pattern.

Parameters
- pattern: string
  
  The URL pattern.
- Optional config: UrlMatcherCompileConfig
  
  The config object hash.
Returns UrlMatcher

The UrlMatcher.

defaultSquashPolicy

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

- Defined in @uirouter/core/src/url/urlMatcherFactory.ts:90
deprecated

use UrlConfig.defaultSquashPolicy

Parameters
- Optional value: boolean | string
Returns string | false | true

isMatcher

isMatcher(object: any): boolean

- Defined in @uirouter/core/src/url/urlMatcherFactory.ts:67
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

strictMode(value?: boolean): boolean

- Defined in @uirouter/core/src/url/urlMatcherFactory.ts:93
deprecated

use UrlConfig.strictMode

Parameters
- Optional value: boolean
Returns boolean

type

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

- Defined in @uirouter/core/src/url/urlMatcherFactory.ts:96
deprecated

use UrlConfig.type

Parameters
- name: string
- Optional definition: ParamTypeDefinition
- Optional definitionFn: () => ParamTypeDefinition
  - - (): ParamTypeDefinition
    - Returns ParamTypeDefinition
Returns any

Generated using TypeDoc