new ImATeapotException(objectOrError: any, description?: string): ImATeapotException
Instantiate an ImATeapotException Exception.
example
throw new BadGatewayException()
usagenotes
The HTTP response status code will be 418.
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 418.
message: the string "I'm a Teapot" 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 = `I'm a teapot`
Defines an HTTP exception for ImATeapotException type errors. Defines an HTTP exception for ImATeapotException type errors.
Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.
Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout.
Base Exceptions
Base Exceptions