본문으로 건너뛰기

usePrefetchInfiniteQuery

usePrefetchInfiniteQuery(options)

옵션

queryClient.infiniteQuery에 전달할 수 있는 모든 항목을 usePrefetchInfiniteQuery에 전달할 수 있습니다. 아래와 같이 일부 항목은 필수라는 점을 기억하세요:

  • queryKey: QueryKey

    • Required
    • 렌더링 중 프리페치할 쿼리 키
  • queryFn: (context: QueryFunctionContext) => Promise<TData>

    • 필수이지만 기본 쿼리 함수가 정의되지 않은 경우에만 해당합니다 자세한 내용은 기본 쿼리 함수를 참조하세요.
  • initialPageParam: TPageParam

    • Required
    • 첫 페이지를 가져올 때 사용할 기본 페이지 매개변수입니다.
  • getNextPageParam: (lastPage, allPages, lastPageParam, allPageParams) => TPageParam | undefined | null

    • Required
    • 이 쿼리에 대한 새 데이터가 수신되면 이 함수는 무한 데이터 목록의 마지막 페이지와 모든 페이지의 전체 배열뿐만 아니라 pageParam 정보도 받습니다.
    • 쿼리 함수의 마지막 선택적 매개변수로 전달될 단일 변수를 반환해야 합니다.
    • 사용 가능한 다음 페이지가 없음을 나타내려면 undefined 또는 null을 반환합니다.
  • 반환값

usePrefetchInfiniteQuery는 아무것도 반환하지 않으며, useSuspenseInfiniteQuery를 사용하는 컴포넌트를 감싸는 suspense boundary 앞에서 렌더링 중 프리페치를 실행하는 용도로만 사용해야 합니다.