flatten-obj/test.js

Converts an object literal with deeply nested nodes to a simple key/value object

'use strict'

var test = require('tape')
var Flatten = require('./')

test('only flatten nested objects', function (t) {
  var flatten = Flatten()

  var obj = {
    number: 1,
    string: 'foo',
    bool: true,
    arr1: [1, 2, 3],
    arr2: [{ foo: 1 }, { bar: 2 }],
    sub: { foo: 1, bar: { baz: 3 } }
  }

  t.deepEqual(flatten(obj), {
    number: 1,
    string: 'foo',
    bool: true,
    arr1: [1, 2, 3],
    arr2: [{ foo: 1 }, { bar: 2 }],
    'sub.foo': 1,
    'sub.bar.baz': 3
  })

  t.end()
})

test('do not traverse black listed types', function (t) {
  var Klass = function () {
    this.foo = 1
  }
  var instance = new Klass()
  var flatten = Flatten({ blacklist: [Klass] })

  var obj = {
    a: {
      a: 1
    },
    b: {
      a: instance
    }
  }

  t.deepEqual(flatten(obj), {
    'a.a': 1,
    'b.a': instance
  })

  t.end()
})

test('support custom separator', function (t) {
  var obj = {
    sub: { foo: 1, bar: { baz: 3 } }
  }
  var flatten = Flatten({ separator: '_' })

  t.deepEqual(flatten(obj), {
    'sub_foo': 1,
    'sub_bar_baz': 3
  })

  t.end()
})

test('support empty string separator', function (t) {
  var obj = {
    sub: { foo: 1, bar: { baz: 3 } }
  }
  var flatten = Flatten({ separator: '' })

  t.deepEqual(flatten(obj), {
    'subfoo': 1,
    'subbarbaz': 3
  })

  t.end()
})

test('support no prefix', function (t) {
  var obj = {
    sub: { foo: 1, bar: { baz: 3 } }
  }
  var flatten = Flatten({ onlyLeaves: true })

  t.deepEqual(flatten(obj), {
    foo: 1,
    baz: 3
  })

  t.end()
})