Interface RouterBuilder<Locales, RouteRef>

interface RouterBuilder<Locales extends LocaleType | never, RouteRef> {
    add: (path: string, ref: RouteRef, key?: string) => this;
    addLocalized: (
        localizedPaths: LocalizedPathsRecord<Locales>,
        ref: RouteRef,
        key?: string,
    ) => this;
    addLocalizedSegment: (
        localizedPaths: LocalizedPathsRecord<Locales>,
        buildSegment: (builder: SegmentRouterBuilder<Locales, RouteRef>) => void,
    ) => this;
    addSegment: (
        path: string,
        buildSegment: (builder: SegmentRouterBuilder<Locales, RouteRef>) => void,
    ) => this;
    createRouter: () => Router<Locales, RouteRef>;
    getRoutes: () => Routes<Locales, RouteRef>;
}

Type Parameters

Properties

add: (path: string, ref: RouteRef, key?: string) => this
addLocalized: (
    localizedPaths: LocalizedPathsRecord<Locales>,
    ref: RouteRef,
    key?: string,
) => this
addLocalizedSegment: (
    localizedPaths: LocalizedPathsRecord<Locales>,
    buildSegment: (builder: SegmentRouterBuilder<Locales, RouteRef>) => void,
) => this
addSegment: (
    path: string,
    buildSegment: (builder: SegmentRouterBuilder<Locales, RouteRef>) => void,
) => this
createRouter: () => Router<Locales, RouteRef>
getRoutes: () => Routes<Locales, RouteRef>