Skip to main content
Version: 1.x

removeQueries(...)

The method can be used to remove queries. Refer to the TanStack queryClient.removeQueries ๐ŸŒด documentation.

qraft.<service>.<operation>.removeQueries(
filters,
queryClient,
)

Argumentsโ€‹

  1. filters: QueryFiltersByParameters | QueryFiltersByQueryKey
    • Required, represents the Query Filters ๐ŸŒด to be used, strictly-typed โœจ
    • filters.parameters: { path, query, header } will be used for filtering queries by parameters
    • filters.infinite: boolean will be used to filter infinite or normal queries
    • filters.queryKey: QueryKey will be used for filtering queries by QueryKey instead of parameters
      • filters.queryKey and filters.parameters are mutually exclusive
    • filters.predicate?: (query: Query) => boolean will be used for filtering queries by custom predicate
    • If not provided
      • All queries for the specified endpoint will be removed
  2. queryClient: QueryClient

Returnsโ€‹

void: This method does not return anything

Examplesโ€‹

Queries removal with the specified parameters:

/**
* Removes the active queries with the specified parameters:
* ###
* GET /entities/3e3e-3e3e-3e3e
* x-monite-version: 2023-09-01
**/
qraft.entities.getEntities.removeQueries(
{
infinite: false,
parameters: {
header: {
'x-monite-version': '2023-09-01',
},
path: {
entity_id: '3e3e-3e3e-3e3e',
},
},
},
queryClient
);