Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useIsMutating.ts

49 lines1.8 KB

1import { createEffect, createMemo, createSignal, onCleanup } from 'solid-js'
2import { useQueryClientResolver } from './QueryClientProvider'
3import type { MutationFilters } from '@tanstack/query-core'
4import type { Accessor } from 'solid-js'
5import type { QueryClient } from './QueryClient'
6​
7/**
8 * The `useIsMutating` primitive returns the `number` of mutations that your application currently has `pending`
9 * (useful for app-wide loading indicators).
10 * @param filters - An accessor returning the {@link MutationFilters} to narrow down the matched mutations.
11 * @param queryClient - An accessor for a custom `QueryClient`. Otherwise, the one from the nearest context
12 * will be used.
13 * @returns An accessor for the `number` of the mutations that your application currently has `pending`.
14 * @example
15 * ```tsx
16 * import { useIsMutating } from '@tanstack/solid-query'
17 *
18 * function PostsMutatingIndicator() {
19 * // How many mutations matching the posts prefix are in progress?
20 * const isMutatingPosts = useIsMutating(() => ({ mutationKey: ['posts'] }))
21 *
22 * return isMutatingPosts() > 0 ? <span>Saving posts...</span> : null
23 * }
24 * ```
25 */
26export function useIsMutating(
27 filters?: Accessor<Omit<MutationFilters, 'status'>>,
28 queryClient?: Accessor<QueryClient>,
29): Accessor<number> {
30 const resolveClient = useQueryClientResolver(queryClient)
31 const client = createMemo(() => resolveClient())
32 const mutationCache = createMemo(() => client().getMutationCache())
33​
34 const [mutations, setMutations] = createSignal(
35 client().isMutating(filters?.()),
36 )
37​
38 createEffect(() => {
39 setMutations(client().isMutating(filters?.()))
40​
41 const unsubscribe = mutationCache().subscribe(() => {
42 setMutations(client().isMutating(filters?.()))
43 })
44​
45 onCleanup(unsubscribe)
46 })
47​
48 return mutations