0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/react/reference/functions/matchQuery.md
Wonsuk Choi f38e6271b4
chore(*): update '@tanstack/typedoc-config' to v0.3.5 (#12035)
* chore(scripts/generate-docs): read type alias bodies whose type parameters have defaults

* chore(*): update '@tanstack/typedoc-config' to v0.3.5
2026-10-17 11:14:03 +09:00

1.9 KiB

id title
matchQuery matchQuery
function matchQuery(filters: QueryFilters, query: Query<any, any, any, any>): boolean;

Defined in: packages/query-core/src/utils.ts:205

Checks whether a query matches the given QueryFilters. Every filter that is specified must match; filters that are left unspecified are ignored.

Parameters

filters

QueryFilters

The filters to check the query against.

filters properties

Property Type Default value Description
exact? boolean undefined Match query key exactly
fetchStatus? "fetching" | "paused" | "idle" undefined Include queries matching their fetchStatus
predicate? (query: Query) => boolean undefined Include queries matching this predicate function
queryKey? TQueryKey | TuplePrefixes<TQueryKey> undefined Include queries matching this query key
stale? boolean undefined Include or exclude stale queries
type? QueryTypeFilter 'all' Filter to active queries, inactive queries or all queries

query

Query<any, any, any, any>

The query to check.

Returns

boolean

true if the query matches every specified filter.

Example

const queryCache = queryClient.getQueryCache()

const matchingQueries = queryCache
  .getAll()
  .filter((query) => matchQuery({ queryKey: ['posts'] }, query))