0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/vue/reference/classes/QueryCache.md
Wonsuk Choi 309508612a
docs(vue-query): add JSDoc and generate reference docs with TypeDoc (#11378)
* docs(vue-query): add JSDoc across the package

* docs(vue-query): generate reference docs with TypeDoc

* docs(config): register vue-query TypeDoc reference pages

* docs(vue-query): preserve dehydrate/hydrate option docs and fix reference links

* docs(config): reorder vue-query reference nav to list 'Functions' first

* docs(config): reorder vue-query 'Functions' entries to match react/preact grouping

* docs(vue-query): restore Suspense guide link and 'placeholderData' behavior note lost in TypeDoc migration

* docs(vue-query): correct JSDoc accuracy issues and reactivity bugs

* docs(vue-query): fix invalidateQueries example that invalidated every query, add whole-options getter example

* docs(vue-query): add examples for the mutationOptions and useInfiniteQuery getter overloads

* docs(vue-query): add react-parity examples for select, skipToken, keepPreviousData, optimistic updates, and infinite scroll

* docs(vue-query): add queryOptions select typing example to useQueries

* docs(vue-query): disconnect IntersectionObserver on unmount, drop non-null assertion in skipToken examples

* docs(vue-query): add 'skipToken' factory example to 'queryOptions'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'useQuery'/'useInfiniteQuery'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'QueryOptions' type JSDoc

* docs(vue-query): fix reversed claim that 'queryKey' entries can't be reactive getters
2026-09-05 13:29:11 +09:00

1.8 KiB

id title
QueryCache QueryCache

Defined in: vue-query/src/queryCache.ts:16

Vue-aware subclass of @tanstack/query-core's QueryCache. find/findAll also accept a MaybeRefDeep filters object, so refs can be passed directly without unwrapping. Access it via queryClient.getQueryCache() — QueryClient constructs one of these by default.

Extends

  • QueryCache

Constructors

Constructor

new QueryCache(config?): QueryCache;

Defined in: query-core/dist-ts/src/queryCache.d.ts:57

Parameters

config?

QueryCacheConfig

Returns

QueryCache

Inherited from

QC.constructor

Methods

find()

find<TQueryFnData, TError, TData>(filters): 
  | Query<TQueryFnData, TError, TData, readonly unknown[]>
  | undefined;

Defined in: vue-query/src/queryCache.ts:17

Type Parameters

TQueryFnData

TQueryFnData = unknown

TError

TError = Error

TData

TData = TQueryFnData

Parameters

filters

MaybeRefDeep<WithRequired<QueryFilters<readonly unknown[]>, "queryKey">>

Returns

| Query<TQueryFnData, TError, TData, readonly unknown[]> | undefined

Overrides

QC.find

findAll()

findAll(filters): Query<unknown, Error, unknown, readonly unknown[]>[];

Defined in: vue-query/src/queryCache.ts:23

Parameters

filters

MaybeRefDeep<QueryFilters<readonly unknown[]>> = {}

Returns

Query<unknown, Error, unknown, readonly unknown[]>[]

Overrides

QC.findAll