Skip to content
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

Jump to bottom

fix(svelte-query): Fix createMutation for functions that take no arguments #4847

Merged
merged 4 commits into from Jan 21, 2023
Merged

fix(svelte-query): Fix createMutation for functions that take no arguments #4847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c4e08f1
Update createMutation test function name
lachlancollins Jan 21, 2023
121355c
Default TVariables = void
lachlancollins Jan 21, 2023
377ccac
Fix createMutation test
lachlancollins Jan 21, 2023
938b193
Fix prettier
lachlancollins Jan 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/svelte-query/src/__tests__/CreateMutation.svelte
View file
Open in desktop
Expand Up @@ -2,12 +2,14 @@
import { createMutation, QueryClient } from '../index'
import { setQueryClientContext } from '../context'

export let queryFn: () => Promise<string>
export let mutationFn: () => Promise<string>

const queryClient = new QueryClient()
setQueryClientContext(queryClient)

const mutation = createMutation(queryFn)
const mutation = createMutation({
mutationFn,
})
</script>

<button on:click={$mutation.mutate}>Click</button>
<button on:click={() => $mutation.mutate()}>Click</button>
6 changes: 3 additions & 3 deletions packages/svelte-query/src/__tests__/createMutation.test.ts
View file
Open in desktop
Expand Up @@ -5,18 +5,18 @@ import { sleep } from './utils'

describe('createMutation', () => {
it('Call mutate and check function runs', async () => {
const queryFn = vi.fn()
const mutationFn = vi.fn()

render(CreateMutation, {
props: {
queryFn,
mutationFn,
},
})

fireEvent.click(screen.getByRole('button'))

await sleep(200)

expect(queryFn).toHaveBeenCalledTimes(1)
expect(mutationFn).toHaveBeenCalledTimes(1)
})
})
14 changes: 7 additions & 7 deletions packages/svelte-query/src/createMutation.ts
View file
Open in desktop
Expand Up @@ -7,7 +7,7 @@ import {
parseMutationArgs,
} from '@tanstack/query-core'
import type {
UseMutateFunction,
CreateMutateFunction,
CreateMutationOptions,
CreateMutationResult,
} from './types'
Expand All @@ -16,7 +16,7 @@ import { useQueryClient } from './useQueryClient'
export function createMutation<
TData = unknown,
TError = unknown,
TVariables = unknown,
TVariables = void,
TContext = unknown,
>(
options: CreateMutationOptions<TData, TError, TVariables, TContext>,
Expand All @@ -25,7 +25,7 @@ export function createMutation<
export function createMutation<
TData = unknown,
TError = unknown,
TVariables = unknown,
TVariables = void,
TContext = unknown,
>(
mutationFn: MutationFunction<TData, TVariables>,
Expand All @@ -38,7 +38,7 @@ export function createMutation<
export function createMutation<
TData = unknown,
TError = unknown,
TVariables = unknown,
TVariables = void,
TContext = unknown,
>(
mutationKey: MutationKey,
Expand All @@ -51,7 +51,7 @@ export function createMutation<
export function createMutation<
TData = unknown,
TError = unknown,
TVariables = unknown,
TVariables = void,
TContext = unknown,
>(
mutationKey: MutationKey,
Expand All @@ -65,7 +65,7 @@ export function createMutation<
export function createMutation<
TData = unknown,
TError = unknown,
TVariables = unknown,
TVariables = void,
TContext = unknown,
>(
arg1:
Expand All @@ -83,7 +83,7 @@ export function createMutation<
queryClient,
options,
)
let mutate: UseMutateFunction<TData, TError, TVariables, TContext>
let mutate: CreateMutateFunction<TData, TError, TVariables, TContext>

readable(observer).subscribe(($observer) => {
observer = $observer
Expand Down
14 changes: 8 additions & 6 deletions packages/svelte-query/src/types.ts
View file
Open in desktop
Expand Up @@ -87,7 +87,7 @@ export interface CreateMutationOptions<
'_defaulted' | 'variables'
> {}

export type UseMutateFunction<
export type CreateMutateFunction<
TData = unknown,
TError = unknown,
TVariables = void,
Expand All @@ -96,30 +96,32 @@ export type UseMutateFunction<
...args: Parameters<MutateFunction<TData, TError, TVariables, TContext>>
) => void

export type UseMutateAsyncFunction<
export type CreateMutateAsyncFunction<
TData = unknown,
TError = unknown,
TVariables = void,
TContext = unknown,
> = MutateFunction<TData, TError, TVariables, TContext>

export type UseBaseMutationResult<
export type CreateBaseMutationResult<
TData = unknown,
TError = unknown,
TVariables = unknown,
TContext = unknown,
> = Override<
MutationObserverResult<TData, TError, TVariables, TContext>,
{ mutate: UseMutateFunction<TData, TError, TVariables, TContext> }
> & { mutateAsync: UseMutateAsyncFunction<TData, TError, TVariables, TContext> }
{ mutate: CreateMutateFunction<TData, TError, TVariables, TContext> }
> & {
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
}

export interface CreateMutationResult<
TData = unknown,
TError = unknown,
TVariables = unknown,
TContext = unknown,
> extends Readable<
UseBaseMutationResult<TData, TError, TVariables, TContext>
CreateBaseMutationResult<TData, TError, TVariables, TContext>
> {}

type Override<A, B> = { [K in keyof A]: K extends keyof B ? B[K] : A[K] }