Ascii Table

Easy table output for node debugging, but you could probably do more with it, since its just a string.

Usage
Example
API
- Static Methods
- Instance Methods
Install
Contributors
License

Usage

Node.js

1
var AsciiTable = require('ascii-table')

Browser

1
<script src="ascii-table.min.js"></script>

Note : If using in the browser, it will be placed underwindow.AsciiTable

Example

Basic usage

1
2
3
4
5
6
7
8
var table = new AsciiTable('A Title')
table
  .setHeading('', 'Name', 'Age')
  .addRow(1, 'Bob', 52)
  .addRow(2, 'John', 34)
  .addRow(3, 'Jim', 83)

console.log(table.toString())

1
2
3
4
5
6
7
8
9
.----------------.
|    A Title     |
|----------------|
|   | Name | Age |
|---|------|-----|
| 1 | Bob  |  52 |
| 2 | John |  34 |
| 3 | Jim  |  83 |
'----------------'

We can make a simple table without a title or headings as well.

1
2
3
4
5
6
7
8
9
10
var table = new AsciiTable()

table
  .addRow('a', 'apple', 'Some longer string')
  .addRow('b', 'banana', 'hi')
  .addRow('c', 'carrot', 'meow')
  .addRow('e', 'elephants')


console.log(table.toString())

1
2
3
4
5
6
.------------------------------------.
| a | apple     | Some longer string |
| b | banana    | hi                 |
| c | carrot    | meow               |
| e | elephants |                    |
'------------------------------------'

API

Static Methods

AsciiTable

See: AsciiTable.factoryfor details on instantiation

AsciiTable.factory([title], [options])

Table instance creator

title- table title (optional, default null)
options- table options (optional)
- prefix- string prefix to add to each line on render

Note: If an object is passed in place of thetitle, thefromJSON method will be used to populate the table.

Example:

1
2
3
4
5
6
7
8
9
10
var table = AsciiTable.factory('title')

var table = AsciiTable.factory({
  title: 'Title'
, heading: [ 'id', 'name' ]
, rows: [ 
    [ 1, 'Bob' ]
  , [ 2, 'Steve' ] 
  ] 
})

AsciiTable.align(direction, val, len, [pad])

Shortcut to one of the three following methods

direction- alignment direction ( AsciiTable.LEFT, AsciiTable.CENTER, AsciiTable.RIGHT)
val- string to align
len- total length of created string
pad- padding / fill char (optional, default ' ')

Example:

1
table.align(AsciiTable.LEFT, 'hey', 7) // 'hey    '

AsciiTable.alignLeft(val, len, [pad])

val- string to align
len- total length of created string
pad- padding / fill char (optional, default ' ')

Example:

1
table.alignLeft('hey', 7, '-') // 'hey----'

AsciiTable.alignCenter(val, len, [pad])

val- string to align
len- total length of created string
pad- padding / fill char (optional, default ' ')

Example:

1
table.alignCenter('hey', 7) // '  hey  '

AsciiTable.alignRight(val, len, [pad])

val- string to align
len- total length of created string
pad- padding / fill char (optional, default ' ')

Example:

1
table.alignRight('hey', 7) // '    hey'

AsciiTable.alignAuto(val, len, [pad])

Attempt to do intelligent alignment of provided val, Stringinput will be left aligned, Numbertypes will be right aligned.

val- string to align
len- total length of created string
pad- padding / fill char (optional, default ' ')

Example:

1
table.align(AsciiTable.LEFT, 'hey', 7) // 'hey    '

AsciiTable.arrayFill(len, [val])

Create a new array at the given len, filled with the given value, mainly used internally

len- length of array
val- fill value (optional)

Example:

1
AsciiTable.arrayFill(4, 0) // [0, 0, 0, 0]

Instance Methods

instance.setBorder([edge], [fill], [top], [bottom])

Set the border characters for rendering, if no arguments are passed it will be reset to defaults. If a single edgearg is passed, it will be used for all borders.

edge- horizontal edges (optional, default |)
fill-vertical edges (optional, default -)
top- top corners (optional, default .)
bottom- bottom corners (optional, default ')

Example:

1
2
3
4
5
6
7
var table = new AsciiTable('Stars')
table
  .setBorder('*')
  .setHeading('oh', 'look')
  .addRow('so much', 'star power')

console.log(table.toString())

1
2
3
4
5
6
7
************************
*        Stars         *
************************
*   oh    *    look    *
************************
* so much * star power *
************************

instance.removeBorder()

Example:

1
2
3
table.removeBorder()

console.log('' + table)

1
2
3
4
5
6
  #     Fruit           Thing
 --- ----------- --------------------
  a       apple   Some longer string
  b      banana           hi
  c      carrot          meow
  e   elephants

instance.setAlign(idx, direction)

idx-column index to align
direction- alignment direction, ( AsciiTable.LEFT, AsciiTable.CENTER, AsciiTable.RIGHT)

Example:

1
2
3
4
5
table
  .setAlign(2, AsciiTable.RIGHT)
  .setAlign(1, AsciiTable.CENTER)

console.log(table.toString())

1
2
3
4
5
6
.-------------------------------------.
| a  |   apple   | Some longer string |
| b  |   banana  |                 hi |
| c  |   carrot  |               meow |
| e  | elephants |                    |
'-------------------------------------'

instance.setAlignLeft(idx)

Alias toinstance.setAlign(idx, AsciiTable.LEFT)

instance.setAlignCenter(idx)

Alias toinstance.setAlign(idx, AsciiTable.CENTER)

instance.setAlignRight(idx)

Alias toinstance.setAlign(idx, AsciiTable.RIGHT)

instance.setTitle(title)

title- table title

Example:

1
2
3
var table = new AsciiTable('Old Title')

table.setTitle('New Title')

instance.getTitle()

Get the current title of the table

Example:

1
table.getTitle() // 'New Title'

instance.setTitleAlign(direction)

direction- table alignment direction

Example:

instance.setTitleAlignLeft()

Alias toinstance.setTitleAlign(AsciiTable.LEFT)

instance.setTitleAlignCenter()

Alias toinstance.setTitleAlign(AsciiTable.CENTER)

instance.setTitleAlignRight()

Alias toinstance.setTitleAlign(AsciiTable.RIGHT)

instance.sort(iterator)

iterator- sorting method to run against the rows

Example:

1
2
3
4
table.sort(function(a, b) {
  return a[2] - b[2]
})
console.log(table.toString())

1
2
3
4
5
.----------------.
| 2 | John |  34 |
| 1 | Bob  |  52 |
| 3 | Jim  |  83 |
'----------------'

instance.sortColumn(index, iterator)

Sorting shortcut for targeting a specific column

index- column idx to sort
iterator- sorting method to run against column values

Example:

1
2
3
4
// This is quivalent to the `sort` example above
table.sortColumn(2, function(a, b) {
  return a - b
})

instance.setHeading(heading, [...])

Set the column headings for the table, takes arguments the same way asaddRow

heading- heading array or arguments

Example:

1
2
3
4
5
table.setHeading('ID', 'Key', 'Value')

// or:

table.setHeading(['ID', 'Key', 'Value'])

instance.setHeadingAlign(direction)

direction-

Example:

instance.setHeadingAlignLeft()

Alias toinstance.setHeadingAlignLeft(AsciiTable.LEFT)

instance.setHeadingAlignCenter()

Alias toinstance.setHeadingAlignLeft(AsciiTable.CENTER)

instance.setHeadingAlignRight()

Alias toinstance.setHeadingAlignLeft(AsciiTable.RIGHT)

instance.addRow(row, [...])

Rows can be added using a single array argument, or the arguments if multiple args are used when calling the method.

row- array or arguments of column values

Example:

1
2
3
4
5
6
7
var table = new AsciiTable()

table
  .addRow(1, 'Bob', 52)
  .addRow([2, 'John', 34])

console.log(table.render())

1
2
3
4
.---------------.
| 1 | Bob  | 52 |
| 2 | John | 34 |
'---------------'

instance.addRowMatrix(rows)

Bulk addRowoperation

rows- multidimentional array of rows

Example:

1
2
3
4
table.addRowMatrix([
  [2, 'John', 34]
, [3, 'Jim', 83]
])

instance.setJustify(enabled)

Justify all columns to be the same width

enabled- boolean for turning justify on or off, undefinedconsidered true

Example:

1
2
3
4
5
table
  .addRow('1', 'two', 'three')
  .setJustify()

console.log(table.toString())

1
2
3
.-----------------------.
| 1     | two   | three |
'-----------------------'

instance.toString()

Render the instance as a string for output

Alias : [ valueOf, render]

instance.toJSON()

Return the JSON representation of the table, this also allows us to call JSON.stringifyon the instance.

Example:

1
2
3
4
5
6
7
8
9
var table = new AsciiTable('Title')

table
  .setHeading('id', 'name')
  .addRow(1, 'Bob')
  .addRow(2, 'Steve')

console.log(table.toJSON())
console.log(JSON.stringify(table))

1
2
3
4
5
6
7
8{
  title: 'Title'
, heading: [ 'id', 'name' ]
, rows: [ 
    [ 1, 'Bob' ]
  , [ 2, 'Steve' ] 
  ] 
}

1
{"title":"Title","heading":["id","name"],"rows":[[1,"Bob"],[2,"Steve"]]}

instance.fromJSON(obj)

Populate the table from json object, should match the toJSONoutput above.

Alias : [ parse]

Example:

1
2
3
4
5
6
7
8
var table = new AsciiTable().fromJSON({
  title: 'Title'
, heading: [ 'id', 'name' ]
, rows: [ 
    [ 1, 'Bob' ]
  , [ 2, 'Steve' ] 
  ] 
})

instance.clear()

Clear/reset all table data

Alias : [ reset]

instance.clearRows()

Reset all row data, maintains title and headings.

Install

With npm

1
npm install ascii-table

Contributors

Matthew Oliveira Peter Daum

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge , publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Development Guide

Basic module

built-in objects

community module

Ascii Table

Table of Contents

Usage

Example

API

Static Methods

AsciiTable

AsciiTable.factory([title], [options])

AsciiTable.align(direction, val, len, [pad])

AsciiTable.alignLeft(val, len, [pad])

AsciiTable.alignCenter(val, len, [pad])

AsciiTable.alignRight(val, len, [pad])

AsciiTable.alignAuto(val, len, [pad])

AsciiTable.arrayFill(len, [val])

Instance Methods

instance.setBorder([edge], [fill], [top], [bottom])

instance.removeBorder()

instance.setAlign(idx, direction)

instance.setAlignLeft(idx)

instance.setAlignCenter(idx)

instance.setAlignRight(idx)

instance.setTitle(title)

instance.getTitle()

instance.setTitleAlign(direction)

instance.setTitleAlignLeft()

instance.setTitleAlignCenter()

instance.setTitleAlignRight()

instance.sort(iterator)

instance.sortColumn(index, iterator)

instance.setHeading(heading, [...])

instance.setHeadingAlign(direction)

instance.setHeadingAlignLeft()

instance.setHeadingAlignCenter()

instance.setHeadingAlignRight()

instance.addRow(row, [...])

instance.addRowMatrix(rows)

instance.setJustify(enabled)

instance.toString()

instance.toJSON()

instance.fromJSON(obj)

instance.clear()

instance.clearRows()

Install

Contributors

License