Merge pull request #13221 from kalmanbendeguz/patch-1

kamilmysliwiec · web-flow · commit c50eb48961ed · 2024-02-19T08:27:06.000+01:00
docs(common): remove incorrect constructor signature of HttpException
diff --git a/packages/common/exceptions/http.exception.ts b/packages/common/exceptions/http.exception.ts
@@ -28,7 +28,6 @@ export class HttpException extends Error {
    * Instantiate a plain HTTP Exception.
    *
    * @example
-   * throw new HttpException()
    * throw new HttpException('message', HttpStatus.BAD_REQUEST)
    * throw new HttpException('custom message', HttpStatus.BAD_REQUEST, {
    *  cause: new Error('Cause Error'),

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ export class HttpException extends Error {`
`28`	`28`	`* Instantiate a plain HTTP Exception.`
`29`	`29`	`*`
`30`	`30`	`* @example`
`31`		`- * throw new HttpException()`
`32`	`31`	`* throw new HttpException('message', HttpStatus.BAD_REQUEST)`
`33`	`32`	`* throw new HttpException('custom message', HttpStatus.BAD_REQUEST, {`
`34`	`33`	`* cause: new Error('Cause Error'),`