ForbiddenError

Defined in: packages/permissions/src/errors.ts:23

Error thrown when a permission check fails during an operation.

Extends Error with structured fields for the denied action, target table, and role. Includes a toJSON() method so it can be serialized across the server/client boundary.

Extends

• Error

Constructors

Constructor

new ForbiddenError(options): ForbiddenError

Defined in: packages/permissions/src/errors.ts:38

Creates a new ForbiddenError.

Parameters

options

ForbiddenErrorOptions

The action, table, and optional role/descriptors for the error.

Returns

ForbiddenError

Overrides

Error.constructor

Properties

action

readonly action: PermissionAction

Defined in: packages/permissions/src/errors.ts:25

The action that was denied (e.g., "delete").

---

cause?

optional cause: unknown

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

Error.cause

---

descriptors

readonly descriptors: PermissionDescriptor[]

Defined in: packages/permissions/src/errors.ts:31

The full list of permission descriptors that were checked.

---

message

message: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

---

name

name: string

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

Inherited from

Error.name

---

role

readonly role: string | undefined

Defined in: packages/permissions/src/errors.ts:29

The role that lacked the permission, or undefined if not specified.

---

stack?

optional stack: string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

---

table

readonly table: object

Defined in: packages/permissions/src/errors.ts:27

The Drizzle table the action targeted.

---

stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.19.13/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

Error.stackTraceLimit

Methods

toJSON()

toJSON(): object

Defined in: packages/permissions/src/errors.ts:56

Serializes the error to a JSON-safe object for server-to-client transfer.

Returns

object

A plain object with name, message, action, table, and role fields.

action

action: PermissionAction

message

message: string

name

name: string

role

role: string | undefined

table

table: string

---

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@types+node@22.19.13/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

Error.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@types+node@22.19.13/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

Error.prepareStackTrace