UseReactorSuspenseInfiniteQueryParameters
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:25
Parameters for useActorSuspenseInfiniteQuery hook. Extends react-query’s UseSuspenseInfiniteQueryOptions with custom reactor params.
Extends
Section titled “Extends”Omit<UseSuspenseInfiniteQueryOptions<ReactorQueryData<ReactorReturnOk<Service,Method,Transform>>,ReactorReturnErr<Service,Method,Transform>,Selected,QueryKey,TPageParam>,"queryKey"|"queryFn"|"getNextPageParam"|"initialPageParam">
Type Parameters
Section titled “Type Parameters”Service
Section titled “Service”Service
Method
Section titled “Method”Method extends FunctionName<Service>
Transform
Section titled “Transform”Transform extends TransformKey = "candid"
TPageParam
Section titled “TPageParam”TPageParam = unknown
Selected
Section titled “Selected”Selected = InfiniteData<ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>, TPageParam>
Properties
Section titled “Properties”reactor
Section titled “reactor”reactor:
Reactor<Service,Transform>
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:45
The reactor instance to use for method calls
functionName
Section titled “functionName”functionName:
Method
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:47
The method name to call on the canister
getArgs
Section titled “getArgs”getArgs: (
pageParam) =>ReactorArgs<Service,Method,Transform>
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:49
Function to get args from page parameter
Parameters
Section titled “Parameters”pageParam
Section titled “pageParam”TPageParam
Returns
Section titled “Returns”ReactorArgs<Service, Method, Transform>
callConfig?
Section titled “callConfig?”
optionalcallConfig?:CallConfig
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:51
Agent call configuration (effectiveCanisterId, etc.)
queryKey?
Section titled “queryKey?”
optionalqueryKey?: readonlyunknown[]
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:53
Custom query key (auto-generated if not provided)
initialPageParam
Section titled “initialPageParam”initialPageParam:
TPageParam
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:55
Initial page parameter
getNextPageParam
Section titled “getNextPageParam”getNextPageParam: (
lastPage,allPages,lastPageParam,allPageParams) =>TPageParam|null|undefined
Defined in: react/src/hooks/useActorSuspenseInfiniteQuery.ts:57
Function to determine next page parameter
Parameters
Section titled “Parameters”lastPage
Section titled “lastPage”ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>
allPages
Section titled “allPages”ReactorQueryData<ReactorReturnOk<Service, Method, Transform>>[]
lastPageParam
Section titled “lastPageParam”TPageParam
allPageParams
Section titled “allPageParams”TPageParam[]
Returns
Section titled “Returns”TPageParam | null | undefined