Api References NestJS

ForbiddenException

class

Defines an HTTP exception for Forbidden type errors.

  
class ForbiddenException extends HttpException {
  constructor(objectOrError?: any, descriptionOrOptions: string | HttpExceptionOptions = 'Forbidden')

  // inherited from nest/packages/common/HttpException
  static createBody<Body extends Record<string, unknown>>(arg0: HttpExceptionBodyMessage | Body, arg1?: HttpExceptionBodyMessage, statusCode?: number): HttpExceptionBody | Body
  static getDescriptionFrom(descriptionOrOptions: string | HttpExceptionOptions): string
  static getHttpExceptionOptionsFrom(descriptionOrOptions: string | HttpExceptionOptions): HttpExceptionOptions
  static extractDescriptionAndOptionsFrom(descriptionOrOptions: string | HttpExceptionOptions): DescriptionAndOptions
  constructor(response: string | Record<string, any>, status: number, options?: HttpExceptionOptions)
  cause: unknown
  initCause(): void
  initMessage()
  initName(): void
  getResponse(): string | object
  getStatus(): number

  // inherited from nest/packages/common/IntrinsicException
}

Constructor

Instantiate a ForbiddenException Exception.


constructor(objectOrError?: any, descriptionOrOptions: string | HttpExceptionOptions = 'Forbidden')

Parameters

Option Type Description

objectOrError

any

string or object describing the error condition.


Optional. Default is `undefined`.

descriptionOrOptions

string | HttpExceptionOptions

either a short description of the HTTP error or an options object used to provide an underlying error cause


Optional. Default is `'Forbidden'`.

Examples

    
`throw new ForbiddenException()`

Usage Notes

The HTTP response status code will be 403.

The objectOrError argument defines the JSON response body or the message string.
The descriptionOrOptions argument contains either a short description of the HTTP error or an options object used to provide an underlying error cause.

By default, the JSON response body contains two properties:

statusCode: this will be the value 403.
message: the string 'Forbidden' by default; override this by supplying a string in the objectOrError parameter.

If the parameter objectOrError is a string, the response body will contain an additional property, error, with a short description of the HTTP error. To override the entire JSON response body, pass an object instead. Nest will serialize the object and return it as the JSON response body.

See also#

Constructor

Parameters

Examples

Usage Notes#

See also

Usage Notes