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

IMA.js framework for isomorphic javascript application

import { AbstractRoute, AsyncRouteController, AsyncRouteView, RouteParams } from './AbstractRoute';
import { RouteFactoryOptions } from './Router';
/**
 * Path expression type used for router routes definition.
 * @typedef Route~PathExpression
 * @property matcher Regular expression used to match current path
 *           to the specific route.
 * @property toPath Override
 *           for the default toPath which generates valid path from current route
 *           and passed route params.
 * @property extractParameters Override for default method, which
 *           takes care of parsing url params from given path. It should return
 *           object of key/value pairs which correspond to expected path url
 *           params and their values.
 */
export type RoutePathExpression = {
    /**
     * RegExp use in router for path matching to current route.
     */
    matcher: RegExp;
    /**
     * Function that generates valid path from given route params.
     */
    toPath: (params: RouteParams) => string;
    /**
     * 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.
     */
    extractParameters: (trimmedPath: string, additionalData: {
        query: RouteParams;
        path: string;
    }) => RouteParams;
};
/**
 * 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.
 *
 * @extends AbstractRoute
 */
export declare class DynamicRoute extends AbstractRoute<RoutePathExpression> {
    /**
     * Initializes the route.
     *
     * @param pathExpression Path expression used in route matching,
     *        to generate valid path with provided params and parsing params from current path.
     */
    constructor(name: string, pathExpression: RoutePathExpression, controller: AsyncRouteController, view: AsyncRouteView, options?: Partial<RouteFactoryOptions>);
    /**
     * @inheritDoc
     */
    toPath(params?: {}): string;
    /**
     * @inheritDoc
     */
    matches(path: string): boolean;
    /**
     * @inheritDoc
     */
    extractParameters(path: string, baseUrl: string): RouteParams;
}
//# sourceMappingURL=DynamicRoute.d.ts.map