Skip to main content

Class: RouteFactory

@ima/core.RouteFactory

Utility factory used by router to create routes.

Constructors

constructor

new RouteFactory()

Accessors

$dependencies

Static get $dependencies(): never[]

Returns

never[]

Defined in

packages/core/src/router/RouteFactory.ts:10

Methods

createRoute

createRoute(name, pathExpression, controller, view, options?): DynamicRoute | StaticRoute

Create new instance of ima.core.router.AbstractRoute.

Parameters

NameTypeDescription
namestringThe unique name of this route, identifying it among the rest of the routes in the application.
pathExpressionstring | RoutePathExpressionA path expression specifying either the URL path part matching this route (must not\ contain a query string) with optionally containing named parameter placeholders specified as :parameterName. Or object defining matcher in form of regular expression and toPath and extractParameters function overrides.
controllerAsyncRouteControllerThe full name of Object Container alias identifying the controller associated with this route.
viewAsyncRouteViewThe full name or Object Container alias identifying the view class associated with this route.
options?Partial<RouteFactoryOptions>The route additional options.

Returns

DynamicRoute | StaticRoute

The constructed route.

Defined in

packages/core/src/router/RouteFactory.ts:32