GenericMutationServerParams
Defined in: packages/core/src/api/types.ts:264
Base shape for server-side args of a vex.* mutation function. Used inside
custom Convex mutation handlers; receives the Convex mutation context
(which is a superset of GenericQueryCtx — read+write vs. read-only).
Type Parameters
Section titled “Type Parameters”DataModel
Section titled “DataModel”DataModel extends GenericDataModel
The Convex data model (inferred from ctx).
TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug = CollectionSlug
Properties
Section titled “Properties”access?
Section titled “access?”
optionalaccess?:AccessCallOptions<MutationCallAction>
Defined in: packages/core/src/api/types.ts:269
Per-call access overrides.
optionalauth?:VexApiAuth
Defined in: packages/core/src/api/types.ts:276
The auth config of the current user making the query.
Example
Section titled “Example”{ user: {...}, organization: {...} }config
Section titled “config”config:
VexConfig
Defined in: packages/core/src/api/types.ts:283
The resolved VexConfig. Required for rbac access control during operations
from the queryApi factory closure so the Convex handler has schema info.
ctx:
GenericMutationCtx<DataModel>
Defined in: packages/core/src/api/types.ts:278
Discriminator: server args MUST supply a Convex mutation context.