Flatten Object

Usage

var flattenObject = require( '@stdlib/utils/flatten-object' );

flattenObject( obj[, options] )

Flattens an object.

var obj = {
    'a': {
        'b': {
            'c': 'd'
        }
    }
};

var out = flattenObject( obj );
// returns { 'a.b.c': 'd' }

The function accepts the following options:

• depth: maximum depth to flatten.
• copy: boolean indicating whether to deep copy property values. Default: false.
• delimiter: key path delimiter. Default: '.'.
• flattenArrays: boolean indicating whether to flatten arrays. Default: false.

To flatten to a specified depth, set the depth option.

var obj = {
    'a': {
        'b': {
            'c': 'd'
        }
    }
};

var out = flattenObject( obj, {
    'depth': 1
});
// returns { 'a.b': {'c': 'd'} }

var bool = ( obj.a.b === out['a.b'] );
// returns true

To deep copy property values, set the copy option to true.

var obj = {
    'a': {
        'b': {
            'c': 'd'
        }
    }
};

var out = flattenObject( obj, {
    'depth': 1,
    'copy': true
});
// returns { 'a.b': { 'c': 'd' } }

var bool = ( obj.a.b === out['a.b'] );
// returns false

To specify a custom key path delimiter, set the delimiter option.

var obj = {
    'a': {
        'b': {
            'c': 'd'
        }
    }
};

var out = flattenObject( obj, {
    'delimiter': '-|-'
});
// returns { 'a-|-b-|-c': 'd' }

By default, the function does not flatten arrays. To flatten arrays, set the flattenArrays option to true.

var obj = {
    'a': {
        'b': [ 1, 2, 3 ]
    }
};

var out = flattenObject( obj, {
    'flattenArrays': true
});
// returns { 'a.b.0': 1, 'a.b.1': 2, 'a.b.2': 3 }

flattenObject.factory( options )

Returns a function to flatten an object.

var flatten = flattenObject.factory({
    'delimiter': '|',
    'flattenArrays': true
});

var obj = {
    'a': {
        'b': {
            'c': 'd'
        }
    }
};

var out = flatten( obj );
// returns { 'a|b|c': 'd' }

obj = {
    'a': {
        'b': [ 1, 2, 3 ]
    }
};
out = flatten( obj );
// returns { 'a|b|0': 1, 'a|b|1': 2, 'a|b|2': 3 }

The function accepts the same options as flattenObject().