Membrane React - v0.2.1
    Preparing search index...

    Type Alias MutatorOptions<Data, MutationData>

    type MutatorOptions<Data = any, MutationData = Data> = {
        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

    Index

    Properties

    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