startConvex

●test-convex · /start·async functionthrows When

Starts a local Convex backend via the bundled convex dev CLI in anonymous agent mode and returns its deployment URL, admin key, and a stop() handle.

The child is spawned detached (its own process group) so stop() — and the orphan-proof shutdown handlers — can terminate both convex dev and its convex-local-backend grandchild in one signal. The inherited CONVEX_DEPLOYMENT/CONVEX_DEPLOY_KEY/self-hosted variables are blanked so the CLI provisions a throwaway local deployment instead of targeting the project's real cloud deployment. Boot-to-ready latency is logged for the e2e flake budget.

Signature

@nordcom/commerce-test-convex
function startConvex(opts: StartConvexOptions): Promise<StartedConvex>;

Parameters

NameTypeDescription
optsStartConvexOptions

Returns

A with the deployment URL, admin key, and stop handle.

Throws

When
no port can be acquired or the backend fails to become ready.

StartConvexOptions StartedConvex resolveConvexProjectDir resolveConvexStateDir

Sourcestart.ts:364↗Edit the JSDoc directly
Metadata@nordcom/commerce-test-convex@0.0.0Open in GitHub ↗

StartConvexOptions

Options for . All fields are optional; omitting them starts an ephemeral local Convex backend that is torn down on stop().

StartedConvex

Handle returned by . Carries the deployment URL and the admin key needed to authenticate writes, plus a stop() method that cleanly shuts the backend down, optio

On this page

SignatureParametersReturnsThrowsRelated