Giter Club home page Giter Club logo

ngx-logger's Introduction

Warning

This logger is under active development and hasn't yet reached its final form.

It may not be fully compatible with current versions of Angular.

Ngx-logger

Build Status

This is a simple library to log in Angular

Features:

  • a simple logger service
  • a simple log consumer which log in console
  • unit tests for the library
  • a demo application

Common tasks are present as npm scripts:

  • npm start to run a live-reload server with the demo app
  • npm run test to test in watch mode, or npm run test:once to only run once
  • npm run build to build the library
  • npm run lint to lint
  • npm run clean to clean
  • npm run integration to run the integration e2e tests
  • npm install ./relative/path/to/lib after npm run build to test locally in another app

To use this librairie :

@NgModule({
  imports: [
    LoggerModule.forRoot(LogLevelEnum.debug) // Set here the minimum log level
  ],
  providers: [
    ConsoleConsumer // Provide one or many Consumers
  ]
})
export class LoggerModule {
  // Inject eager provider to avoid lazy loading for this
  constructor(private consoleConsumer: ConsoleConsumer) {}
}

To write some log consumers :

@Injectable()
export class ConsoleConsumer {
  constructor(private loggerService: LoggerService) {
    loggerService.getLogs()
      .subscribe(log => console[LogLevelEnum[log.level]](... log.payload));
  }
}

Just replace console[LogLevelEnum[log.level]](... log.payload) with your own code and instantiate your consumer.

For use the logger :

You have to inject in your constructor the LoggerService and get an new instance given the class name (prefix) and use this instance for log the information

Example:

export class AppComponent implements OnInit {
  logger: Logger;

  constructor(loggerService: LoggerService) {
    this.logger = loggerService.create(this.constructor.name);
  }

  ngOnInit() {
    this.logger.log('Init App component');
    setInterval(() => {
      this.logger.warn('Interval', new Date());
    }, 1000);

  }

}

ngx-logger's People

Contributors

nicearma avatar

Stargazers

Alexandre Behaghel avatar  avatar  avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.