VexError

Defined in: packages/core/src/errors.ts:49

The error to throw from project code that Vex surfaces to editors — a field’s validate() today. Carries either a message or structured data (a code, ids, a message), which the admin panel receives intact with the failing field added.

Import this instead of a database’s own error class: the payload contract is Vex’s, so project code stays the same if the backend changes. On Convex it is a ConvexError, which is what lets the data cross to the client.

Example

validate: async ({ value, doc, vex }) => {
  const [existing] = await vex.find({ collection: "pages", withIndex: { name: "by_slug", range: (q) => q.eq("slug", value) }, limit: 1 })
  if (existing && existing._id !== doc._id) {
    throw new VexError({ code: "SLUG_CONFLICT", message: "This slug is already in use." })
  }
}

Extends

• ConvexError<TData>

Type Parameters

TData

TData extends string | VexErrorData = string | VexErrorData

Constructors

Constructor

new VexError<TData>(data): VexError<TData>

Defined in: packages/core/src/errors.ts:54

Parameters

data

TData

A message, or structured data. Include message in structured data for the text editors see.

Returns

VexError<TData>

Overrides

ConvexError<TData>.constructor

Properties

[IDENTIFYING_FIELD]

[IDENTIFYING_FIELD]: boolean

Defined in: node_modules/.pnpm/convex@1.44.0_react@19.2.7/node_modules/convex/dist/esm-types/values/errors.d.ts:6

Inherited from

ConvexError.[IDENTIFYING_FIELD]

---

cause?

optional cause?: unknown

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

ConvexError.cause

---

data

data: TData

Defined in: node_modules/.pnpm/convex@1.44.0_react@19.2.7/node_modules/convex/dist/esm-types/values/errors.d.ts:5

Inherited from

ConvexError.data

---

message

message: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

ConvexError.message

---

name

name: string

Defined in: node_modules/.pnpm/convex@1.44.0_react@19.2.7/node_modules/convex/dist/esm-types/values/errors.d.ts:4

Inherited from

VexAccessError.name

---

stack?

optional stack?: string

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

ConvexError.stack

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@20.19.43/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

ConvexError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@20.19.43/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

ConvexError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@20.19.43/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

ConvexError.prepareStackTrace