0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/solid/reference/functions/matchQuery.md
Wonsuk Choi 6e16d3946a
docs(query-core/utils): add missing JSDoc to utility functions (#11830)
* docs(query-core/utils): add missing JSDoc to utility functions

* docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:47:14 +09:00

924 B

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

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

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.

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))