object-flatten-all-arrays

Merge and flatten any arrays found in all values within plain objects

Install

$ npm install --save object-flatten-all-arrays

Purpose

This library recursively walks through the input (nested or not nested array, object, whatever) and looks for plain objects that have arrays in any of their key values.

Then it will scan contents of those arrays. If there are multiple plain objects inside, it will merge them and sort their keys by alphabetical order. We anticipate that plain objects (in theory) can come with objects containing duplicate keys because we'll be using this library on JSON objects which can contain errors.

In practice, this library is one ofer the pieces of the set of libraries used to extract the Schema from a set of JSON files representing content which defines a set of email templates.

There are alternative definitions of "schema", but I define it as a superset representation that contains every key that each of the set pieces has.

The typical JSON "schema" library will only tell only the type of the first level of what it finds, like "This is an array-type value.". That's not enough. This library will traverse that array, find any plain objects within, merge and flatten them, so you know exactly what the data structure should be, in order to contain all possible variations in your data.

Use

var flatten = require('object-flatten-all-arrays')
var object = {
  a: 'a',
  b: 'b',
  c: [
    {
      b: 'b',
      a: 'a'
    },
    {
      d: 'd',
      c: 'c'
    }
  ]
}
var flattened = flatten(object)
console.log('flattened = ' + JSON.stringify(flattened, null, 4))
// => {
// a: 'a',
// b: 'b',
// c: [
//   {
//     a: 'a',
//     b: 'b',
//     c: 'c',
//     d: 'd'
//   }
// ]}

API

flatten(input)

API - Input

Testing

$ npm test

For unit tests we use AVA, Istanbul CLI and JS Standard notation.

Contributing

All contributions are welcome. Please stick to Standard JavaScript notation and supplement the test.js with new unit tests covering your feature(s).

If you see anything incorrect whatsoever, do raise an issue. If you file a pull request, I'll do my best to help you to get it merged in a timely manner. If you have any comments on the code, including ideas how to improve things, don't hesitate to contact me by email.

Licence

MIT License (MIT)

Copyright (c) 2016 Code and Send Ltd, Roy Reveltas

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.