BaseHookProps

Defined in: packages/core/src/hooks/types.ts:18

Base shape shared by every lifecycle hook’s props across this framework — collection hooks (collections/hooks.ts), and, once built, global and media collection hooks (globals/hooks.ts, media/hooks.ts). Every hook receives the mutation ctx, typed against the project’s real DataModel.

Each domain extends this with its own props (doc, collection/global, etc.) rather than redeclaring ctx — see collections/hooks.ts’s BeforeChangeProps for the pattern.

Extended by

• BeforeChangeProps
• BeforeDeleteProps
• AfterChangeProps
• AfterDeleteProps
• GlobalBeforeChangeProps
• GlobalAfterChangeProps

Type Parameters

TDataModel

TDataModel extends GenericDataModel = GenericDataModel

The project’s generated Convex DataModel. Defaults to GenericDataModel; each domain’s own xHook factory (e.g. beforeChangeHook) accepts it as an explicit type argument so ctx is fully typed.

Properties

commitTs

commitTs: unknown

Defined in: packages/core/src/hooks/types.ts:29

This write’s unresolved ctx.db.vars.commitTs placeholder — the same value stampCommitTsFields writes into a matching commitTs() field. A hook MAY use it to stamp a RELATED document in the same mutation (e.g. a parent row’s own commitTs field). It is NOT the resolved value — Convex resolves a commitTs placeholder only after the mutation commits, so reading it as a number/bigint here throws or returns the placeholder object itself, never a usable timestamp.

---

ctx

ctx: GenericMutationCtx<TDataModel>

Defined in: packages/core/src/hooks/types.ts:19