Skip to content

fix(types): allow returning of any promise in the mutation callbacks #2189

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
tannerlinsley merged 4 commits into from
Apr 28, 2021
Merged

fix(types): allow returning of any promise in the mutation callbacks #2189

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
7e7d2d3
Merge pull request #2 from tannerlinsley/master
TkDodo Apr 2, 2021
e29ae76
Merge pull request #3 from tannerlinsley/master
TkDodo Apr 11, 2021
37a3118
Merge pull request #4 from tannerlinsley/master
TkDodo Apr 23, 2021
49b5207
fix(types): allow returning of any promise in the mutation callbacks
TkDodo Apr 24, 2021
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
6 changes: 3 additions & 3 deletions docs/src/pages/reference/useMutation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ mutate(variables, {
- This function will fire before the mutation function is fired and is passed the same variables the mutation function would receive
- Useful to perform optimistic updates to a resource in hopes that the mutation succeeds
- The value returned from this function will be passed to both the `onError` and `onSettled` functions in the event of a mutation failure and can be useful for rolling back optimistic updates.
- `onSuccess: (data: TData, variables: TVariables, context?: TContext) => Promise<void> | void`
- `onSuccess: (data: TData, variables: TVariables, context?: TContext) => Promise<unknown> | void`
- Optional
- This function will fire when the mutation is successful and will be passed the mutation's result.
- If a promise is returned, it will be awaited and resolved before proceeding
- `onError: (err: TError, variables: TVariables, context?: TContext) => Promise<void> | void`
- `onError: (err: TError, variables: TVariables, context?: TContext) => Promise<unknown> | void`
- Optional
- This function will fire if the mutation encounters an error and will be passed the error.
- If a promise is returned, it will be awaited and resolved before proceeding
- `onSettled: (data: TData, error: TError, variables: TVariables, context?: TContext) => Promise<void> | void`
- `onSettled: (data: TData, error: TError, variables: TVariables, context?: TContext) => Promise<unknown> | void`
- Optional
- This function will fire when the mutation is either successfully fetched or encounters an error and be passed either the data or error
- If a promise is returned, it will be awaited and resolved before proceeding
Expand Down
24 changes: 16 additions & 8 deletions src/core/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,13 @@ export interface FetchInfiniteQueryOptions<
TError = unknown,
TData = TQueryFnData,
TQueryKey extends QueryKey = QueryKey
> extends FetchQueryOptions<TQueryFnData, TError, InfiniteData<TData>, TQueryKey> {}
>
extends FetchQueryOptions<
TQueryFnData,
TError,
InfiniteData<TData>,
TQueryKey
> {}

export interface ResultOptions {
throwOnError?: boolean
Expand Down Expand Up @@ -474,23 +480,25 @@ export interface MutationOptions<
mutationFn?: MutationFunction<TData, TVariables>
mutationKey?: MutationKey
variables?: TVariables
onMutate?: (variables: TVariables) => Promise<TContext> | Promise<undefined> | TContext | undefined
onMutate?: (
variables: TVariables
) => Promise<TContext> | Promise<undefined> | TContext | undefined
onSuccess?: (
data: TData,
variables: TVariables,
context: TContext
) => Promise<void> | void
) => Promise<unknown> | void
onError?: (
error: TError,
variables: TVariables,
context: TContext | undefined
) => Promise<void> | void
) => Promise<unknown> | void
onSettled?: (
data: TData | undefined,
error: TError | null,
variables: TVariables,
context: TContext | undefined
) => Promise<void> | void
) => Promise<unknown> | void
retry?: RetryValue<TError>
retryDelay?: RetryDelayValue<TError>
_defaulted?: boolean
Expand All @@ -515,18 +523,18 @@ export interface MutateOptions<
data: TData,
variables: TVariables,
context: TContext
) => Promise<void> | void
) => Promise<unknown> | void
onError?: (
error: TError,
variables: TVariables,
context: TContext | undefined
) => Promise<void> | void
) => Promise<unknown> | void
onSettled?: (
data: TData | undefined,
error: TError | null,
variables: TVariables,
context: TContext | undefined
) => Promise<void> | void
) => Promise<unknown> | void
}

export type MutateFunction<
Expand Down
10 changes: 6 additions & 4 deletions src/react/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,23 +76,25 @@ export interface UseMutationOptions<
TContext = unknown
> {
mutationKey?: MutationKey
onMutate?: (variables: TVariables) => Promise<TContext> | Promise<undefined> | TContext | undefined
onMutate?: (
variables: TVariables
) => Promise<TContext> | Promise<undefined> | TContext | undefined
onSuccess?: (
data: TData,
variables: TVariables,
context: TContext | undefined
) => Promise<void> | void
) => Promise<unknown> | void
onError?: (
error: TError,
variables: TVariables,
context: TContext | undefined
) => Promise<void> | void
) => Promise<unknown> | void
onSettled?: (
data: TData | undefined,
error: TError | null,
variables: TVariables,
context: TContext | undefined
) => Promise<void> | void
) => Promise<unknown> | void
retry?: RetryValue<TError>
retryDelay?: RetryDelayValue<TError>
useErrorBoundary?: boolean
Expand Down