KatanaKit

Appearance

0

katanakit-js / QueryClient

Class: QueryClient ​

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1284

QueryClient is used to interact with a cache of queries and mutations. It owns a QueryCache and a MutationCache (creating default ones if none are passed in) and holds the default options that are applied to queries and mutations created through it.

Example ​

ts
const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      staleTime: Infinity,
    },
  },
})

await queryClient.query({ queryKey: ['posts'], queryFn: fetchPosts })

Constructors ​

Constructor ​

ts
new QueryClient(config?): QueryClient;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1286

Parameters ​

ParameterType
config?QueryClientConfig

Returns ​

QueryClient

Methods ​

cancelQueries() ​

ts
cancelQueries<TTaggedQueryKey>(filters?, cancelOptions?): Promise<void>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1447

Cancels outgoing fetches for queries matching the given filters. Most useful when performing optimistic updates, since any outgoing refetch that resolves afterwards would otherwise overwrite the optimistic update. By default (revert: true), a cancelled query's data is reverted to its state before the outgoing fetch started.

The returned promise never rejects, even if individual cancellations fail.

Type Parameters ​

Type ParameterDefault type
TTaggedQueryKey extends readonly unknown[]readonly unknown[]

Parameters ​

ParameterType
filters?QueryFilters<TTaggedQueryKey>
cancelOptions?CancelOptions

Returns ​

Promise<void>

Example ​

ts
await queryClient.cancelQueries({ queryKey: ['posts'], exact: true })

clear() ​

ts
clear(): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1697

Clears both the query cache and the mutation cache this client is connected to.

Returns ​

void

Example ​

ts
import { QueryClient } from '@tanstack/query-core'

const queryClient = new QueryClient()
queryClient.clear()

defaultMutationOptions() ​

ts
defaultMutationOptions<T>(options?): T;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1685

The mutation counterpart of QueryClient#defaultQueryOptions. Called by framework adapters (e.g. inside useMutation) to merge queryClient.setMutationDefaults for the given mutationKey, then the client's defaultOptions.mutations, then the caller's options on top. A no-op if the options are already defaulted (_defaulted: true).

Type Parameters ​

Type Parameter
T extends MutationOptions<any, any, any, any>

Parameters ​

ParameterType
options?T

Returns ​

T

defaultQueryOptions() ​

ts
defaultQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>(options): DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1678

Called by framework adapters (e.g. inside useQuery) to resolve the options passed by the caller into their final, defaulted form: merging queryClient.setQueryDefaults for the given queryKey, then the client's own defaultOptions.queries, then the caller's options on top. A no-op if the options are already defaulted (_defaulted: true).

Type Parameters ​

Type ParameterDefault type
TQueryFnDataunknown
TErrorError
TDataTQueryFnData
TQueryDataTQueryFnData
TQueryKey extends readonly unknown[]readonly unknown[]
TPageParamnever

Parameters ​

ParameterType
options| DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> | QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Returns ​

DefaultedQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>

getDefaultOptions() ​

ts
getDefaultOptions(): DefaultOptions;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1603

Returns the default options that were set when creating the client, or via QueryClient#setDefaultOptions.

Returns ​

DefaultOptions

Example ​

ts
import { QueryClient } from '@tanstack/query-core'

const queryClient = new QueryClient()
const defaultOptions = queryClient.getDefaultOptions()

getMutationCache() ​

ts
getMutationCache(): MutationCache;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1590

Returns the mutation cache this client is connected to.

Returns ​

MutationCache

Example ​

ts
import { QueryClient } from '@tanstack/query-core'

const queryClient = new QueryClient()
const mutationCache = queryClient.getMutationCache()
const mutations = mutationCache.findAll({ status: 'pending' })

getMutationDefaults() ​

ts
getMutationDefaults(mutationKey): OmitKeyof<MutationObserverOptions<any, any, any, any>, "mutationKey">;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1671

Returns the default options registered for mutations whose mutation key partially matches the given mutationKey, via QueryClient#setMutationDefaults. If multiple registered defaults match, they are merged together in registration order.

Parameters ​

ParameterType
mutationKeyreadonly unknown[]

Returns ​

OmitKeyof<MutationObserverOptions<any, any, any, any>, "mutationKey">

Example ​

ts
const defaultOptions = queryClient.getMutationDefaults(['addPost'])

getQueriesData() ​

ts
getQueriesData<TQueryFnData, TQueryFilters>(filters): [readonly unknown[], TQueryFnData | undefined][];

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1358

Imperative (non-reactive) way to retrieve the cached data of multiple queries at once. Only queries matching the given filters are returned; if none match, an empty array is returned.

Because the matched queries can hold data of different shapes (e.g. a broad filter can match queries with unrelated data types), the TQueryFnData generic defaults to unknown rather than being inferred. Passing a more specific type is a convenience for call sites that know every matched query holds the same shape — it is not checked against the actual cache contents.

Type Parameters ​

Type ParameterDefault type
TQueryFnDataunknown
TQueryFilters extends QueryFilters<any>QueryFilters<readonly unknown[]>

Parameters ​

ParameterType
filtersTQueryFilters

Returns ​

[readonly unknown[], TQueryFnData | undefined][]

An array of query key and data pairs. The data is undefined for a query with no cached data.

See ​

QueryClient#getQueryData

Example ​

ts
const data = queryClient.getQueriesData({ queryKey: ['posts'] })

getQueryCache() ​

ts
getQueryCache(): QueryCache;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1577

Returns the query cache this client is connected to.

Returns ​

QueryCache

Example ​

ts
import { QueryClient } from '@tanstack/query-core'

const queryClient = new QueryClient()
const queryCache = queryClient.getQueryCache()
const queries = queryCache.findAll({ queryKey: ['posts'] })

getQueryData() ​

ts
getQueryData<TQueryFnData, TTaggedQueryKey, TInferredQueryFnData>(queryKey): TInferredQueryFnData | undefined;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1335

Imperative (non-reactive) way to retrieve data for a QueryKey. Should only be used in callbacks or functions where reading the latest data is necessary, e.g. for optimistic updates.

Hint: Do not use this function inside a component, because it won't receive updates. Use useQuery to create a QueryObserver that subscribes to changes.

Type Parameters ​

Type ParameterDefault type
TQueryFnDataunknown
TTaggedQueryKey extends readonly unknown[]readonly unknown[]
TInferredQueryFnDataInferDataFromTag<TQueryFnData, TTaggedQueryKey>

Parameters ​

ParameterType
queryKeyTTaggedQueryKey

Returns ​

TInferredQueryFnData | undefined

The cached data for the query, or undefined if no query with this key has been observed yet.

See ​

QueryClient#getQueriesData

getQueryDefaults() ​

ts
getQueryDefaults(queryKey): OmitKeyof<QueryObserverOptions<any, any, any, any, any>, "queryKey">;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1648

Returns the default options registered for queries whose query key partially matches the given queryKey, via QueryClient#setQueryDefaults. If multiple registered defaults match, they are merged together in registration order.

Parameters ​

ParameterType
queryKeyreadonly unknown[]

Returns ​

OmitKeyof<QueryObserverOptions<any, any, any, any, any>, "queryKey">

Example ​

ts
const defaultOptions = queryClient.getQueryDefaults(['posts'])

getQueryState() ​

ts
getQueryState<TQueryFnData, TError, TTaggedQueryKey, TInferredQueryFnData, TInferredError>(queryKey): 
  | QueryState<TInferredQueryFnData, TInferredError>
  | undefined;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1410

Imperative (non-reactive) way to retrieve an existing query's state. If the query does not exist, undefined is returned.

Type Parameters ​

Type ParameterDefault type
TQueryFnDataunknown
TErrorError
TTaggedQueryKey extends readonly unknown[]readonly unknown[]
TInferredQueryFnDataInferDataFromTag<TQueryFnData, TTaggedQueryKey>
TInferredErrorInferErrorFromTag<TError, TTaggedQueryKey>

Parameters ​

ParameterType
queryKeyTTaggedQueryKey

Returns ​

| QueryState<TInferredQueryFnData, TInferredError> | undefined

Example ​

ts
const state = queryClient.getQueryState(['posts'])
console.log(state?.dataUpdatedAt)

infiniteQuery() ​

ts
infiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): Promise<TData[] extends InfiniteData<TQueryFnData, unknown>[] ? InfiniteData<TQueryFnData, TPageParam> : TData>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1539

Asynchronous method to fetch and cache an infinite query, resolving with an InfiniteData object or throwing with the error.

Behaves like QueryClient#query, accepting the same options (minus initialPageParam), plus the required initialPageParam, and an optional pages / getNextPageParam pair used to refetch a fixed number of pages from the start.

This method replaces the deprecated fetchInfiniteQuery, and — combined with { staleTime: 'static' } — the deprecated ensureInfiniteQueryData.

Type Parameters ​

Type ParameterDefault type
TQueryFnData-
TErrorError
TDataInfiniteData<TQueryFnData, unknown>
TQueryKey extends readonly unknown[]readonly unknown[]
TPageParamunknown

Parameters ​

ParameterType
optionsInfiniteQueryExecuteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>

Returns ​

Promise<TData[] extends InfiniteData<TQueryFnData, unknown>[] ? InfiniteData<TQueryFnData, TPageParam> : TData>

Example ​

ts
try {
  const data = await queryClient.infiniteQuery({ queryKey, queryFn, initialPageParam: 0 })
  console.log(data.pages)
} catch (error) {
  console.log(error)
}

invalidateQueries() ​

ts
invalidateQueries<TTaggedQueryKey>(filters?, options?): Promise<void>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1461

Marks queries matching the given filters as invalidated. Unlike QueryClient#removeQueries, invalidated queries stay in the cache.

Unless filters.refetchType is 'none', matching queries are then refetched via QueryClient#refetchQueries, using filters.refetchType if set, otherwise filters.type, otherwise 'active'.

Type Parameters ​

Type ParameterDefault type
TTaggedQueryKey extends readonly unknown[]readonly unknown[]

Parameters ​

ParameterType
filters?InvalidateQueryFilters<TTaggedQueryKey>
options?InvalidateOptions

Returns ​

Promise<void>

Example ​

ts
await queryClient.invalidateQueries({ queryKey: ['posts'], refetchType: 'active' })

isFetching() ​

ts
isFetching<TQueryFilters>(filters?): number;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1312

Returns the number of queries in the cache that are currently fetching, optionally matching a set of filters. This includes background-fetching, loading new pages, and loading more infinite query results.

Type Parameters ​

Type ParameterDefault type
TQueryFilters extends QueryFilters<any>QueryFilters<readonly unknown[]>

Parameters ​

ParameterType
filters?TQueryFilters

Returns ​

number

Example ​

ts
if (queryClient.isFetching()) {
  console.log('At least one query is fetching!')
}

isMutating() ​

ts
isMutating<TMutationFilters>(filters?): number;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1324

Returns the number of mutations in the cache that are currently pending, optionally matching a set of filters.

Type Parameters ​

Type ParameterDefault type
TMutationFilters extends MutationFilters<any, any, unknown, unknown>MutationFilters<unknown, Error, unknown, unknown>

Parameters ​

ParameterType
filters?TMutationFilters

Returns ​

number

Example ​

ts
if (queryClient.isMutating()) {
  console.log('At least one mutation is pending!')
}

mount() ​

ts
mount(): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1293

Called by a framework adapter's QueryClientProvider-equivalent when it mounts, to start listening for focus/online events and resume paused mutations. Ref-counted via an internal mount count, so nested or multiple providers sharing the same QueryClient don't tear down the shared listeners until the last one unmounts.

Returns ​

void

query() ​

ts
query<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>(options): Promise<TData>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1509

Asynchronous method to fetch and cache a query, resolving with the data or throwing with the error.

If the query already exists in the cache and its data is not stale (per the given staleTime), the cached data is returned without fetching. Otherwise, the query is fetched and the promise resolves once the fetch settles. If a select function is provided, it is applied to the data in both cases (cached or freshly fetched) before it is returned.

Unlike a reactive observer, retries are disabled by default here (retry: false) unless explicitly configured, since there is no component to catch a thrown error and retry through re-render.

The accepted options are QueryObserverOptions minus the fields that only make sense for a reactive observer — enabled, refetchInterval, refetchIntervalInBackground, refetchOnWindowFocus, refetchOnReconnect, refetchOnMount, retryOnMount, notifyOnChangeProps, throwOnError, suspense, and placeholderData are not part of this method's options.

This method replaces the deprecated fetchQuery, and — combined with { staleTime: 'static' } — the deprecated ensureQueryData.

Type Parameters ​

Type ParameterDefault type
TQueryFnData-
TErrorError
TDataTQueryFnData
TQueryDataTQueryFnData
TQueryKey extends readonly unknown[]readonly unknown[]
TPageParamnever

Parameters ​

ParameterType
optionsQueryExecuteOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>

Returns ​

Promise<TData>

Example ​

ts
try {
  const data = await queryClient.query({ queryKey, queryFn, staleTime: 10000 })
} catch (error) {
  console.log(error)
}

refetchQueries() ​

ts
refetchQueries<TTaggedQueryKey>(filters?, options?): Promise<void>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1477

Refetches queries matching the given filters, regardless of whether they are stale. Without filters, every query in the cache is refetched. Queries that are disabled, or static (only have observers with a static staleTime), are never refetched.

By default (cancelRefetch: true), a currently running fetch is cancelled before the new one starts. The returned promise resolves once all matching queries have settled; it does not reject on individual query failures unless throwOnError is set.

Type Parameters ​

Type ParameterDefault type
TTaggedQueryKey extends readonly unknown[]readonly unknown[]

Parameters ​

ParameterType
filters?RefetchQueryFilters<TTaggedQueryKey>
options?RefetchOptions

Returns ​

Promise<void>

Example ​

ts
// refetch all active queries partially matching a query key:
await queryClient.refetchQueries({ queryKey: ['posts'], type: 'active' })

removeQueries() ​

ts
removeQueries<TTaggedQueryKey>(filters?): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1422

Removes queries from the cache that match the given filters. Unlike QueryClient#invalidateQueries or QueryClient#refetchQueries, this removes matching queries from the cache instead of refetching them. Without filters, every query in the cache is removed.

Type Parameters ​

Type ParameterDefault type
TTaggedQueryKey extends readonly unknown[]readonly unknown[]

Parameters ​

ParameterType
filters?QueryFilters<TTaggedQueryKey>

Returns ​

void

Example ​

ts
queryClient.removeQueries({ queryKey: ['posts'], exact: true })

resetQueries() ​

ts
resetQueries<TTaggedQueryKey>(filters?, options?): Promise<void>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1433

Resets queries matching the given filters back to their initial state (e.g. any initialData), notifying subscribers rather than removing them. Active queries among the matched set are then refetched, and the returned promise resolves once that refetch settles.

Type Parameters ​

Type ParameterDefault type
TTaggedQueryKey extends readonly unknown[]readonly unknown[]

Parameters ​

ParameterType
filters?QueryFilters<TTaggedQueryKey>
options?ResetOptions

Returns ​

Promise<void>

Example ​

ts
await queryClient.resetQueries({ queryKey: ['posts'], exact: true })

resumePausedMutations() ​

ts
resumePausedMutations(): Promise<unknown>;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1564

Resumes mutations that were paused because there was no network connection. Does nothing (resolving immediately) if the client is currently offline.

Returns ​

Promise<unknown>

Example ​

ts
import { QueryClient } from '@tanstack/query-core'

const queryClient = new QueryClient()
await queryClient.resumePausedMutations()

setDefaultOptions() ​

ts
setDefaultOptions(options): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1621

Dynamically sets the default options for this client, overwriting any previously defined default options.

Parameters ​

ParameterType
optionsDefaultOptions

Returns ​

void

See ​

QueryClient#getDefaultOptions

Example ​

ts
import { QueryClient } from '@tanstack/query-core'

const queryClient = new QueryClient()
queryClient.setDefaultOptions({
  queries: {
    staleTime: Infinity,
  },
})

setMutationDefaults() ​

ts
setMutationDefaults<TData, TError, TVariables, TOnMutateResult>(mutationKey, options): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1660

Sets default options for mutations whose mutation key partially matches the given mutationKey. As with QueryClient#setQueryDefaults, the order of registration matters when several registered defaults match the same mutation key.

Type Parameters ​

Type ParameterDefault type
TDataunknown
TErrorError
TVariablesvoid
TOnMutateResultunknown

Parameters ​

ParameterType
mutationKeyreadonly unknown[]
optionsOmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, "mutationKey">

Returns ​

void

See ​

QueryClient#getMutationDefaults

Example ​

ts
queryClient.setMutationDefaults(['addPost'], { mutationFn: addPost })

setQueriesData() ​

ts
setQueriesData<TQueryFnData, TQueryFilters>(
   filters, 
   updater, 
   options?
): [readonly unknown[], TQueryFnData | undefined][];

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1399

Synchronous way to immediately update the cached data of multiple queries at once, using filters or partial query key matching. Only queries that already exist and match the given filters are updated; no new cache entries are created. Internally this calls QueryClient#setQueryData for each matching query.

Type Parameters ​

Type ParameterDefault type
TQueryFnData-
TQueryFilters extends QueryFilters<any>QueryFilters<readonly unknown[]>

Parameters ​

ParameterType
filtersTQueryFilters
updaterUpdater<NoInfer<TQueryFnData> | undefined, NoInfer<TQueryFnData> | undefined>
options?SetDataOptions

Returns ​

[readonly unknown[], TQueryFnData | undefined][]

One [queryKey, data] tuple per matched query, in the same shape and with the same undefined case as QueryClient#setQueryData.

Example ​

ts
queryClient.setQueriesData({ queryKey: ['posts'] }, (oldPosts) =>
  oldPosts ? oldPosts.filter((post) => post.id !== deletedId) : oldPosts,
)

setQueryData() ​

ts
setQueryData<TQueryFnData, TTaggedQueryKey, TInferredQueryFnData>(
   queryKey, 
   updater, 
   options?
): NoInfer<TInferredQueryFnData> | undefined;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1383

Synchronous way to immediately update a query's cached data. If the updater (or the value passed) resolves to undefined, the cache is left untouched and no query is created; otherwise, if the query does not exist yet, it will be created. To update multiple queries at once by partially matching query keys, use QueryClient#setQueriesData instead.

Updates must be performed immutably: do not mutate oldData, or data previously retrieved via QueryClient#getQueryData, in place.

Type Parameters ​

Type ParameterDefault type
TQueryFnDataunknown
TTaggedQueryKey extends readonly unknown[]readonly unknown[]
TInferredQueryFnDataInferDataFromTag<TQueryFnData, TTaggedQueryKey>

Parameters ​

ParameterTypeDescription
queryKeyTTaggedQueryKeyThe query key to set data for.
updaterUpdater<NoInfer<TInferredQueryFnData> | undefined, NoInfer<TInferredQueryFnData> | undefined>Either the new data, or a function that receives the current data (which may be undefined) and returns the new data.
options?SetDataOptionsSet updatedAt to override the timestamp the written data is recorded with.

Returns ​

NoInfer<TInferredQueryFnData> | undefined

The data that was written, or undefined if the updater returned undefined — in that case the write is skipped and the cache is left unchanged.

Example ​

ts
queryClient.setQueryData(['posts'], newPosts)

// Or, using an updater function that receives the current data:
queryClient.setQueryData(['posts'], (oldPosts) => [...oldPosts, newPost])

setQueryDefaults() ​

ts
setQueryDefaults<TQueryFnData, TError, TData, TQueryData>(queryKey, options): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1637

Sets default options for queries whose query key partially matches the given queryKey.

If several registered query defaults match a given query key, they are merged together in registration order by QueryClient#getQueryDefaults, so register defaults from the most generic key to the least generic one — more specific defaults should be registered after more generic ones so they take precedence.

Type Parameters ​

Type ParameterDefault type
TQueryFnDataunknown
TErrorError
TDataTQueryFnData
TQueryDataTQueryFnData

Parameters ​

ParameterType
queryKeyreadonly unknown[]
optionsPartial<OmitKeyof<QueryObserverOptions<TQueryFnData, TError, TData, TQueryData>, "queryKey">>

Returns ​

void

Example ​

ts
queryClient.setQueryDefaults(['posts'], { queryFn: fetchPosts })

await queryClient.query({ queryKey: ['posts'] })

unmount() ​

ts
unmount(): void;

Defined in: node_modules/.bun/@tanstack+query-core@5.104.1/node_modules/@tanstack/query-core/build/modern/hydration-B9t5w6NC.d.ts:1299

The inverse of QueryClient#mount — called by a framework adapter's QueryClientProvider-equivalent when it unmounts. Only tears down the focus/online listeners once the mount count returns to 0.

Returns ​

void

Released under the MIT License.

Copyright © Sergio Jurado