API Documentation / @pinia/colada / DefineInfiniteQueryOptions

Type Alias: DefineInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>

type DefineInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial> = _RemoveMaybeRef<UseInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>, typeof tErrorSymbol | "initialData" | "placeholderData">;

Options to define an infinite query with defineInfiniteQueryOptions(). Similar to UseInfiniteQueryOptions but disallows reactive values.

Type Parameters

TData

TData = unknown

TError

TError = ErrorDefault

TPageParam

TPageParam = unknown

TDataInitial

TDataInitial extends | UseInfiniteQueryData<TData, TPageParam> | undefined = undefined