tableize-object

tableize-object

Tableize an object by flattening its keys into object paths (dot-notation).

Install

Install with npm:

$ npm install tableize-object --save

This is a simplified version of tableize, which also lower-cases keys and replaces spaces and dashes in keys with underscores. This library doesn't modify keys.

Usage

var tableize = require('tableize-object');

var obj = {
  foo: {
    bar: {
      baz: 'qux',
      fez: 'foo'
    },
    a: 'b',
    c: 'b',
    d: 'b',
  }
};

console.log(tableize(obj));
// results in:
//{ 'foo.bar.baz': 'qux',
//  'foo.bar.fez': 'foo',
//  'foo.a': 'b',
//  'foo.c': 'b',
//  'foo.d': 'b' }

Related projects

You might also be interested in these projects:

• collapse-object: Collapse an object into a string using the syntax from expand-object. This syntax is pretty… more | homepage
• expand-object: Expand a string into a JavaScript object using a simple notation. Use the CLI or… more | homepage
• get-value: Use property paths (a.b.c) to get a nested value from an object. | homepage
• isobject: Returns true if the value is an object and not an array or null. | homepage
• set-value: Create nested values and any intermediaries using dot notation ('a.b.c') paths. | homepage
• stringify-keys: Build an array of key paths from an object. | homepage

Contributing

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

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

Follow me on GitHub or Twitter for updates about tableize-object and my other libraries:

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v, on April 07, 2016.