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

Parameters#

filters#

filters properties#

query#