Class ForbiddenException

constructor

• new ForbiddenException(objectOrError: any, description?: string): ForbiddenException

• Instantiate a ForbiddenException Exception.

  example

  throw new ForbiddenException()

  usagenotes

  The HTTP response status code will be 403.

  • The objectOrError argument defines the JSON response body or the message string.
  • The description argument contains a short description of the HTTP error.

  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.

  Parameters

  • objectOrError: any

    string or object describing the error condition.

  • Default value description: string = "Forbidden"

    a short description of the HTTP error.

  Returns ForbiddenException