63 lines
2.3 KiB
Markdown
63 lines
2.3 KiB
Markdown
# beautylog
|
|
beautiful logging
|
|
|
|
## Status
|
|
[](https://travis-ci.org/pushrocks/beautylog)
|
|
[](https://david-dm.org/pushrocks/beautylog)
|
|
[](https://www.bithound.io/github/pushrocks/beautylog/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/beautylog)
|
|
|
|
## Usage
|
|
```javascript
|
|
|
|
### Simple Logging
|
|
var bl = require('beautylog'); //for use in OS console environment AND browser console
|
|
|
|
|
|
bl.log('some log message'); //normal console log message
|
|
bl.success('some success message'); //success console log message
|
|
bl.error('some error message'); //error console log message
|
|
|
|
//alternatively you can use a logType parameter
|
|
bl.log('some log message','normal');
|
|
bl.log('some success message','success');
|
|
bl.log('some error message','error');
|
|
```
|
|
The plugin produces beautiful output like this:
|
|
|
|
|
|
### Code Highlighting
|
|
|
|
|
|
|
|
### Console Tables
|
|
beautylog allows displaying data in nice tables for better overview.
|
|
|
|
There are different types of tables.
|
|
|
|
#### Custom
|
|
|
|
```javascript
|
|
var bl = require('beautylog')("os"); //for use in OS console environment
|
|
var myTable = bl.table.new("custom",["Heading1".blue,"Heading2".blue,"Heading3".blue]); // type "custom"
|
|
myTable.push(["check 1","success"]); // adds a row the myTable
|
|
myTable.push(["check 2","error"]); // adds a row the myTable
|
|
myTable.push(["check 3","error"]); // adds a row the myTable
|
|
myTable.print(); //prints myTable to the console
|
|
```
|
|
|
|
#### Checks
|
|
|
|
```javascript
|
|
var bl = require('beautylog')("os"); //for use in OS console environment
|
|
var myTable = bl.table.new("checks"); // type checks
|
|
myTable.push(["check 1","success"]); // adds a row the myTable
|
|
myTable.push(["check 2","error"]); // adds a row the myTable
|
|
myTable.push(["check 3","error"]); // adds a row the myTable
|
|
myTable.print(); //prints myTable to the console
|
|
```
|
|
|
|
The table from the code with type "checks" above looks like this:
|
|
|
|
|