Docs
API
Deprecated
rootRouteWithContext

rootRouteWithContext function

[!CAUTION] 이 함수는 더 이상 사용되지 않으며, TanStack Router의 다음 주요 버전에서 제거될 예정입니다. 대신 createRootRouteWithContext 함수를 사용하세요.

rootRouteWithContext 함수는 라우터 생성 시 컨텍스트 타입을 충족하도록 요구하는 루트 라우트 인스턴스를 생성하는 데 사용되는 헬퍼 함수입니다.

rootRouteWithContext generics

rootRouteWithContext 함수는 하나의 제네릭 인수를 허용합니다:

TRouterContext generic

  • 타입: TRouterContext
  • 선택 사항, 하지만 권장됨.
  • 라우터 생성 시 충족해야 하는 컨텍스트 타입.

rootRouteWithContext returns

  • 새로운 createRootRoute 인스턴스를 생성하는 데 사용할 수 있는 팩토리 함수.
  • 하나의 인수를 허용하며, 이는 createRootRoute 함수와 동일합니다.

Examples

import { rootRouteWithContext, createRouter } from "@tanstack/react-router";
import { QueryClient } from "@tanstack/react-query";
 
interface MyRouterContext {
  queryClient: QueryClient;
}
 
const rootRoute = rootRouteWithContext<MyRouterContext>()({
  component: () => <Outlet />,
  // ... root route options
});
 
const routeTree = rootRoute.addChildren([
  // ... other routes
]);
 
const queryClient = new QueryClient();
 
const router = createRouter({
  routeTree,
  context: {
    queryClient,
  },
});
NotFoundRouteESLint Plugin Router