@chubbyts/chubbyts-framework-router-path-to-regexp
Version:
Path-to-regex routing implementation for chubbyts-framework.
40 lines (39 loc) • 2.05 kB
TypeScript
import type { Match } from '@chubbyts/chubbyts-framework/dist/router/route-matcher';
import type { RoutesByName } from '@chubbyts/chubbyts-framework/dist/router/routes-by-name';
import type { GeneratePath, GenerateUrl } from '@chubbyts/chubbyts-framework/dist/router/url-generator';
/**
* ```ts
* import type { Match } from '@chubbyts/chubbyts-framework/dist/router/route-matcher';
* import type { RoutesByName } from '@chubbyts/chubbyts-framework/dist/router/routes-by-name';
* import { createPathToRegexpRouteMatcher } from '@chubbyts/chubbyts-framework-router-path-to-regexp/dist/path-to-regexp-router';
*
* const routesByName: RoutesByName = ...;
*
* const pathToRegexpRouteMatcher: Match = createPathToRegexpRouteMatcher(routesByName);
* ```
*/
export declare const createPathToRegexpRouteMatcher: (routesByName: RoutesByName) => Match;
/**
* ```ts
* import type { GeneratePath } from '@chubbyts/chubbyts-framework/dist/router/url-generator';
* import type { RoutesByName } from '@chubbyts/chubbyts-framework/dist/router/routes-by-name';
* import { createPathToRegexpPathGenerator } from '@chubbyts/chubbyts-framework-router-path-to-regexp/dist/path-to-regexp-router';
*
* const routesByName: RoutesByName = ...;
*
* const pathToRegexpPathGenerator: GeneratePath = createPathToRegexpPathGenerator(routesByName);
* ```
*/
export declare const createPathToRegexpPathGenerator: (routesByName: RoutesByName) => GeneratePath;
/**
* ```ts
* import type { GeneratePath, GenerateUrl } from '@chubbyts/chubbyts-framework/dist/router/url-generator';
* import type { RoutesByName } from '@chubbyts/chubbyts-framework/dist/router/routes-by-name';
* import { createPathToRegexpUrlGenerator } from '@chubbyts/chubbyts-framework-router-path-to-regexp/dist/path-to-regexp-router';
*
* const generatePath: GeneratePath = ...;
*
* const pathToRegexpUrlGenerator: GenerateUrl = createPathToRegexpUrlGenerator(generatePath);
* ```
*/
export declare const createPathToRegexpUrlGenerator: (generatePath: GeneratePath) => GenerateUrl;