isFetching(...)

This method returns an integer representing how many queries, if any, in the cache are currently fetching. Refer to the TanStack queryClient.isFetching 🌴 guide for more information.

With filters

Checks if any queries are fetching with the specified parameters.

qraft.<service>.<operation>.isFetching(
  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 checked
2. queryClient: QueryClient
   • Required QueryClient 🌴 to be used

Without filters

Check all normal and Infinite queries for the specified endpoint.

qraft.<service>.<operation>.isFetching(
  queryClient,
)

Arguments

1. queryClient: QueryClient
   • Required QueryClient 🌴 to be used

Returns

number: Number of queries fetching.

Examples

filters

Check if any queries are fetching with the specified parameters:

/**
* Will check if the query with the specified parameters is fetching:
* ###
* GET /entities/3e3e-3e3e-3e3e
* x-monite-version: 2023-09-01
**/
const numberOfFetchingEntities = qraft.entities.getEntities.isFetching(
  {
    infinite: false,
    parameters: {
      header: {
        'x-monite-version': '2023-09-01',
      },
      path: {
        entity_id: '3e3e-3e3e-3e3e',
      },
    },
  },
  queryClient
);

expect(numberOfFetchingEntities).toEqual(1);

filters

To check all normal queries for a particular endpoint, you can call isFetching(...) without parameters:

/**
 * Will check queries matching the specified endpoint:
 * ###
 * GET /entities/3e3e-3e3e-3e3e
 * x-monite-version: 2023-09-01
 * ###
 * GET /entities/4c4c-4c4c-4c4c
 * x-monite-version: 2023-09-01
 * ###
 * ⬇︎ All queries for the specified endpoint will be used
 **/
const numberOfFetchingEntities = qraft.entities.getEntities.isFetching(queryClient);

expect(numberOfFetchingEntities).toEqual(2);