58 lines
1.8 KiB
TypeScript
58 lines
1.8 KiB
TypeScript
export interface Group {
|
|
pos: number;
|
|
repeat: boolean;
|
|
optional: boolean;
|
|
}
|
|
export interface RouteRegex {
|
|
groups: {
|
|
[groupName: string]: Group;
|
|
};
|
|
re: RegExp;
|
|
}
|
|
/**
|
|
* Parses a given parameter from a route to a data structure that can be used
|
|
* to generate the parametrized route. Examples:
|
|
* - `[...slug]` -> `{ key: 'slug', repeat: true, optional: true }`
|
|
* - `...slug` -> `{ key: 'slug', repeat: true, optional: false }`
|
|
* - `[foo]` -> `{ key: 'foo', repeat: false, optional: true }`
|
|
* - `bar` -> `{ key: 'bar', repeat: false, optional: false }`
|
|
*/
|
|
export declare function parseParameter(param: string): {
|
|
key: string;
|
|
repeat: boolean;
|
|
optional: boolean;
|
|
};
|
|
/**
|
|
* From a normalized route this function generates a regular expression and
|
|
* a corresponding groups object intended to be used to store matching groups
|
|
* from the regular expression.
|
|
*/
|
|
export declare function getRouteRegex(normalizedRoute: string): RouteRegex;
|
|
/**
|
|
* This function extends `getRouteRegex` generating also a named regexp where
|
|
* each group is named along with a routeKeys object that indexes the assigned
|
|
* named group with its corresponding key. When the routeKeys need to be
|
|
* prefixed to uniquely identify internally the "prefixRouteKey" arg should
|
|
* be "true" currently this is only the case when creating the routes-manifest
|
|
* during the build
|
|
*/
|
|
export declare function getNamedRouteRegex(normalizedRoute: string, prefixRouteKey: boolean): {
|
|
namedRegex: string;
|
|
routeKeys: {
|
|
[named: string]: string;
|
|
};
|
|
groups: {
|
|
[groupName: string]: Group;
|
|
};
|
|
re: RegExp;
|
|
};
|
|
/**
|
|
* Generates a named regexp.
|
|
* This is intended to be using for build time only.
|
|
*/
|
|
export declare function getNamedMiddlewareRegex(normalizedRoute: string, options: {
|
|
catchAll?: boolean;
|
|
}): {
|
|
namedRegex: string;
|
|
};
|