Initial commit.

.gitignore

@@ -0,0 +1,90 @@
+# dist
+dist/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# IntelliJ
+.idea/

README.md

@@ -1,2 +1,38 @@
-# nestjs-exceptions
-Provides Nest.js based exceptions and filters. 
+# Nest.js exceptions
+
+Provides [Nest](https://nestjs.com/) custom exceptions and exception filters.
+
+## Installation
+
+```bash
+$ npm i nestjs-exceptions
+```
+
+## Usage
+
+### Integration Error
+
+You might want to use `IntegrationError` to wrap integration errors with a custom message.
+
+```typescript
+throw new IntegrationError(`Service runtime error.`, causeError);
+```
+
+### Bootstrap with global exception filter
+
+```typescript
+const bootstrap = async () => {
+    const app = await NestFactory.create(AppModule);
+    app.useGlobalFilters(new GlobalExceptionFilter());
+    ...
+    await app.listen(3000);
+};
+bootstrap();
+```
+
+`GlobalExceptionFilter` takes care mainly of internal server errors. 
+You can configure it during instantiation so that the original cause of 500 errors are returned back to the client. The default is `false` for security reasons.
+
+```typescript
+new GlobalExceptionFilter(true)
+```

index.ts

@@ -0,0 +1,2 @@
+export * from './src/exception/IntegrationError';
+export * from './src/exception/GlobalExceptionFilter';

jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};