Package Exports

tty-table
tty-table/adapters/automattic-cli-table

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (tty-table) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

tty-table 电传打字台

Display your data in a table using a terminal, browser, or browser console.

Installation

Terminal:

$ npm install tty-table -g

Node Module

$ npm install tty-table

Browser

<script src="tty-table.bundle.min.js"></script>
<script>
 let Table = require('tty-table');
 ...
</script>

Examples

Terminal (Static)

examples/styles-and-formatting.js

Static

Terminal (Streaming)

$ node examples/data/fake-stream.js | tty-table --format json --header examples/config/header.js

Streaming

See the built-in help for the terminal version of tty-table with:

$ tty-table -h

Browser & Browser Console

examples/browser-example.html

Browser Console Example

Working Example in Browser

Note that neither ASCI colors nor default borders are rendered in the browser. An alternative border style, as shown below, should be used by setting the following option:
borderStyle : "dashed"

API Reference

Table

Kind: global class

Table
- Table(header, rows, options)
- .tableObject.render() ⇒ String

Table(header, rows, options)

Param	Type	Description
header	`array`	See example
header.column	`object`	Column options
header.column.alias	`string`	Alternate header column name
header.column.align	`string`	default: "center"
header.column.color	`string`	default: terminal default color
header.column.footerAlign	`string`	default: "center"
header.column.footerColor	`string`	default: terminal default color
header.column.formatter	`function`	Runs a callback on each cell value in the parent column
header.column.headerAlign	`string`	default: "center"
header.column.headerColor	`string`	default: terminal's default color
header.column.marginLeft	`number`	default: 0
header.column.marginTop	`number`	default: 0
header.column.width	`string` \| `number`	default: "auto"
header.column.paddingBottom	`number`	default: 0
header.column.paddingLeft	`number`	default: 1
header.column.paddingRight	`number`	default: 1
header.column.paddingTop	`number`	default: 0
rows	`array`	See example
options	`object`	Table options
options.borderStyle	`string`	default: "solid". options: "solid", "dashed", "none"
options.borderCharacters	`object`	See @note
options.borderColor	`string`	default: terminal's default color
options.compact	`boolean`	default: false Removes horizontal lines when true.
options.defaultErrorValue	`mixed`	default: 'ERROR!'
options.defaultValue	`mixed`	default: '?'
options.errorOnNull	`boolean`	default: false
options.truncate	`mixed`	default: false When this property is set to a string, cell contents will be truncated by that string instead of wrapped when they extend beyond of the width of the cell. For example if: `"truncate":"..."` the cell will be truncated with "..."

Example

let Table = require('tty-table');
let t1 = Table(header,rows,options);
console.log(t1.render());

Table.tableObject.render() ⇒ `String`

Add method to render table to a string

Kind: static method of Table
Example

let str = t1.render(); 
console.log(str); //outputs table

Running tests

$ npx grunt test

Saving the output of new unit tests

$ npx grunt st

Because:

node script.js --color=always

Dev Tips

To generate vim tags (make sure jsctags is installed globally)

$ npx grunt tags

To generate vim tags on file save

$ npx grunt watch

Packaging as a distributable

License

MIT License

tty-table