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

useMutationState.ts

77 lines2.0 KB

1/* eslint-disable react-compiler/react-compiler */
2​
3'use client'
4import * as React from 'react'
5​
6import { notifyManager, replaceEqualDeep } from '@tanstack/query-core'
7import { useQueryClient } from './QueryClientProvider'
8import type {
9 Mutation,
10 MutationCache,
11 MutationFilters,
12 MutationState,
13 QueryClient,
14} from '@tanstack/query-core'
15​
16export function useIsMutating(
17 filters?: MutationFilters,
18 queryClient?: QueryClient,
19): number {
20 const client = useQueryClient(queryClient)
21 return useMutationState(
22 { filters: { ...filters, status: 'pending' } },
23 client,
24 ).length
26​
27type MutationStateOptions<TResult = MutationState> = {
28 filters?: MutationFilters
29 select?: (mutation: Mutation) => TResult
31​
32function getResult<TResult = MutationState>(
33 mutationCache: MutationCache,
34 options: MutationStateOptions<TResult>,
35): Array<TResult> {
36 return mutationCache
37 .findAll(options.filters)
38 .map(
39 (mutation): TResult =>
40 (options.select ? options.select(mutation) : mutation.state) as TResult,
41 )
43​
44export function useMutationState<TResult = MutationState>(
45 options: MutationStateOptions<TResult> = {},
46 queryClient?: QueryClient,
47): Array<TResult> {
48 const mutationCache = useQueryClient(queryClient).getMutationCache()
49 const optionsRef = React.useRef(options)
50 const result = React.useRef<Array<TResult>>(null)
51 if (!result.current) {
52 result.current = getResult(mutationCache, options)
53 }
54​
55 React.useEffect(() => {
56 optionsRef.current = options
57 })
58​
59 return React.useSyncExternalStore(
60 React.useCallback(
61 (onStoreChange) =>
62 mutationCache.subscribe(() => {
63 const nextResult = replaceEqualDeep(
64 result.current,
65 getResult(mutationCache, optionsRef.current),
66 )
67 if (result.current !== nextResult) {
68 result.current = nextResult
69 notifyManager.schedule(onStoreChange)
70 }
71 }),
72 [mutationCache],
73 ),
74 () => result.current,
75 () => result.current,
76 )!