StartedConvex
●test-convex · /start·interface
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, optionally removing the on-disk data directory.
Properties
PROPTYPEDESCRIPTION
adminKey
string
Admin key authenticating privileged operations against the deployment.
stop
() => Promise<void>
Gracefully shuts down the backend, preserving ``dataDir`` when one was given.
url
string
Deployment URL the Convex client and seed helpers connect to.
Example
const { url, adminKey, stop } = await startConvex();
// pass url + adminKey to a ConvexClient or the seed helpers
await stop();Related
StartConvexOptions resolveConvexProjectDir resolveConvexStateDir startConvex