![\"Nest](\"https://nestjs.com/img/logo_text.svg\"){kind=logo}
\n\n \n
\n A Nest http exception filter.\n
\n\n# NestJS Http Exception Filter\n\nA simple NestJS Http [Exception Filter](https://docs.nestjs.com/exception-filters) logging the HTTP response and formatting errors returned by the API.\n\n## Installation\n\n```bash\nnpm install --save @algoan/nestjs-http-exception-filter\n```\n\n## Usage\n### Default usage\nUse the http exception filter as a global filter (cf. refer to the [last paragraph](https://docs.nestjs.com/exception-filters#binding-filters) of this section for more details).\n\nExample:\n\n```typescript\nimport { Module } from '@nestjs/common';\nimport { APP_FILTER } from '@nestjs/core';\nimport { HttpExceptionFilter } from '@algoan/nestjs-http-exception-filter';\n\n/**\n * Core module: This module sets the http exception filter globally\n */\n@Module({\n providers: [\n {\n provide: APP_FILTER,\n useClass: HttpExceptionFilter,\n },\n ],\n})\nexport class CoreModule {}\n```\n\nExample 2:\n\n```typescript\nimport { NestFactory} from '@nestjs/core';\nimport {HttpExceptionFilter} from '@algoan/nestjs-http-exception-filter';\nimport { MainModule } from './main.module';\n\nasync function bootstrap() {\n const app = await NestFactory.create(MainModule,{\n });\n\n app.useGlobalFilters(new HttpExceptionFilter());\n await app.listen(3000);\n console.log(`App listening on port 3000`)\n}\nbootstrap();\n```\n\n### Default response body\n\n```typescript\n{\n \"code\": string,\n \"message\": string,\n \"status\": number\n}\n\n// Examples\n// 400\n{\n \"code\": \"BAD_REQUEST\",\n \"message\": \"Bad Request\",\n \"status\": 400\n}\n// 500\n{\n \"code\": \"INTERNAL_SERVER_ERROR\",\n \"message\": \"Internal Server Error\",\n \"status\": 500\n}\n// 413\n{\n code: 'PAYLOAD_TOO_LARGE',\n message: `\n Your request entity size is too big for the server to process it:\n - request size: 590001;\n - request limit: 102400.`,\n status: 413,\n}\n```\n\n### Default Logger messages\n```bash\n# Warning\n[Nest] 96665 - 04/14/2020, 6:35:27 PM [HttpExceptionFilter] Object:\n{\n \"message\": \"400 [GET /badrequest] has thrown an HTTP client error\",\n \"exceptionStack\": \"stackTrace\",\n \"headers\": {\n \"host\": \"localhost:3000\",\n \"user-agent\": \"insomnia/7.1.1\",\n \"accept\": \"*/*\"\n }\n}\n\n# Error\n[Nest] 96665 - 04/14/2020, 6:34:33 PM [HttpExceptionFilter] Object:\n{\n \"message\": \"500 [GET /error] has thrown a critical error\",\n \"headers\": {\n \"host\": \"localhost:3000\",\n \"user-agent\": \"insomnia/7.1.1\",\n \"accept\": \"*/*\"\n },\n \"exceptionStack\": \"stackTrace\",\n}\n```\n ","readmeFilename":"README.md"}