Type Alias MutatorOptions<Data, MutationData>

MutatorOptions: {
    revalidate?: boolean | (data: Data, key: Arguments) => boolean;
    populateCache?:
        | boolean
        | (result: MutationData, currentData: Data | undefined) => Data;
    optimisticData?:
        | Data
        | (currentData: Data | undefined, displayedData: Data | undefined) => Data;
    rollbackOnError?: boolean | (error: unknown) => boolean;
    throwOnError?: boolean;
}

Type Parameters

  • Data = any

    The type of the data related to the key

  • MutationData = Data

    The type of the data returned by the mutator

Type declaration

  • Optionalrevalidate?: boolean | (data: Data, key: Arguments) => boolean
  • OptionalpopulateCache?: boolean | (result: MutationData, currentData: Data | undefined) => Data
  • OptionaloptimisticData?: Data | (currentData: Data | undefined, displayedData: Data | undefined) => Data
  • OptionalrollbackOnError?: boolean | (error: unknown) => boolean
  • OptionalthrowOnError?: boolean

Settings

Member Visibility