index.js

'use strict';

var flattenObject = require( './../lib' );

function noop() {
	// Do nothing...
}

var obj = {
	'a': {
		'b': {
			'beep': 'boop',
			'foo': 'bar'
		},
		'c': [ 1, 2, 3 ],
		'd': true,
		'e': null,
		'f': 3.14,
		'g': new Date(),
		'h': {
			'bip': 6,
			'bop': [ 4, 5, 6 ]
		},
		'i': [ null, true, {} ],
		'j': /.*/,
		'k': noop,
		'l': NaN,
		'm': [],
		'n': new Buffer( 'hello' ),
		'o': {
			'data': new Float64Array( 10 )
		},
		'p': {
			'1': {
				'2': {
					'3': {}
				}
			}
		}
	}
};

var out = flattenObject( obj, {
	'depth': 5,
	'copy': true,
	'flattenArrays': false,
	'delimiter': '-|-'
});
console.dir( out );
/* =>
	{
		'a-|-b-|-beep': 'boop',
		'a-|-b-|-foo': 'bar',
		'a-|-c': [1,2,3],
		'a-|-d': true,
		'a-|-e': null,
		'a-|-f': 3.14,
		'a-|-g': <Date>,
		'a-|-h-|-bip': 6,
		'a-|-h-|-bop': [4,5,6],
		'a-|-i': [null,true,{}],
		'a-|-j': <RegExp>,
		'a-|-k': <Function>,
		'a-|-l': NaN,
		'a-|-m': [],
		'a-|-n': <Buffer>,
		'a-|-o-|-data': <Float64Array>,
		'a-|-p-|-1-|-2-|-3': {}
	}
*/