0.1.12 • Published 4 years ago

filter-empty v0.1.12

Weekly downloads
20
License
MIT
Repository
github
Last release
4 years ago

Filter empty values from objects and/or arrays.

NPM Version NPM Downloads CircleCI codecov.io build BundleSize Dependencies DevDependencies PeerDependencies Patreon

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.
  • BundleSize BundleSize.

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

Codesandbox

Codesandbox Typescript

Contributing

  1. Fork the repository.

  2. 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
  1. Synchronize your local next branch with the upstream one:
git checkout next
git pull upstream next
  1. Install the dependencies:
npm install
  1. Create a new branch:
git checkout -b my-branch
  1. Make changes, commit and push to your fork:
git push -u origin HEAD
  1. Go to the repository and make a Pull Request.
0.1.12

4 years ago

0.1.10

4 years ago

0.1.11

4 years ago

0.0.9

4 years ago

0.1.9

4 years ago

0.0.8

5 years ago

0.0.7

5 years ago

0.0.6

5 years ago

0.0.5

5 years ago

0.0.3

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago