infiniteQueryOptions

Function: infiniteQueryOptions()

Allows to share and re-use infinite query options in a type-safe way.

The queryKey will be tagged with the type from queryFn.

Param

The infinite query options to tag with the type from queryFn.

Call Signature

function infiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam,
>(
  options,
): CreateInfiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam
> &
  object &
  object

function infiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam,
>(
  options,
): CreateInfiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam
> &
  object &
  object

Defined in: infinite-query-options.ts:88

Allows to share and re-use infinite query options in a type-safe way.

The queryKey will be tagged with the type from queryFn.

Type Parameters

• TQueryFnData

• TError = Error

• TData = InfiniteData<TQueryFnData, unknown>

• TQueryKey extends readonly unknown[] = readonly unknown[]

• TPageParam = unknown

Parameters

options

DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>

The infinite query options to tag with the type from queryFn.

Returns

CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & object

The tagged infinite query options.

Param

The infinite query options to tag with the type from queryFn.

Call Signature

function infiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam,
>(
  options,
): OmitKeyof<
  CreateInfiniteQueryOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >,
  'queryFn'
> &
  object &
  object

function infiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam,
>(
  options,
): OmitKeyof<
  CreateInfiniteQueryOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryKey,
    TPageParam
  >,
  'queryFn'
> &
  object &
  object

Defined in: infinite-query-options.ts:119

Allows to share and re-use infinite query options in a type-safe way.

The queryKey will be tagged with the type from queryFn.

Type Parameters

• TQueryFnData

• TError = Error

• TData = InfiniteData<TQueryFnData, unknown>

• TQueryKey extends readonly unknown[] = readonly unknown[]

• TPageParam = unknown

Parameters

options

UnusedSkipTokenInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>

The infinite query options to tag with the type from queryFn.

Returns

OmitKeyof<CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, "queryFn"> & object & object

The tagged infinite query options.

Param

The infinite query options to tag with the type from queryFn.

Call Signature

function infiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam,
>(
  options,
): CreateInfiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam
> &
  object &
  object

function infiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam,
>(
  options,
): CreateInfiniteQueryOptions<
  TQueryFnData,
  TError,
  TData,
  TQueryKey,
  TPageParam
> &
  object &
  object

Defined in: infinite-query-options.ts:150

Allows to share and re-use infinite query options in a type-safe way.

The queryKey will be tagged with the type from queryFn.