soil-query-core/soil.query/MutationKey

MutationKey

interface MutationKey<T, S>

Interface for mutations key.

MutationKey is typically used to perform side effects on external resources, such as creating, updating, or deleting data.

Parameters

T

Type of the return value from the mutation.

S

Type of the variable to be mutated.

Properties

abstract val id: MutationId<T, S>

A unique identifier used for managing MutationKey.

abstract val mutate: suspend MutationReceiver.(variable: S) -> T

Suspending function to mutate the variable.

Functions

onConfigureOptions

open fun onConfigureOptions(): MutationOptionsOverride?

Function to configure the MutationOptions.

open fun onQueryUpdate(variable: S, data: T): QueryEffect?

Function to update the query cache after the mutation is executed.