Class: ForbiddenException

Defined in: auth-server-ts/src/exceptions/forbidden-exception.ts:3

Base for every exception this package throws.

Carries:

httpStatus (HTTP status when applicable; 0 for local errors)
serverCode (the auth-server’s code envelope field, e.g. TOKEN_EXPIRED)
details (parsed body envelope; never assume keys)

Never put the server’s HTTP body verbatim into message — many apps log / display message directly. The server’s message is for engineers; the human-readable string lives in details when present.

Mirrors PHP’s Vendidit\AuthServer\Exceptions\VenAuthException.

Extends

VenAuthException

Constructors

Constructor

new ForbiddenException(message?, cause?): ForbiddenException

Defined in: auth-server-ts/src/exceptions/forbidden-exception.ts:4

Parameters

message?

string = 'Forbidden'

cause?

unknown

Returns

ForbiddenException

Overrides

VenAuthException.constructor

Properties

cause?

optional cause?: unknown

Defined in: auth-docs/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

VenAuthException.cause

details

details: Record<string, unknown> = {}

Defined in: auth-server-ts/src/exceptions/ven-auth-exception.ts:20

Inherited from

VenAuthException.details

httpStatus

readonly httpStatus: number

Defined in: auth-server-ts/src/exceptions/ven-auth-exception.ts:18

Inherited from

VenAuthException.httpStatus

message

message: string

Defined in: auth-docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

VenAuthException.message

name

name: string

Defined in: auth-docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

VenAuthException.name

serverCode

serverCode: string | null = null

Defined in: auth-server-ts/src/exceptions/ven-auth-exception.ts:19

Inherited from

VenAuthException.serverCode

stack?

optional stack?: string

Defined in: auth-docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

VenAuthException.stack

stackTraceLimit

static stackTraceLimit: number

Defined in: auth-server-ts/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

VenAuthException.stackTraceLimit

Methods

withServerContext()

withServerContext(serverCode, details): this

Defined in: auth-server-ts/src/exceptions/ven-auth-exception.ts:34

Parameters

serverCode

string | null

details

Record<string, unknown>

Returns

this

Inherited from

VenAuthException.withServerContext

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: auth-server-ts/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

VenAuthException.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Defined in: auth-server-ts/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

VenAuthException.prepareStackTrace