README.md

A Nest module wrapper for bugsnag logger.

Description

A Nest module wrapper for bugsnag-js logger.

Installation

$ npm i nest-bugsnag --save

Publish to npm

$ npm run clean:build
$ cd dist
$ npm publish

Quick Start

Import the BugsnagModule into the module. For example AppModule:

import { Module } from '@nestjs/common';
import { BugsnagModule } from 'nest-bugsnag';

@Module({
  imports: [
    BugsnagModule.forRoot({
      // options
    }),
  ],
})
export class AppModule { }

Then you can inject BugsnagService. Example:

import { Controller } from '@nestjs/common';
import { BugsnagService } from 'nest-bugsnag';

@Controller('cats')
export class CatsController {
  constructor(private readonly logger: BugsnagService) { }
}

BugsnagService has instance property which wrap bugsnag client. So you can access it by calling:

this.logger.instance.notify('message');

Note that BugsnagModule is a global module, it will be available in all you feature modules.

Async configuration Sample

import { Module } from '@nestjs/common';
import { BugsnagModule } from 'nest-bugsnag';
import { ConfigService } from 'nest-config';

@Module({
  imports: [
    BugsnagModule.forRootAsync({
      useFactory: (configService: ConfigService) => ({
        // options
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule { }

The factory might be async and is able to inject dependencies through the inject option.

Keywords

bugsnagJs, nestJs, logger