Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InternalServerErrorException

Defines an HTTP exception for Internal Server Error type errors.

see

Base Exceptions

publicapi

Hierarchy

Index

Constructors

constructor

  • Instantiate an InternalServerErrorException Exception.

    example

    throw new InternalServerErrorException()

    usagenotes

    The HTTP response status code will be 500.

    • 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 500.
    • message: the string 'Internal Server Error' 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

    • Optional objectOrError: string | object | any

      string or object describing the error condition.

    • Default value description: string = "Internal Server Error"

      a short description of the HTTP error.

    Returns InternalServerErrorException

Properties

message

message: string

name

name: string

Optional stack

stack: string

Methods

getResponse

  • getResponse(): string | object

getStatus

  • getStatus(): number

initMessage

  • initMessage(): void

Static createBody

  • createBody(objectOrError: object | string, description?: string, statusCode?: number): object

Generated using TypeDoc