@ima/core/dist/esm/client/router/RouteFactory.d.ts

IMA.js framework for isomorphic javascript application

import { AsyncRouteController, AsyncRouteView } from './AbstractRoute';
import { DynamicRoute, RoutePathExpression } from './DynamicRoute';
import { RouteFactoryOptions } from './Router';
import { StaticRoute } from './StaticRoute';
/**
 * Utility factory used by router to create routes.
 */
export declare class RouteFactory {
    static get $dependencies(): never[];
    /**
     * Create new instance of ima.core.router.AbstractRoute.
     *
     * @param name The unique name of this route, identifying it among
     *        the rest of the routes in the application.
     * @param pathExpression A 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.
     * @param controller The full name of Object Container alias
     *        identifying the controller associated with this route.
     * @param view The full name or Object Container alias identifying
     *        the view class associated with this route.
     * @param options The route additional options.
     * @return The constructed route.
     */
    createRoute(name: string, pathExpression: string | RoutePathExpression, controller: AsyncRouteController, view: AsyncRouteView, options?: Partial<RouteFactoryOptions>): StaticRoute | DynamicRoute;
}
//# sourceMappingURL=RouteFactory.d.ts.map