next
Version:
The React Framework
27 lines (26 loc) • 860 B
TypeScript
interface Options {
/**
* A transformer function that will be applied to the regexp generated
* from the provided path and path-to-regexp.
*/
regexModifier?: (regex: string) => string;
/**
* When true the function will remove all unnamed parameters
* from the matched parameters.
*/
removeUnnamedParams?: boolean;
/**
* When true the regexp won't allow an optional trailing delimiter
* to match.
*/
strict?: boolean;
}
/**
* Generates a path matcher function for a given path and options based on
* path-to-regexp. By default the match will be case insesitive, non strict
* and delimited by `/`.
*/
export declare function getPathMatch(path: string, options?: Options): <T extends {
[key: string]: any;
}>(pathname?: string | null | undefined, params?: any) => false | T;
export {};