Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.14 KB

README.md

File metadata and controls

71 lines (51 loc) · 2.14 KB

deep-compact

NPM version Downloads Build Status Dependency status Dev Dependency status Greenkeeper badge

Recursively compacts collection values (arrays and objects), removing empty values from your arrays & objects.
It will also trim and remove empty strings.

Installation

$ npm install deep-compact - NPM
$ bower install deep-compact - bower

The browser file is named index.umd.js which supports CommonJS, AMD and globals (deepCompact). If you want to run this module on old browsers, you must include es5-shim.

Usage

var deepcompact = require('deep-compact');

deepcompact({
    something: [
        {
            colors: ['red', ' green ', ''],
            cars: { audi: 'nice', vw: 'good', aston: '  ' }
        },
        undefined,
        ''
    ],
    foo: 'bar'
});

/*
{
    something: [
        {
            colors: ['red', 'green'],
            cars: { audi: 'nice', vw: 'good' }
        }
    ],
    foo: 'bar'
});
*/

Additionally, deepcompact.isEmpty is exposed because it might be useful to use directly.

Tests

$ npm test

License

Released under the MIT License.