The nest-bugsnag from vita-mojo

nest-bugsnag's Introduction

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

nest-bugsnag's People

Stargazers

Watchers

nest-bugsnag's Issues

Build error: Duplicate string index signature.

Error trace

tsc -p tsconfig.build.json

node_modules/@bugsnag/browser/dist/types/bugsnag.d.ts:22:5 - error TS2374: Duplicate string index signature.

22     [key: string]: any;
       ~~~~~~~~~~~~~~~~~~~

node_modules/@bugsnag/node/dist/types/bugsnag.d.ts:24:5 - error TS2374: Duplicate string index signature.

24     [key: string]: any;
       ~~~~~~~~~~~~~~~~~~~

node_modules/@bugsnag/node/dist/types/bugsnag.d.ts:32:5 - error TS2717: Subsequent property declarations must have the same type.  Property 'autoBreadcrumbs' must be of type 'boolean', but here has type 'void'.

32     autoBreadcrumbs?: void;
       ~~~~~~~~~~~~~~~

  node_modules/@bugsnag/node/dist/types/bugsnag-core/common.d.ts:7:3
    7   autoBreadcrumbs?: boolean;
        ~~~~~~~~~~~~~~~
    'autoBreadcrumbs' was also declared here.

My nest version

 "dependencies": {
    "@nestjs/common": "^6.11.11",
    "@nestjs/core": "^6.11.11",
    "@nestjs/jwt": "^6.1.2",
    "@nestjs/mongoose": "^6.4.0",
    "@nestjs/passport": "^6.2.0",
    "@nestjs/platform-express": "^6.11.11",
    "@nestjs/serve-static": "^1.0.2",
    "@nestjs/swagger": "^3.1.0",

  "devDependencies": {
    "@nestjs/schematics": "^6.8.1",
    "@nestjs/testing": "^6.11.11",