Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 3.35 KB

README.md

File metadata and controls

100 lines (70 loc) · 3.35 KB

jsLogger

A simple JavaScript plugin that automatically logs your runtime errors, AJAX errors and rejected Promises.
Report a bug · Request a feature

GitHub issues GitHub contributors GitHub GitHub forks

Table of contents
  1. About the project
  2. Getting started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About the project

jsLogger originated from the need to log the JavaScript errors that occur during runtime in a file.

It depends on having a logging platform in the backend to write in the file, but it takes care of detecting and logging code errors, AJAX errors and even rejected Promises.

It also offers the user simple methods to log anything they want with differents levels.

Getting started

For jsLogger to work, all you need to do is set up a method in your backend that handles the logging.

In this example I'm using the .NET framework and NLog:

Usage

jsLogger automatically logs any error caused on runtime, any rejected Promise and any error caused in a AJAX request. But if you also want to manually log something, you can do it by using any of it's methods: Info, Debug, Error or Exception.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the project.
  2. Create your feature nranch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Lucas Damián Lobasso - [email protected]

Project link: https://github.com/lucaslobasso/js_logger