@@ -69,7 +69,7 @@ while this is `true`. Defaults to `false` if no persister is configured.
6969cancelQueries <TTaggedQueryKey >(filters ?: QueryFilters < TTaggedQueryKey > , options ?: MaybeRefDeep < CancelOptions > ): Promise < void > ;
7070```
7171
72- Defined in: [ packages/vue-query/src/queryClient.ts:193 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L193 )
72+ Defined in: [ packages/vue-query/src/queryClient.ts:196 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L196 )
7373
7474Cancels outgoing fetches for queries matching the given filters. Most useful when performing
7575optimistic updates, since any outgoing refetch that resolves afterwards would otherwise
@@ -322,7 +322,7 @@ QC.ensureInfiniteQueryData
322322ensureQueryData <TQueryFnData , TError , TData , TQueryKey >(options : EnsureQueryDataOptions < TQueryFnData , TError , TData , TQueryKey > ): Promise < TData > ;
323323```
324324
325- Defined in: [ packages/vue-query/src/queryClient.ts:90 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L90 )
325+ Defined in: [ packages/vue-query/src/queryClient.ts:93 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L93 )
326326
327327##### Type Parameters
328328
@@ -368,7 +368,7 @@ QC.ensureQueryData
368368ensureQueryData <TQueryFnData , TError , TData , TQueryKey >(options : MaybeRefDeep < EnsureQueryDataOptions < TQueryFnData , TError , TData , TQueryKey , never >> ): Promise < TData > ;
369369```
370370
371- Defined in: [ packages/vue-query/src/queryClient.ts:98 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L98 )
371+ Defined in: [ packages/vue-query/src/queryClient.ts:101 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L101 )
372372
373373##### Type Parameters
374374
@@ -418,7 +418,7 @@ QC.ensureQueryData
418418fetchInfiniteQuery <TQueryFnData , TError , TData , TQueryKey , TPageParam >(options : FetchInfiniteQueryOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam > ): Promise < InfiniteData < TData , TPageParam >> ;
419419```
420420
421- Defined in: [ packages/vue-query/src/queryClient.ts:474 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L474 )
421+ Defined in: [ packages/vue-query/src/queryClient.ts:477 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L477 )
422422
423423##### Type Parameters
424424
@@ -468,7 +468,7 @@ QC.fetchInfiniteQuery
468468fetchInfiniteQuery <TQueryFnData , TError , TData , TQueryKey , TPageParam >(options : MaybeRefDeep < FetchInfiniteQueryOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam >> ): Promise < InfiniteData < TData , TPageParam >> ;
469469```
470470
471- Defined in: [ packages/vue-query/src/queryClient.ts:489 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L489 )
471+ Defined in: [ packages/vue-query/src/queryClient.ts:492 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L492 )
472472
473473##### Type Parameters
474474
@@ -522,7 +522,7 @@ QC.fetchInfiniteQuery
522522fetchQuery <TQueryFnData , TError , TData , TQueryKey , TPageParam >(options : FetchQueryOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam > ): Promise < TData > ;
523523```
524524
525- Defined in: [ packages/vue-query/src/queryClient.ts:321 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L321 )
525+ Defined in: [ packages/vue-query/src/queryClient.ts:324 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L324 )
526526
527527##### Type Parameters
528528
@@ -574,7 +574,7 @@ fetchQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options:
574574| () => FetchQueryOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam > ): Promise < TData > ;
575575```
576576
577- Defined in: [ packages/vue-query/src/queryClient.ts:336 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L336 )
577+ Defined in: [ packages/vue-query/src/queryClient.ts:339 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L339 )
578578
579579##### Type Parameters
580580
@@ -694,7 +694,7 @@ QC.getMutationCache
694694getMutationDefaults (mutationKey : MaybeRefDeep < readonly unknown []> ): MutationObserverOptions < any , any , any , any > ;
695695```
696696
697- Defined in: [ packages/vue-query/src/queryClient.ts:624 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L624 )
697+ Defined in: [ packages/vue-query/src/queryClient.ts:627 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L627 )
698698
699699Returns the default options registered for mutations whose mutation key partially matches
700700the given ` mutationKey ` , via [ QueryClient#setMutationDefaults] ( #setmutationdefaults ) . If multiple registered
@@ -735,7 +735,7 @@ QC.getMutationDefaults
735735getQueriesData <TData >(filters : MaybeRefDeep < QueryFilters < readonly unknown []>> ): [readonly unknown [], TData | undefined ][];
736736```
737737
738- Defined in: [ packages/vue-query/src/queryClient.ts:122 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L122 )
738+ Defined in: [ packages/vue-query/src/queryClient.ts:125 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L125 )
739739
740740Imperative (non-reactive) way to retrieve the cached data of multiple queries at once.
741741Only queries matching the given filters are returned; if none match, an empty array is
@@ -878,7 +878,7 @@ QC.getQueryData
878878getQueryData <TData >(queryKey : MaybeRefDeep < readonly unknown []> ): TData | undefined ;
879879```
880880
881- Defined in: [ packages/vue-query/src/queryClient.ts:78 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L78 )
881+ Defined in: [ packages/vue-query/src/queryClient.ts:81 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L81 )
882882
883883##### Type Parameters
884884
@@ -910,7 +910,7 @@ QC.getQueryData
910910getQueryDefaults (queryKey : MaybeRefDeep < readonly unknown []> ): OmitKeyof < QueryObserverOptions < any , any , any , any , any > , " queryKey" > ;
911911```
912912
913- Defined in: [ packages/vue-query/src/queryClient.ts:601 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L601 )
913+ Defined in: [ packages/vue-query/src/queryClient.ts:604 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L604 )
914914
915915Returns the default options registered for queries whose query key partially matches the
916916given ` queryKey ` , via [ QueryClient#setQueryDefaults] ( #setquerydefaults ) . If multiple registered defaults
@@ -953,7 +953,7 @@ getQueryState<TData, TError>(queryKey: MaybeRefDeep<readonly unknown[]>):
953953 | undefined ;
954954```
955955
956- Defined in: [ packages/vue-query/src/queryClient.ts:169 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L169 )
956+ Defined in: [ packages/vue-query/src/queryClient.ts:172 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L172 )
957957
958958Imperative (non-reactive) way to retrieve an existing query's state. If the query does not
959959exist, ` undefined ` is returned.
@@ -1006,7 +1006,7 @@ QC.getQueryState
10061006infiniteQuery <TQueryFnData , TError , TData , TQueryKey , TPageParam >(options : InfiniteQueryExecuteOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam > ): Promise < TData [] extends InfiniteData < TQueryFnData , unknown > [] ? InfiniteData < TQueryFnData , TPageParam > : TData > ;
10071007```
10081008
1009- Defined in: [ packages/vue-query/src/queryClient.ts:407 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L407 )
1009+ Defined in: [ packages/vue-query/src/queryClient.ts:410 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L410 )
10101010
10111011Asynchronous method to fetch and cache an infinite query, resolving with an
10121012[ InfiniteData] ( ../interfaces/InfiniteData.md ) object or throwing with the error.
@@ -1079,7 +1079,7 @@ QC.infiniteQuery
10791079infiniteQuery <TQueryFnData , TError , TData , TQueryKey , TPageParam >(options : MaybeRefDeep < InfiniteQueryExecuteOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam >> ): Promise < TData [] extends InfiniteData < TQueryFnData , unknown > [] ? InfiniteData < TQueryFnData , TPageParam > : TData > ;
10801080```
10811081
1082- Defined in: [ packages/vue-query/src/queryClient.ts:426 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L426 )
1082+ Defined in: [ packages/vue-query/src/queryClient.ts:429 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L429 )
10831083
10841084##### Type Parameters
10851085
@@ -1129,7 +1129,7 @@ invalidateQueries<TTaggedQueryKey>(filters?:
11291129| () => InvalidateQueryFilters < TTaggedQueryKey > , options ?: MaybeRefDeep < InvalidateOptions > ): Promise < void > ;
11301130```
11311131
1132- Defined in: [ packages/vue-query/src/queryClient.ts:204 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L204 )
1132+ Defined in: [ packages/vue-query/src/queryClient.ts:207 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L207 )
11331133
11341134Marks queries matching the given filters as invalidated. Unlike
11351135[ QueryClient#removeQueries] ( #removequeries ) , invalidated queries stay in the cache.
@@ -1299,7 +1299,7 @@ QC.mount
12991299prefetchInfiniteQuery <TQueryFnData , TError , TData , TQueryKey , TPageParam >(options : FetchInfiniteQueryOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam > ): Promise < void > ;
13001300```
13011301
1302- Defined in: [ packages/vue-query/src/queryClient.ts:530 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L530 )
1302+ Defined in: [ packages/vue-query/src/queryClient.ts:533 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L533 )
13031303
13041304##### Type Parameters
13051305
@@ -1349,7 +1349,7 @@ QC.prefetchInfiniteQuery
13491349prefetchInfiniteQuery <TQueryFnData , TError , TData , TQueryKey , TPageParam >(options : MaybeRefDeep < FetchInfiniteQueryOptions < TQueryFnData , TError , TData , TQueryKey , TPageParam >> ): Promise < void > ;
13501350```
13511351
1352- Defined in: [ packages/vue-query/src/queryClient.ts:545 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L545 )
1352+ Defined in: [ packages/vue-query/src/queryClient.ts:548 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L548 )
13531353
13541354##### Type Parameters
13551355
@@ -1403,7 +1403,7 @@ QC.prefetchInfiniteQuery
14031403prefetchQuery <TQueryFnData , TError , TData , TQueryKey >(options : FetchQueryOptions < TQueryFnData , TError , TData , TQueryKey > ): Promise < void > ;
14041404```
14051405
1406- Defined in: [ packages/vue-query/src/queryClient.ts:373 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L373 )
1406+ Defined in: [ packages/vue-query/src/queryClient.ts:376 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L376 )
14071407
14081408##### Type Parameters
14091409
@@ -1449,7 +1449,7 @@ QC.prefetchQuery
14491449prefetchQuery <TQueryFnData , TError , TData , TQueryKey >(options : MaybeRefDeep < FetchQueryOptions < TQueryFnData , TError , TData , TQueryKey , never >> ): Promise < void > ;
14501450```
14511451
1452- Defined in: [ packages/vue-query/src/queryClient.ts:381 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L381 )
1452+ Defined in: [ packages/vue-query/src/queryClient.ts:384 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L384 )
14531453
14541454##### Type Parameters
14551455
@@ -1499,7 +1499,7 @@ QC.prefetchQuery
14991499query <TQueryFnData , TError , TData , TQueryData , TQueryKey , TPageParam >(options : QueryExecuteOptions < TQueryFnData , TError , TData , TQueryData , TQueryKey , TPageParam > ): Promise < TData > ;
15001500```
15011501
1502- Defined in: [ packages/vue-query/src/queryClient.ts:260 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L260 )
1502+ Defined in: [ packages/vue-query/src/queryClient.ts:263 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L263 )
15031503
15041504Asynchronous method to fetch and cache a query, resolving with the data or throwing with
15051505the error.
@@ -1586,7 +1586,7 @@ QC.query
15861586query <TQueryFnData , TError , TData , TQueryData , TQueryKey , TPageParam >(options : MaybeRefDeep < QueryExecuteOptions < TQueryFnData , TError , TData , TQueryData , TQueryKey , TPageParam >> ): Promise < TData > ;
15871587```
15881588
1589- Defined in: [ packages/vue-query/src/queryClient.ts:277 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L277 )
1589+ Defined in: [ packages/vue-query/src/queryClient.ts:280 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L280 )
15901590
15911591##### Type Parameters
15921592
@@ -1638,7 +1638,7 @@ QC.query
16381638refetchQueries <TTaggedQueryKey >(filters ?: RefetchQueryFilters < TTaggedQueryKey > , options ?: MaybeRefDeep < RefetchOptions > ): Promise < void > ;
16391639```
16401640
1641- Defined in: [ packages/vue-query/src/queryClient.ts:244 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L244 )
1641+ Defined in: [ packages/vue-query/src/queryClient.ts:247 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L247 )
16421642
16431643Refetches queries matching the given filters, regardless of whether they are stale. Without
16441644filters, every query in the cache is refetched. Queries that are disabled, or static (only
@@ -1697,7 +1697,7 @@ QC.refetchQueries
16971697removeQueries <TTaggedQueryKey >(filters ?: QueryFilters < TTaggedQueryKey > ): void ;
16981698```
16991699
1700- Defined in: [ packages/vue-query/src/queryClient.ts:175 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L175 )
1700+ Defined in: [ packages/vue-query/src/queryClient.ts:178 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L178 )
17011701
17021702Removes queries from the cache that match the given filters. Unlike
17031703[ QueryClient#invalidateQueries] ( #invalidatequeries ) or [ QueryClient#refetchQueries] ( #refetchqueries ) , this removes
@@ -1743,7 +1743,7 @@ QC.removeQueries
17431743resetQueries <TTaggedQueryKey >(filters ?: QueryFilters < TTaggedQueryKey > , options ?: MaybeRefDeep < ResetOptions > ): Promise < void > ;
17441744```
17451745
1746- Defined in: [ packages/vue-query/src/queryClient.ts:182 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L182 )
1746+ Defined in: [ packages/vue-query/src/queryClient.ts:185 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L185 )
17471747
17481748Resets queries matching the given filters back to their initial state (e.g. any
17491749` initialData ` ), notifying subscribers rather than removing them. Active queries among the
@@ -1831,7 +1831,7 @@ QC.resumePausedMutations
18311831setDefaultOptions (options : MaybeRefDeep < DefaultOptions < Error >> ): void ;
18321832```
18331833
1834- Defined in: [ packages/vue-query/src/queryClient.ts:583 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L583 )
1834+ Defined in: [ packages/vue-query/src/queryClient.ts:586 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L586 )
18351835
18361836Dynamically sets the default options for this client, overwriting any previously defined
18371837default options.
@@ -1879,7 +1879,7 @@ QC.setDefaultOptions
18791879setMutationDefaults <TData , TError , TVariables , TOnMutateResult >(mutationKey : MaybeRefDeep < readonly unknown []> , options : MaybeRefDeep < MutationObserverOptions < TData , TError , TVariables , TOnMutateResult >> ): void ;
18801880```
18811881
1882- Defined in: [ packages/vue-query/src/queryClient.ts:607 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L607 )
1882+ Defined in: [ packages/vue-query/src/queryClient.ts:610 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L610 )
18831883
18841884Sets default options for mutations whose mutation key partially matches the given
18851885` mutationKey ` . As with [ QueryClient#setQueryDefaults] ( #setquerydefaults ) , the order of registration
@@ -1948,7 +1948,7 @@ setQueriesData<TData>(
19481948 options : MaybeRefDeep < SetDataOptions > ): [readonly unknown [], TData | undefined ][];
19491949```
19501950
1951- Defined in: [ packages/vue-query/src/queryClient.ts:157 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L157 )
1951+ Defined in: [ packages/vue-query/src/queryClient.ts:160 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L160 )
19521952
19531953Synchronous way to immediately update the cached data of multiple queries at once, using
19541954filters or partial query key matching. Only queries that already exist and match the given
@@ -2016,7 +2016,7 @@ setQueryData<TQueryFnData, TTaggedQueryKey, TInferredQueryFnData>(
20162016 options ?: MaybeRefDeep < SetDataOptions > ): NoInfer < TInferredQueryFnData > | undefined ;
20172017```
20182018
2019- Defined in: [ packages/vue-query/src/queryClient.ts:128 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L128 )
2019+ Defined in: [ packages/vue-query/src/queryClient.ts:131 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L131 )
20202020
20212021Synchronous way to immediately update a query's cached data. If the updater (or the value
20222022passed) resolves to ` undefined ` , the cache is left untouched and no query is created;
@@ -2092,7 +2092,7 @@ setQueryData<TQueryFnData, TData>(
20922092 options ?: MaybeRefDeep < SetDataOptions > ): NoInfer < TData > | undefined ;
20932093```
20942094
2095- Defined in: [ packages/vue-query/src/queryClient.ts:140 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L140 )
2095+ Defined in: [ packages/vue-query/src/queryClient.ts:143 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L143 )
20962096
20972097##### Type Parameters
20982098
@@ -2136,7 +2136,7 @@ QC.setQueryData
21362136setQueryDefaults <TQueryFnData , TError , TData , TQueryData >(queryKey : MaybeRefDeep < readonly unknown []> , options : MaybeRefDeep < Omit < UseQueryOptions < TQueryFnData , TError , TData , TQueryData > , " queryKey" >> ): void ;
21372137```
21382138
2139- Defined in: [ packages/vue-query/src/queryClient.ts:587 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L587 )
2139+ Defined in: [ packages/vue-query/src/queryClient.ts:590 ] ( https://github.com/TanStack/query/blob/main/packages/vue-query/src/queryClient.ts#L590 )
21402140
21412141Sets default options for queries whose query key partially matches the given ` queryKey ` .
21422142
0 commit comments