VexAccessError

Defined in: packages/core/src/access/types.ts:951

Thrown by hasPermission when throwOnDenied: true and access is denied. Carries the subject and action.

Extends

• ConvexError<{ action: string; code: "ACCESS_DENIED"; message: string; resource: string; }>

Constructors

Constructor

new VexAccessError(options): VexAccessError

Defined in: packages/core/src/access/types.ts:969

Parameters

options

— Structured denial context.

action

string

— Action name.

message?

string

— Human-readable error message.

resource

string

— Subject name.

Returns

VexAccessError

Overrides

ConvexError<{ code: "ACCESS_DENIED"; resource: string; action: string; message: string; }>.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]

---

action

action: string

Defined in: packages/core/src/access/types.ts:961

The denied action.

---

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: object

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

action

action: string

code

code: "ACCESS_DENIED"

message

message: string

resource

resource: string

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

ConvexError.name

---

resource

resource: string

Defined in: packages/core/src/access/types.ts:958

The subject on which access was denied.

---

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