Home

Awesome

right-align-values NPM version Build Status

Right align the values of a given property for each object in an array. Useful for creating text columns or tables.

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm i right-align-values --save

Usage

object

align({
  a: 'b', 
  c: 'dddddd', 
  e: 'fff', 
  g: 'hhhhh'
});

Results in:

{
  a: '     b',
  c: 'dddddd',
  e: '   fff',
  g: ' hhhhh',
}

Specific property in object of objects

align('foo', {
  a: {
    foo: 'a',
    bar: 'z'
  },
  b: {
    foo: 'aaaaaaa',
    bar: 'z'
  },
  c: {
    foo: 'aaa',
    bar: 'z'
  }
});

Results in:

{ a: { foo: '      a', bar: 'z' },
  b: { foo: 'aaaaaaa', bar: 'z' },
  c: { foo: '    aaa', bar: 'z' } }

array of objects

var align = require('right-align-values');

var arr = [{a: 'b'}, {a: 'bb'}, {a: 'bbbb'}, {a: 'bbb'}, {a: 'bb'}];
align(arr, 'a');

Results in:

[
  {a: '   b'},
  {a: '  bb'},
  {a: 'bbbb'},
  {a: ' bbb'},
  {a: '  bb'}
];

Related projects

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb on December 27, 2015.