useReactorInfiniteQuery

useReactorInfiniteQuery<Service, Method, Transform, TPageParam, Selected>(__namedParameters): UseReactorInfiniteQueryResult<Service, Method, Transform, TPageParam, Selected>

Defined in: react/src/hooks/useActorInfiniteQuery.ts:150

Hook for executing infinite/paginated query calls on a canister.

Type Parameters

Service

Service

Method

Method extends string

Transform

Transform extends keyof TransformArgsRegistry<unknown> = "candid"

TPageParam

TPageParam = unknown

Selected

Selected = InfiniteData<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>, TPageParam>

Parameters

__namedParameters

UseReactorInfiniteQueryParameters<Service, Method, Transform, TPageParam, Selected>

Returns

UseReactorInfiniteQueryResult<Service, Method, Transform, TPageParam, Selected>

Example

const { data, fetchNextPage, hasNextPage } = useReactorInfiniteQuery({
  reactor,
  functionName: "getItems",
  getArgs: (pageParam) => [{ offset: pageParam, limit: 10 }] as const,
  initialPageParam: 0,
  getNextPageParam: (lastPage) => lastPage.nextOffset,
})

// Wait for the args: no fetch until userId is known
const { data } = useReactorInfiniteQuery({
  reactor,
  functionName: "getUserItems",
  getArgs: userId
    ? (pageParam) => [{ userId, offset: pageParam, limit: 10 }] as const
    : skipToken,
  initialPageParam: 0,
  getNextPageParam: (lastPage) => lastPage.nextOffset,
})