Skip to content

fix: types for useMutationState should default to Array<MutationState> #5209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 31, 2023
Merged

fix: types for useMutationState should default to Array<MutationState> #5209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions packages/react-query/src/__tests__/useMutationState.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,12 @@ import { useIsMutating, useMutationState } from '../useMutationState'
import { useMutation } from '../useMutation'
import {
createQueryClient,
doNotExecute,
renderWithClient,
setActTimeout,
sleep,
} from './utils'
import type { MutationState, MutationStatus } from '@tanstack/query-core'

describe('useIsMutating', () => {
it('should return the number of fetching mutations', async () => {
Expand Down Expand Up @@ -172,6 +174,27 @@ describe('useIsMutating', () => {
})

describe('useMutationState', () => {
describe('types', () => {
it('should default to QueryState', () => {
doNotExecute(() => {
const result = useMutationState({
filters: { status: 'pending' },
})

expectTypeOf(result).toEqualTypeOf<Array<MutationState>>()
})
})
it('should infer with select', () => {
doNotExecute(() => {
const result = useMutationState({
filters: { status: 'pending' },
select: (mutation) => mutation.state.status,
})

expectTypeOf(result).toEqualTypeOf<Array<MutationStatus>>()
})
})
})
it('should return variables after calling mutate', async () => {
const queryClient = createQueryClient()
const variables: unknown[][] = []
Expand Down
6 changes: 3 additions & 3 deletions packages/react-query/src/useMutationState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ import type {
Mutation,
MutationCache,
DefaultError,
MutationState,
} from '@tanstack/query-core'
import { notifyManager, replaceEqualDeep } from '@tanstack/query-core'
import { useQueryClient } from './QueryClientProvider'
import type { MutationState } from '@tanstack/query-core/build/lib/mutation'

export function useIsMutating(
filters?: MutationFilters,
Expand All @@ -23,7 +23,7 @@ export function useIsMutating(
).length
}

type MutationStateOptions<TResult> = {
type MutationStateOptions<TResult = MutationState> = {
filters?: MutationFilters
select?: (
mutation: Mutation<unknown, DefaultError, unknown, unknown>,
Expand All @@ -46,7 +46,7 @@ function getResult<TResult = MutationState>(
)
}

export function useMutationState<TResult = unknown>(
export function useMutationState<TResult = MutationState>(
options: MutationStateOptions<TResult> = {},
queryClient?: QueryClient,
): Array<TResult> {
Expand Down
4 changes: 2 additions & 2 deletions packages/vue-query/src/useMutationState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export function useIsMutating(
return length
}

export type MutationStateOptions<TResult> = {
export type MutationStateOptions<TResult = MutationState> = {
filters?: MutationFilters
select?: (
mutation: Mutation<unknown, DefaultError, unknown, unknown>,
Expand All @@ -54,7 +54,7 @@ function getResult<TResult = MutationState>(
)
}

export function useMutationState<TResult = unknown>(
export function useMutationState<TResult = MutationState>(
options: MutationStateOptions<TResult> = {},
queryClient?: QueryClient,
): DeepReadonly<Ref<Array<TResult>>> {
Expand Down