omit-empty

Recursively omit empty properties from an object. Omits empty objects, arrays, strings or zero.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save omit-empty

Heads up!

Breaking changes in v1.0.0! See the Release History.

Usage

const omitEmpty = require('omit-empty');

console.log(omitEmpty({ a: 'a', b: '' }));
//=> { a: 'a' }

console.log(omitEmpty({ a: 'a', b: { c: 'c', d: '' } }));
//=> { a: 'a', b: { c: 'c' } }

console.log(omitEmpty({ a: ['a'], b: [] }));
//=> { a: ['a'] }

console.log(omitEmpty({ a: 0, b: 1 }));
//=> { a: 0, b: 1 }

// set omitZero to true, to evaluate "0" as falsey
console.log(omitEmpty({ a: 0, b: 1 }, { omitZero: true }));
//=> { b: 1 }

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

is-plain-object: Returns true if an object was created by the Object constructor. | homepage
isobject: Returns true if the value is an object and not an array or null. | homepage
kind-of: Get the native type of a value. | homepage

Contributors

Commits	Contributor
31	jonschlinkert
1	kakadiadarpan

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.8.0, on December 10, 2018.

jonschlinkert/omit-empty