Class: DynamicRoute
@ima/core.DynamicRoute
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.
Hierarchy
AbstractRoute<RoutePathExpression>↳
DynamicRoute
Constructors
constructor
• new DynamicRoute(name, pathExpression, controller, view, options?)
Initializes the route.
Parameters
| Name | Type | Description |
|---|---|---|
name | string | - |
pathExpression | RoutePathExpression | Path expression used in route matching, to generate valid path with provided params and parsing params from current path. |
controller | AsyncRouteController | - |
view | AsyncRouteView | - |
options? | Partial<RouteFactoryOptions> | - |
Overrides
Defined in
packages/core/src/router/DynamicRoute.ts:58
Properties
_controller
• Protected _controller: Object
The full name of Object Container alias identifying the controller associated with this route.
Type declaration
| Name | Type |
|---|---|
cached | null | RouteController | Promise<RouteController> |
controller | AsyncRouteController |
resolved | boolean |
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:56
_name
• Protected _name: string
The unique name of this route, identifying it among the rest of the routes in the application.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:46
_options
• Protected _options: RouteFactoryOptions
The route additional options.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:74
_pathExpression
• Protected _pathExpression: RoutePathExpression
Path expression used in route matching, to generate valid path with provided params and parsing params from current path.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:51
_view
• Protected _view: Object
The full name or Object Container alias identifying the view class associated with this route.
Type declaration
| Name | Type |
|---|---|
cached | null | RouteView | Promise<RouteView> |
resolved | boolean |
view | AsyncRouteView |
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:65
Methods
extractParameters
▸ extractParameters(path, baseUrl): RouteParams
Extracts the parameter values from the provided path. The method extracts both the in-path parameters and parses the query, allowing the query parameters to override the in-path parameters.
The method returns an empty hash object if the path does not match this route.
Parameters
| Name | Type | Description |
|---|---|---|
path | string | Currently routed path. |
baseUrl | string | Currently routed baseUrl. |
Returns
Map of parameter names to parameter values.
Overrides
AbstractRoute.extractParameters
Defined in
packages/core/src/router/DynamicRoute.ts:112
getController
▸ getController(): RouteController | Promise<RouteController>
Returns Controller class/alias/constant associated with this route. Internally caches async calls for dynamically imported controllers, meaning that once they're loaded, you get the same promise for subsequent calls.
Returns
RouteController | Promise<RouteController>
The Controller class/alias/constant.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:151
getName
▸ getName(): string
Returns the unique identifying name of this route.
Returns
string
The name of the route, identifying it.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:130
getOptions
▸ getOptions(): RouteFactoryOptions
Return route additional options.
Returns
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:208
getPathExpression
▸ getPathExpression(): RoutePathExpression
Path expression used in route matching, to generate valid path with provided params and parsing params from current path.
Returns
The path expression.
Inherited from
AbstractRoute.getPathExpression
Defined in
packages/core/src/router/AbstractRoute.ts:218
getTrimmedPath
▸ getTrimmedPath(path): string
Trims the trailing forward slash from the provided URL path.
Parameters
| Name | Type | Description |
|---|---|---|
path | string | The path to trim. |
Returns
string
Trimmed path.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:228
getView
▸ getView(): RouteView | Promise<RouteView>
Returns View class/alias/constant associated with this route. Internally caches async calls for dynamically imported views, meaning that once they're loaded, you get the same promise for subsequent calls.
Returns
RouteView | Promise<RouteView>
The View class/alias/constant.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:183
isAsync
▸ isAsync(module): boolean
Checks if given argument is an async handler.
Parameters
| Name | Type |
|---|---|
module | unknown |
Returns
boolean
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:137
isControllerResolved
▸ isControllerResolved(): boolean
Returns true for resolved controller. This is always true for sync route views.
Returns
boolean
Inherited from
AbstractRoute.isControllerResolved
Defined in
packages/core/src/router/AbstractRoute.ts:171
isViewResolved
▸ isViewResolved(): boolean
Returns true for resolved view. This is always true for sync route views.
Returns
boolean
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:201
matches
▸ matches(path): boolean
Tests whether the provided URL path matches this route. The provided path may contain the query.
Parameters
| Name | Type | Description |
|---|---|---|
path | string | The URL path. |
Returns
boolean
true if the provided path matches this route.
Overrides
Defined in
packages/core/src/router/DynamicRoute.ts:105
preload
▸ preload(): Promise<[RouteController, RouteView]>
Preloads dynamically imported view and controller.
Returns
Promise<[RouteController, RouteView]>
Promise.All resolving to [view, controller] tuple.
Inherited from
Defined in
packages/core/src/router/AbstractRoute.ts:237
toPath
▸ toPath(params?): string
Creates the URL and query parts of a URL by substituting the route's parameter placeholders by the provided parameter value.
The extraneous parameters that do not match any of the route's placeholders will be appended as the query string.
Parameters
| Name | Type | Description |
|---|---|---|
params | Object | The route parameter values. |
Returns
string
Path and, if necessary, query parts of the URL representing this route with its parameters replaced by the provided parameter values.