Import path: @buildkitgg/tanstack-router

Home > @buildkitgg/tanstack-router > createRouterAdapter

createRouterAdapter() function

Create once per router, or once per SSR request.

Signature:

export declare function createRouterAdapter<TRouter extends AnyRouter = RegisteredRouter>(router: TRouter): {
    subscribe(listener: () => void): () => void;
    getSnapshot(): string;
    getServerSnapshot(): string;
    route: <const TOptions>(options: ValidateNavigateOptions<TRouter, TOptions>, match?: MatchRouteOptions) => RouteTarget;
};

Parameters

Parameter	Type	Description
router	TRouter

Returns:

{ subscribe(listener: () => void): () => void; getSnapshot(): string; getServerSnapshot(): string; route: <const TOptions>(options: ValidateNavigateOptions<TRouter, TOptions>, match?: MatchRouteOptions) => RouteTarget; }