Ascii Table

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

Table of Contents

• Usage
• Example
• API
  • Constructor
  • Static Methods
    • align(direction, val, len, [pad])
    • alignLeft(val, len, [pad])
    • alignCenter(val, len, [pad])
    • alignRight(val, len, [pad])
    • alignAuto(val, len, [pad])
    • arrayFill(len, [val])
  • Instance Methods
    • setBorder([edge], [fill], [top], [bottom])
    • removeBorder()
    • setAlign(idx, direction)
    • setAlignLeft(idx)
    • setAlignCenter(idx)
    • setAlignRight(idx)
    • setTitle(title)
    • getTitle()
    • setTitleAlign(direction)
    • setTitleAlignLeft()
    • setTitleAlignCenter()
    • setTitleAlignRight()
    • sort([iterator])
    • sortColumn(idx, [iterator])
    • setHeading(heading, […])
    • setHeadingAlign(direction)
    • setHeadingAlignLeft()
    • setHeadingAlignCenter()
    • setHeadingAlignRight()
    • addRow(row, […])
    • addRowMatrix(rows)
    • setJustify([enabled])
    • toString()
    • toJSON()
    • fromJSON(obj)
    • clear()
    • clearRows()
• Install
• Contributors
• License

Usage

Deno

import AsciiTable, { AsciiAlign } from 'https://deno.land/x/ascii_table/mod.ts';

const table1 = new AsciiTable('Title')
table1
  .setHeadingAlign(AsciiAlign.CENTER)
  .setHeading('#', 'Name', 'Age')
  .addRow(1, 'Bob', 52)
  .addRow(2, 'John', 34)
  .addRow(3, 'Jim', 83)

const table2 = AsciiTable.fromJSON({
  title: 'Title',
  heading: [ 'id', 'name' ],
  rows: [
    [1, 'Bob'],
    [1, 'John'],
    [1, 'Jim']
  ]
})

console.log(table1.toString())
console.log(table2.toString())

Example

Basic usage

const 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())

.----------------.
|    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.

const 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())

.------------------------------------.
| a | apple     | Some longer string |
| b | banana    | hi                 |
| c | carrot    | meow               |
| e | elephants |                    |
'------------------------------------'

API

Constructor

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 the title, the fromJSON method will be used to populate the table.

Example:

const table = new AsciiTable('title')

Static Methods

AsciiTable

AsciiTable.fromJSON(AsciiData)

• title - table title
• heading - heading array or arguments
• rows - array or arguments of column values

const table = AsciiTable.fromJSON({
  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 (AsciiAlign.LEFT, AsciiAlign.CENTER, AsciiAlign.RIGHT)
• val - string to align
• len - total length of created string
• pad - padding / fill char (optional, default ' ')

Example:

table.align(AsciiAlign.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:

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:

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:

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

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

Attempt to do intelligent alignment of provided val, String input will be left aligned, Number types will be right aligned.

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

Example:

table.align(AsciiAlign.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:

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 edge arg 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:

var table = new AsciiTable('Stars')
table
  .setBorder('*')
  .setHeading('oh', 'look')
  .addRow('so much', 'star power')

console.log(table.toString())

************************
*        Stars         *
************************
*   oh    *    look    *
************************
* so much * star power *
************************

instance.removeBorder()

Example:

table.removeBorder()

console.log('' + table)

  #     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, (AsciiAlign.LEFT, AsciiAlign.CENTER, AsciiAlign.RIGHT)

Example:

table
  .setAlign(2, AsciiAlign.RIGHT)
  .setAlign(1, AsciiAlign.CENTER)

console.log(table.toString())

.-------------------------------------.
| a  |   apple   | Some longer string |
| b  |   banana  |                 hi |
| c  |   carrot  |               meow |
| e  | elephants |                    |
'-------------------------------------'

instance.setAlignLeft(idx)

Alias to instance.setAlign(idx, AsciiAlign.LEFT)

instance.setAlignCenter(idx)

Alias to instance.setAlign(idx, AsciiAlign.CENTER)

instance.setAlignRight(idx)

Alias to instance.setAlign(idx, AsciiAlign.RIGHT)

instance.setTitle(title)

• title - table title

Example:

var table = new AsciiTable('Old Title')

table.setTitle('New Title')

instance.getTitle()

Get the current title of the table

Example:

table.getTitle() // 'New Title'

instance.setTitleAlign(direction)

• direction - table alignment direction

Example:

instance.setTitleAlignLeft()

Alias to instance.setTitleAlign(AsciiAlign.LEFT)

instance.setTitleAlignCenter()

Alias to instance.setTitleAlign(AsciiAlign.CENTER)

instance.setTitleAlignRight()

Alias to instance.setTitleAlign(AsciiAlign.RIGHT)

instance.sort(iterator)

• iterator - sorting method to run against the rows

Example:

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

.----------------.
| 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:

// 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 as addRow

• heading - heading array or arguments

Example:

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

// or:

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

instance.setHeadingAlign(direction)

• direction -

Example:

instance.setHeadingAlignLeft()

Alias to instance.setHeadingAlignLeft(AsciiAlign.LEFT)

instance.setHeadingAlignCenter()

Alias to instance.setHeadingAlignLeft(AsciiAlign.CENTER)

instance.setHeadingAlignRight()

Alias to instance.setHeadingAlignLeft(AsciiAlign.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:

var table = new AsciiTable()

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

console.log(table.render())

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

instance.addRowMatrix(rows)

Bulk addRow operation

• rows - multidimentional array of rows

Example:

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, undefined considered true

Example:

table
  .addRow('1', 'two', 'three')
  .setJustify()

console.log(table.toString())

.-----------------------.
| 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.stringify on the instance.

Example:

var table = new AsciiTable('Title')

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

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

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

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

instance.fromJSON(obj)

Populate the table from json object, should match the toJSON output above.

Alias: [parse]

Example:

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.

License

MIT © eeve