Class ForbiddenError

Hierarchy (view full)

CustomError
- ForbiddenError

Index

Constructors

Properties

cause? message name stack? code prepareStackTrace? stackTraceLimit

Accessors

Methods

toString captureStackTrace from instanceof

Constructors

constructor

new ForbiddenError(message?): ForbiddenError
Parameters
- message: string = 'Forbidden'
Returns ForbiddenError
Overrides CustomError.constructor
- Defined in src/errors.ts:71

Properties

`Optional`cause

cause?: unknown

message

message: string

name

name: string

`Optional`stack

stack?: string

`Static`code

code: number = 403

`Static` `Optional`prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Accessors

code

get code(): number
Returns number
Inherited from CustomError.code
- Defined in src/errors.ts:5
set code(c): void
Parameters
- c: number
Returns void
Inherited from CustomError.code
- Defined in src/errors.ts:6

Methods

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from CustomError.toString
- Defined in src/errors.ts:27

`Static`captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from CustomError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136

`Static`from

from(err): CustomError
Parameters
- err: Error
Returns CustomError
Inherited from CustomError.from
- Defined in src/errors.ts:13

`Static`instanceof

instanceof(err): boolean
Parameters
- err: Error
Returns boolean
Overrides CustomError.instanceof
- Defined in src/errors.ts:75