filter-empty
v0.1.12
Published
Filter empty values from objects and arrays
Downloads
58
Maintainers
Readme
Filter empty values from objects and/or arrays.
Filter-Empty is a Typescript library for removing empty values from objects.
Features
- Filters empty values from objects and arrays.
- Creates new mutation free objects
- Recurses nested props.
- .
Benefits
- New objects free of null, undefined, empty arrays, and empty strings.
- Removal of empty nested props.
- Light, fast, and dependency free lib.
Motivation
Working with graphql and its great type safty results in null values for some props. Sometime in consuming these props on the client it's better to remove the empty props rather than implementing conditionals.
Installation
npm install -S filter-empty
Usage
Here is an example to get you started:
import filterEmpty from 'filter-empty'
const objToFilter = {
level1: {
level2: {
level3: {
key1: 'This value is ok',
key2: null,
key3: ['', null, 'This is also ok'],
},
},
},
}
const filtered = filterEmpty(objToFilter)
// result
// {
// level1: {
// level2: {
// level3: {
// key1: 'This value is ok'
// key3: ['This is also ok']
// }
// }
// }
// }
Examples
Contributing
Fork the repository.
Clone the fork to your local machine and add upstream remote:
git clone https://github.com/<your username>/filter-empty.git
cd filter-empty
git remote add upstream https://github.com/PaulSavignano/filter-empty.git
- Synchronize your local
next
branch with the upstream one:
git checkout next
git pull upstream next
- Install the dependencies:
npm install
- Create a new branch:
git checkout -b my-branch
- Make changes, commit and push to your fork:
git push -u origin HEAD
- Go to the repository and make a Pull Request.