table-layout

Generates plain-text tables from JSON recordset input (array of objects). Useful for presenting text in column layout or data in table layout in text-based user interfaces. Also available as a command-line tool.

Synopsis

Where input looks like this:

json
[
  {
    "number": 15134,
    "title": "Coveralls has no source available ",
    "login": "ndelangen",
    "comments": 0
  },
  {
    "number": 15133,
    "title": "Fixing --preserve-symlinks. Enhancing node to exploit.",
    "login": "phestermcs",
    "comments": 0
  },
  {
    "number": 15131,
    "title": "Question - Confused about NPM's local installation philosophy",
    "login": "the1mills",
    "comments": 0
  },
  {
    "number": 15130,
    "title": "Question - global npm cache directory if user is root?",
    "login": "ORESoftware",
    "comments": 0
  }
]

This code...

js
const Table = require('table-layout')
const issues = require('./issues.json')
const table = new Table(issues, { maxWidth: 60 })
console.log(table.toString())

...produces this output:

15134  Coveralls has no source available   ndelangen     0
15133  Fixing --preserve-symlinks.         phestermcs    0
       Enhancing node to exploit.
15131  Question - Confused about NPM's     the1mills     0
       local installation philosophy
15130  Question - global npm cache         ORESoftware   0
       directory if user is root?
15127  how to installa gulp fontfacegen    aramgreat     0
       on Windows 10
15097  Cannot install package from         mastertinner  3
       tarball out of package.json entry
       generated by npm
15067  npm "SELF_SIGNED_CERT_IN_CHAIN"     LegendsLyfe   3
       error when installing discord.js
       with .log

API Reference

• [table-layout](#module_table-layout)
  • [Table](#exp_module_table-layout--Table) ⏏
    • [new Table(data, [options])](#new_module_table-layout--Table_new)
    • [table.renderLines()](#module_table-layout--Table+renderLines) ⇒ <code>Array.&lt;string&gt;</code>
    • [table.toString()](#module_table-layout--Table+toString) ⇒ <code>string</code>
    • [Table~columnOption](#module_table-layout--Table..columnOption)

<a name="exp_module_table-layout--Table"></a>

Table ⏏

Recordset data in (array of objects), text table out.

Kind: Exported class <a name="new_module_table-layout--Table_new"></a>

new Table(data, [options])

Params

• data <code>Array.&lt;object&gt;</code> - input data
• [options] <code>object</code> - optional settings
  • [.maxWidth] <code>number</code> - maximum width of layout
  • [.noWrap] <code>boolean</code> - disable wrapping on all columns
  • [.noTrim] <code>boolean</code> - disable line-trimming
  • [.break] <code>boolean</code> - enable word-breaking on all columns
  • [.columns] [<code>columnOption</code>](#module_table-layout--Table..columnOption) - array of column-specific options
  • [.ignoreEmptyColumns] <code>boolean</code> - if set, empty columns or columns containing only whitespace are not rendered.
  • [.padding] <code>object</code> - Padding values to set on each column. Per-column overrides can be set in the options.columns array.
    • [.left] <code>string</code> - Defaults to a single space.
    • [.right] <code>string</code> - Defaults to a single space.

Example

js
> Table = require('table-layout')
> jsonData = [{
  col1: 'Some text you wish to read in table layout',
  col2: 'And some more text in column two. '
}]
> table = new Table(jsonData, { maxWidth: 30 })
> console.log(table.toString())
 Some text you  And some more
 wish to read   text in
 in table      column two.
 layout

<a name="module_table-layout--Table+renderLines"></a>

table.renderLines() ⇒ <code>Array.&lt;string&gt;</code>

Identical to .toString() with the exception that the result will be an array of lines, rather than a single, multi-line string.

Kind: instance method of [<code>Table</code>](#exp_module_table-layout--Table) <a name="module_table-layout--Table+toString"></a>

table.toString() ⇒ <code>string</code>

Returns the input data as a text table.

Kind: instance method of [<code>Table</code>](#exp_module_table-layout--Table) <a name="module_table-layout--Table..columnOption"></a>

Table~columnOption

Kind: inner typedef of [<code>Table</code>](#exp_module_table-layout--Table) Properties

&copy; 2015-20 Lloyd Brookes \<75pound@gmail.com\>. Documented by jsdoc-to-markdown.