DynamicRoute ⇐ AbstractRoute
Utility for representing and manipulating a single dynamic route in the router’s configuration. Dynamic route is defined by regExp used for route matching and overrides for toPath and extractParameters functions to generate and put together valid path.
Kind: global class
Extends: AbstractRoute
- DynamicRoute ⇐
AbstractRoute
- new DynamicRoute(pathExpression)
- ._matcher :
RegExp
- ._toPath :
function
- ._extractParameters :
function
- .toPath()
- .matches()
- .extractParameters()
new DynamicRoute(pathExpression)
Initializes the route.
Param | Type | Description |
---|---|---|
pathExpression | PathExpression |
Path expression used in route matching, to generate valid path with provided params and parsing params from current path. |
dynamicRoute._matcher : RegExp
RegExp use in router for path matching to current route.
Kind: instance property of DynamicRoute
dynamicRoute._toPath : function
Function that generates valid path from current route and passed route params.
Kind: instance property of DynamicRoute
dynamicRoute._extractParameters : function
Function which takes care of parsing url params from given path. It returns object of key/value pairs which correspond to expected path url params and their values.
Kind: instance property of DynamicRoute
dynamicRoute.toPath()
Kind: instance method of DynamicRoute
dynamicRoute.matches()
Kind: instance method of DynamicRoute
dynamicRoute.extractParameters()
Kind: instance method of DynamicRoute