UNPKG

react-query

Version:

Hooks for managing, caching and syncing asynchronous and remote data in React

30 lines (29 loc) 1.69 kB
import { MutationOptions } from './types'; import { QueryClient } from './queryClient'; import { Mutation, MutationState } from './mutation'; import { MutationFilters } from './utils'; import { Subscribable } from './subscribable'; interface MutationCacheConfig { onError?: (error: unknown, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown, unknown>) => void; onSuccess?: (data: unknown, variables: unknown, context: unknown, mutation: Mutation<unknown, unknown, unknown, unknown>) => void; onMutate?: (variables: unknown, mutation: Mutation<unknown, unknown, unknown, unknown>) => void; } declare type MutationCacheListener = (mutation?: Mutation) => void; export declare class MutationCache extends Subscribable<MutationCacheListener> { config: MutationCacheConfig; private mutations; private mutationId; constructor(config?: MutationCacheConfig); build<TData, TError, TVariables, TContext>(client: QueryClient, options: MutationOptions<TData, TError, TVariables, TContext>, state?: MutationState<TData, TError, TVariables, TContext>): Mutation<TData, TError, TVariables, TContext>; add(mutation: Mutation<any, any, any, any>): void; remove(mutation: Mutation<any, any, any, any>): void; clear(): void; getAll(): Mutation[]; find<TData = unknown, TError = unknown, TVariables = any, TContext = unknown>(filters: MutationFilters): Mutation<TData, TError, TVariables, TContext> | undefined; findAll(filters: MutationFilters): Mutation[]; notify(mutation?: Mutation<any, any, any, any>): void; onFocus(): void; onOnline(): void; resumePausedMutations(): Promise<void>; } export {};