Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lmfresneda/loggerage
loggerage is a Javascript logger who saves the register directly on localStorage or your own storage if you want
https://github.com/lmfresneda/loggerage
csv javascript javascript-logger localstorage logger logging storage typescript
Last synced: 6 days ago
JSON representation
loggerage is a Javascript logger who saves the register directly on localStorage or your own storage if you want
- Host: GitHub
- URL: https://github.com/lmfresneda/loggerage
- Owner: lmfresneda
- License: mit
- Created: 2016-05-07T19:29:26.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-27T14:11:34.000Z (over 7 years ago)
- Last Synced: 2024-12-25T04:32:41.970Z (11 days ago)
- Topics: csv, javascript, javascript-logger, localstorage, logger, logging, storage, typescript
- Language: JavaScript
- Homepage: http://lmfresneda.github.io/loggerage/
- Size: 621 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
## loggerage
[](https://www.npmjs.com/package/loggerage) [](https://www.npmjs.com/package/loggerage)  [](https://travis-ci.org/lmfresneda/loggerage) [](https://coveralls.io/github/lmfresneda/loggerage)
[http://lmfresneda.github.io/loggerage/](http://lmfresneda.github.io/loggerage/)
loggerage is a Javascript logger who saves the register directly on localStorage or your own storage if you want. It also is able to create a .csv or .txt file with the log content.
### How to use
```
$ npm install --save loggerage
```
```javascript
const { Loggerage, LoggerageLevel } = require("loggerage");
const logger = new Loggerage("MY-APP");
logger.debug("Hello world!");
```
First parameter is the name to identify our application, it means it has to be unique for the logger. This construction will use the default 'localStorage'. [See constructor explanation](http://lmfresneda.github.io/loggerage/reference/index_reference/#constructor) for more options
So the logger gives back most of the methods, we can chain calls (chaining) in sync methods:
```javascript
logger.
debug("Hello world!").
info("Info message").
debug("End");
```
### Reference
You have a complete reference on [this page](http://lmfresneda.github.io/loggerage/reference/index_reference/)
### About async methods
All async methods require a callback parameter that recive at first parameter an error if occurs, and in the second parameter recive data if is neccesary, like a log for example.
```javascript
logger.getLogAsync((err, log) => {
if(null != err) return handleError(err);
console.log(log); // OK!
});
```
**IMPORTANT**: We recommend returning a promise in storage methods when we are going to work with asynchronous methods of Loggerage, but not is required. The calls to storage methods, inside async methods of Loggerage, are wrapped by `Promise.resolve` always.
### Convert async methods to Promises
Now you can use the [`loggerage-promisify`](https://github.com/lmfresneda/loggerage-promisify) helper for promisify methods. You can promisify the methods with `Async` suffix or promisify all methods.
Example:
```javascript
const { Loggerage } = require("loggerage");
const promisify = require('loggerage-promisify')
const logger = promisify(new Loggerage("MY-APP"));
logger.debug("Hello world!") // is a promise now!
.then(() => {
return logger.getLog();
})
.then((log) => {
// handle log!
})
.catch(handleError);
```
See [`loggerage-promisify`](https://github.com/lmfresneda/loggerage-promisify) for more information.
### Contributing
* [See contributing page](http://lmfresneda.github.io/loggerage/contributing/)
### License
* [See MIT License](http://lmfresneda.github.io/loggerage/license/)