nestjs-flub
v0.1.2
Published
Pretty Error Stack Viewer for NestJS Framework
Downloads
95
Readme
Pretty ErrorHandler 😫, Stack Viewer for Nestjs Framework 🛠️
it's just a simple
Filter
for Catching the Errors
Features
HTML reporter
JSON reporter, if request accepts a json instead of text/html.
Sorted frames of error stack.
Themes
Dark Theme
Light Theme
Install
npm install nestjs-flub --save
Simple Usage
Just add this filter as you would any filter:
import { FlubErrorHandler } from 'nestjs-flub';
@Controller('cats')
@UseFilters(new FlubErrorHandler())
export class CatsController {
@Get('/error')
throwError() {
throw new Error('Very Bad Error');
}
}
Configuration
FlubErrorHandler accepts an optional object to configure the Error Handler. For now, it only has two Options:
theme: string; // for themes ['dark', 'light', 'default']
quote: boolean; // for displaying very good quotes
example
@UseFilters(new FlubErrorHandler({ theme: 'dark', quote:true }))
Theming
copy /src/themes/error.default.mustache
and play
TODO
- [ ] Write Tests
- [ ] list syntax required
Contributing
You are welcome to contribute to this project. If you want to add new themes, make a new PR containing the theme and a simple image to represent it
Global filters
Use flub error handler for all controllers
async function bootstrap() {
const app = await NestFactory.create(ApplicationModule);
app.useGlobalFilters(new FlubErrorHandler());
await app.listen(3000);
}
bootstrap();