File: README.md

package info (click to toggle)
node-ansi-color-table 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch
  • size: 104 kB
  • ctags: 21
  • sloc: makefile: 2
file content (76 lines) | stat: -rw-r--r-- 2,317 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
ANSI COLOR TABLE
================
Tables for cli/stdout supporting colors using [ansi](https://github.com/TooTallNate/ansi.js) npm module.
Based on [text-table](https://github.com/substack/text-table) but using ansi cursor, not color codes.

[![Build Status](https://travis-ci.org/quimcalpe/reusable-templates.png)](https://travis-ci.org/quimcalpe/ansi-color-table)

###Examples
**Table with colors and default options**
```javascript
var table = require('ansi-color-table');

var data = [
  [ "Username".blue().underline(), "Email".blue().underline(), "active".blue().underline() ],
  [ "john.smith", "john@gimail.com".yellow(), "yes".green() ],
  [ "steve.balmes", "sbalmes@hotma.il".yellow(), "yes".green() ],
  [ "james.durango", "james.durango@greenvine.com".yellow(), "no".red() ],
  [ "elisa.polite", "epolite@".yellow(), "yes".green() ]
];

table(data);
```
**Custom align, custom separator, centered header**
```javascript
var table = require('../');

var data = [
  [ "Username".blue().underline(), "Email".blue().underline(), "Age".blue().underline(), "Active".blue().underline() ],
  [ "john.smith", "john@gimail.com".yellow(), "9".white(), "yes".green() ],
  [ "steve.balmes", "sbalmes@hotma.il".yellow(), "19".white(), "yes".green() ],
  [ "james.durango", "james.durango@greenvine.com".yellow(), "99".white(), "no".red() ],
  [ "elisa.polite", "epolite@".yellow(), "109".white(), "yes".green() ]
];

table(data, {
  align : [ "left", "left", "right", "center" ],
  separator : " | ",
  headerAlign: "center"
});
```
**Redirect output to custom stream intead of `process.stdout`**
```javascript
var table = require('../');
var Stream = require('stream');

var tableData = [
  [ "Username".blue().underline(), "Email".blue().underline(), "active".blue().underline() ],
  [ "john.smith", "john@gimail.com".yellow(), "yes".green() ],
  [ "steve.balmes", "sbalmes@hotma.il".yellow(), "yes".green() ]
];

var output_stream = new Stream();
var output_data = "";
output_stream.write = function (data) {
  output_data += data;
};
output_stream.end = function () {
  // do something with data
  console.log(output_data);
};

table(tableData, {}, output_stream);
```
### Installation
With [npm](https://npmjs.org) do:
```bash
$ npm install ansi-color-table
```

### Testing
```bash
$ npm test
```

### License
MIT