API reference · generated from source

Interface: RetreeConvexMutationOptions<Mutation>#

Defined in: retree-convex/src/types.ts:240

Options accepted by a Retree Convex mutation function.

Type Parameters#

Type Parameter	Default type
`Mutation` extends `MutationReference`	`MutationReference`

Property	Type	Description	Defined in
`withOptimisticUpdate?`	(`ctx`) => `void`	Called after the mutation promise is created so query nodes can apply an optimistic update and subscribe to the mutation outcome.	retree-convex/src/types.ts:247

API reference · generated from source

Defined in: retree-convex/src/types.ts:240

Options accepted by a Retree Convex mutation function.

Type Parameter	Default type
`Mutation` extends `MutationReference`	`MutationReference`

Property	Type	Description	Defined in
`withOptimisticUpdate?`	(`ctx`) => `void`	Called after the mutation promise is created so query nodes can apply an optimistic update and subscribe to the mutation outcome.	retree-convex/src/types.ts:247