MutationRef

A reference to a Mutation for MutationKey.

Type of the return value from the mutation.

Type of the variable to be mutated.

Properties

abstract val key: MutationKey<T, S>

The MutationKey for the Mutation.

abstract val marker: Marker

The MutationOptions configured for the mutation.

abstract val state: StateFlow<MutationState<T>>

State Flow to receive the current state of the mutation.

abstract fun launchIn(scope: CoroutineScope): Job

Launches the actor.

open suspend fun mutate(variable: S): T

Mutates the variable.

open suspend fun mutateAsync(variable: S)

Mutates the variable asynchronously.

open suspend fun reset()

Resets the mutation state.

abstract suspend fun send(command: MutationCommand<T>)

Sends a MutationCommand to the Actor.