API Documentation / @pinia/colada / defineInfiniteQueryOptions

Function: defineInfiniteQueryOptions()

Define type-safe infinite query options. Can be static or dynamic. Define the arguments based on what's needed on the query and the key.

Param

The infinite query options or a function that returns them.

Example

import { defineInfiniteQueryOptions } from '@pinia/colada'

const itemsQuery = defineInfiniteQueryOptions({
  key: ['items'],
  query: ({ pageParam }) => fetchItems(pageParam),
  initialPageParam: 0,
  getNextPageParam: (lastPage) => lastPage.nextCursor,
})

queryCache.getQueryData(itemsQuery.key) // typed

@NO_SIDE_EFFECTS

Call Signature

function defineInfiniteQueryOptions<Params, TData, TError, TPageParam, TDataInitial>(setupOptions): (params?) => DefineInfiniteQueryOptionsTagged<TData, TError, TPageParam, TDataInitial>;

Define dynamic infinite query options by passing a function that accepts an optional arbitrary parameter and returns the query options. Enables type-safe query keys. Pass to useInfiniteQuery as a single function: useInfiniteQuery(() => setupOptions(params)).

Type Parameters

Params

Params

TData

TData

TError

TError = { custom: Error; }

TPageParam

TPageParam = unknown

TDataInitial

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

Parameters

setupOptions

(params?) => UseInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>

A function that returns the infinite query options.

Returns

(params?) => DefineInfiniteQueryOptionsTagged<TData, TError, TPageParam, TDataInitial>

Call Signature

function defineInfiniteQueryOptions<Params, TData, TError, TPageParam, TDataInitial>(setupOptions): (params) => DefineInfiniteQueryOptionsTagged<TData, TError, TPageParam, TDataInitial>;

Define dynamic infinite query options by passing a function that accepts an arbitrary parameter and returns the query options. Enables type-safe query keys. Pass to useInfiniteQuery as a single function: useInfiniteQuery(() => setupOptions(params)).

Type Parameters

Params

Params

TData

TData

TError

TError = { custom: Error; }

TPageParam

TPageParam = unknown

TDataInitial

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

Parameters

setupOptions

(params) => UseInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>

A function that returns the infinite query options.

Returns

(params) => DefineInfiniteQueryOptionsTagged<TData, TError, TPageParam, TDataInitial>

Call Signature

function defineInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>(options): DefineInfiniteQueryOptionsTagged<TData, TError, TPageParam, TDataInitial>;

Define static infinite query options that are type safe with queryCache.getQueryData(). Can be passed directly to useInfiniteQuery.

Type Parameters

TData

TData

TError

TError = { custom: Error; }

TPageParam

TPageParam = unknown

TDataInitial

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

Parameters

options

UseInfiniteQueryOptions<TData, TError, TPageParam, TDataInitial>

The infinite query options.

Returns

DefineInfiniteQueryOptionsTagged<TData, TError, TPageParam, TDataInitial>