API Documentation / @pinia/colada / UseInfiniteQueryOptions

Interface: UseInfiniteQueryOptions<TResult, TError, TDataInitial, TPages>

Experimental

Options for useInfiniteQuery.

See https://github.com/posva/pinia-colada/issues/178

Extends

• Omit<UseQueryOptions<TResult, TError, TDataInitial>, "query" | "initialData" | "placeholderData">

Type Parameters

TResult

TResult

TError

TError

TDataInitial

TDataInitial extends TResult | undefined = TResult | undefined

TPages

TPages = unknown

Properties

autoRefetch?

optional autoRefetch: MaybeRefOrGetter<boolean>;

Experimental

Whether to enable auto refresh by default.

Default

false

Inherited from

Omit.autoRefetch

---

delay?

optional delay: number | false;

Experimental

Delay in milliseconds to wait before letting the asyncStatus become 'loading'. Set to false or 0 to disable. Requires the PiniaColadaDelay plugin.

Default

200

Inherited from

Omit.delay

---

enabled?

optional enabled: MaybeRefOrGetter<boolean>;

Experimental

Whether the query should be enabled or not. If false, the query will not be executed until refetch() or refresh() is called. If it becomes true, the query will be refreshed.

Inherited from

Omit.enabled

---

gcTime?

optional gcTime: number | false;

Experimental

Time in ms after which, once the data is no longer being used, it will be garbage collected to free resources. Set to false to disable garbage collection.

Default

300_000 (5 minutes)

Inherited from

Omit.gcTime

---

initialPage

initialPage: TPages | () => TPages;

Experimental

---

key

key: MaybeRefOrGetter<readonly (EntryNodeKey | _ObjectFlat)[]>;

Experimental

The key used to identify the query. Array of primitives without reactive values or a reactive array or getter. It should be treaded as an array of dependencies of your queries, e.g. if you use the route.params.id property, it should also be part of the key:

import { useRoute } from 'vue-router'
import { useQuery } from '@pinia/colada'

const route = useRoute()
const { data } = useQuery({
  // pass a getter function (or computed, ref, etc.) to ensure reactivity
  key: () => ['user', route.params.id],
  query: () => fetchUser(route.params.id),
})

Inherited from

Omit.key

---

merge()

merge: (result, current) => NoInfer<TPages>;

Experimental

Parameters

result

NoInfer<TPages>

current

NoInfer<TResult>

Returns

NoInfer<TPages>

---

query()

query: (pages, context) => Promise<TResult>;

Experimental

The function that will be called to fetch the data. It must be async.

Parameters

pages

NoInfer<TPages>

context

UseQueryFnContext

Returns

Promise<TResult>

---

refetchOnMount?

optional refetchOnMount: MaybeRefOrGetter<RefetchOnControl>;

Experimental

Whether to refetch the query when the component is mounted.

Default

true

Inherited from

Omit.refetchOnMount

---

refetchOnReconnect?

optional refetchOnReconnect: MaybeRefOrGetter<RefetchOnControl>;

Experimental

Whether to refetch the query when the network reconnects.

Default

true

Inherited from

Omit.refetchOnReconnect

---

refetchOnWindowFocus?

optional refetchOnWindowFocus: MaybeRefOrGetter<RefetchOnControl>;

Experimental

Whether to refetch the query when the window regains focus.

Default

true

Inherited from

Omit.refetchOnWindowFocus

---

retry?

optional retry: 
  | number
  | RetryOptions
  | (failureCount, error) => boolean;

Experimental

Options for the retries of this query added by @pinia/colada-plugin-retry.

Inherited from

Omit.retry

---

staleTime?

optional staleTime: number;

Experimental

Time in ms after which the data is considered stale and will be refreshed on next read.

Default

5000 (5 seconds)

Inherited from

Omit.staleTime