Interface Router<Locales, RouteRef>

interface Router<Locales extends LocaleType | never, RouteRef> {
    find: (
        path: string,
        locale?: Locales,
    ) => null | RouteMatch<Locales, RouteRef>;
    get: (key: string) => EndRoute<Locales, RouteRef>;
    toLocalizedPath: (locale: Locales, key: string, args?: any) => string;
    toPath: (key: string, args?: any) => string;
}

Type Parameters

Properties

find: (path: string, locale?: Locales) => null | RouteMatch<Locales, RouteRef>
get: (key: string) => EndRoute<Locales, RouteRef>
toLocalizedPath: (locale: Locales, key: string, args?: any) => string
toPath: (key: string, args?: any) => string