Class HttpException

constructor

• new HttpException(
      response: string | Record<string, any>,
      status?: number,
      options?: HttpExceptionOptions,
  ): HttpException

  Instantiate a plain HTTP Exception.

  Parameters

  • response: string | Record<string, any>

    String, object describing the error condition or the error cause.
  • Optionalstatus: number

    HTTP response status code.
  • Optionaloptions: HttpExceptionOptions

    An object used to add an error cause. Configures error chaining support

  Returns HttpException

  Example

  throw new HttpException('message', HttpStatus.BAD_REQUEST);
    throw new HttpException('custom message', HttpStatus.BAD_REQUEST, {
      cause: new Error('Cause Error'),
    });
  Copy

  Usage Notes

  The constructor arguments define the response and the HTTP response status code.

  • The response argument (required) defines the JSON response body. alternatively, it can also be an error object that is used to define an error cause.
  • The status argument (optional) defines the HTTP Status Code.
  • The options argument (optional) defines additional error options. Currently, it supports the cause attribute, and can be used as an alternative way to specify the error cause: const error = new HttpException('description', 400, { cause: new Error() });

  By default, the JSON response body contains two properties:

  • statusCode: the Http Status Code.
  • message: a short description of the HTTP error by default; override this by supplying a string in the response parameter.

  The status argument is required, and should be a valid HTTP status code. Best practice is to use the HttpStatus enum imported from nestjs/common.

  See

  • https://nodejs.org/en/blog/release/v16.9.0/#error-cause
  • https://github.com/microsoft/TypeScript/issues/45167

Optional Readonlycause

Optional Readonlycode

Readonlyresponse

Readonlystatus

Optional ReadonlystatusText