tabject

Creates a text table from a given object.

npm install tabject
1 downloads in the last week
27 downloads in the last month

tabject build status

testling badge

Creates a text table from a given object.

var pack = require('../package');
var tabject = require('tabject');

console.log(tabject(pack, { maxKeyLength: 10,  maxValueLength: 60, table: { hsep: ' : ' } }));
name       : "tabject"
version    : "0.1.0"
descrip... : "Creates a text table from a given object."
main       : "index.js"
scripts    : {"test-main":"tap test/*.js","test-0.8":"nave use 0.8 npm...
repository : {"type":"git","url":"git://github.com/thlorenz/tabject.git"}
homepage   : "https://github.com/thlorenz/tabject"
depende... : {"text-table":"~0.1.1"}
devDepe... : {"nave":"~0.4.3","tape":"~1.0.4","tap":"~0.4.3"}
keywords   : ["table","format","object","render","align","tabular"]
author     : {"name":"Thorsten Lorenz","email":"thlorenz@gmx.de","url"...
license    : {"type":"MIT","url":"https://github.com/thlorenz/tabject/...
engine     : {"node":">=0.6"}
testling   : {"files":"test/*.js","browsers":["ie/8..latest","firefox/...

Installation

npm install tabject

API

tabject(obj[, opts])

Returns a string that represents the object in a tabular manner.

params:

  • obj Array|Object to tabularize
  • opts Object with the following properties:
    • maxKeyLength: {Number} limits the maximum number of chars for the object keys that are printed
    • maxValueLength: {Number} limits the maximum number of chars for the object values that are printed
    • excludeKeys: {Array[String]} excludes given keys from the tabularized string
    • excludeTypes: {Array[String]} excludes key and values from the tabularized string if the value is of any of the given types (default ['function'])
    • wrapKey: {Function} invoked with with (key, valueType), return from it whatever you want to replace the key with
    • wrapValue: {Function} invoked with with (value, valueType), return from it whatever you want to replace the value with
    • tab: {String} used to indent array elements (default: \t)
    • table: {Object} options passed through to text-table to configure alignment and horizontal separator

returns:

String tabularized object string

License

MIT

npm loves you