Skip to main content
The @claritylabs/cl-pipelines/convex sub-path export ships pre-built adapters for Convex’s storage and scheduler APIs. You define the five pipeline mutations in your Convex backend, then pass them to createConvexStorageAdapter — the adapters handle serialization, scheduling, and the advancePhase wiring automatically.

​
Installation

Import the Convex-specific helpers from the sub-path:

​
Setup

​
createConvexStorageAdapter

​
ActionCtx
required
The Convex action context (ctx) from your internalAction or action handler.
​
ConvexPipelineMutations
required
A record mapping the five pipeline mutation names to their internal.* references. Import ConvexPipelineMutations type from @claritylabs/cl-pipelines/convex for type-safe wiring.

​
createConvexSchedulerAdapter

​
ActionCtx
required
The Convex action context.
​
FunctionReference<'action'>
required
The internal.* reference to your advance action (e.g. internal.applications.advance).
​
string
The argument name your advance action uses for the job ID. Defaults to "jobId".