forked from nestjs/nest
/
bad-gateway.exception.ts
54 lines (52 loc) 路 2.07 KB
/
bad-gateway.exception.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import { HttpStatus } from '../enums/http-status.enum';
import { isString } from '../utils/shared.utils';
import { HttpException, HttpExceptionOptions } from './http.exception';
/**
* Defines an HTTP exception for *Bad Gateway* type errors.
*
* @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
*
* @publicApi
*/
export class BadGatewayException extends HttpException {
/**
* Instantiate a `BadGatewayException` Exception.
*
* @example
* `throw new BadGatewayException()`
*
* @usageNotes
* The HTTP response status code will be 502.
* - 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 502.
* - `message`: the string `'Bad Gateway'` 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.
*
* @param objectOrError string or object describing the error condition.
* @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
*/
constructor(
objectOrError?: string | object | any,
descriptionOrOptions: string | HttpExceptionOptions = 'Bad Gateway',
) {
const { description, httpExceptionOptions } =
HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
super(
HttpException.createBody(
objectOrError,
description,
HttpStatus.BAD_GATEWAY,
),
HttpStatus.BAD_GATEWAY,
httpExceptionOptions,
);
}
}