### A laravel-ignition like error page for [Nestjs Framework](https://nestjs.com/)
# NestJS Enlighten
### A laravel-ignition like error page for [Nestjs Framework](https://nestjs.com/)
### Dark Theme
## Installation
### Install this package by running one of these following commands below
##### Via npm:
```bash
npm install nestjs-enlighten --save
```
##### Via yarn:
```bash
yarn add nestjs-enlighten
```
## Usage
### Constructor Options
| Option Name | Required | Type | Default |
| ------ | ------ | ------ | ------|
| disableEnlighten | false | boolean | false |
| theme | false | 'theme-light' - 'theme-dark' | 'theme-light' |
#### As Global Filter
```typescript
import { NestEnlighten } from 'nestjs-enlighten';
async function bootstrap() {
const app = await NestFactory.create(ApplicationModule);
// Enables dark theme aswell
app.useGlobalFilters(new NestEnlighten({ theme: 'theme-dark' }));
await app.listen(3000);
}
bootstrap();
```
#### Enable/Disable for spesific endpoints
```typescript
import { NestEnlighten } from 'nestjs-enlighten';
@Controller('account')
// Lets say you want to disable this module for this endpoint
@UseFilters(new NestEnlighten({ disableEnlighten: true }))
export class AccountController {
@Get('/error-test')
throwError() {
throw new BadRequestException('Example message of 400 exception');
}
}
```
## TODO
- [x] Tests
- [x] Github Actions
- [ ] Online Stack share feature
- [ ] Add solution suggestions on unexpected errors in /src/Services/Errors/State/index.ts