Coder Social home page Coder Social logo

dead-leaves's Introduction

Dead Leaves

A utility for using a filter function to prune JavaScript objects

Install

npm install --save dead-leaves

Usage

import { prune } from 'dead-leaves'

const obj = {
  name: 'Bud',
  age: '',
  friends: []
}

const nextObj = prune(obj)

// data transformation is immutable
console.log(nextObj === obj) // false

// the default filter function removes all null or empty values
console.log(nextObj)
// {
//   name: 'Bud'
// }

How it works

Prune is called with data and a filter function. If you don't include a filter function, the default is used, which is called 'isNotNilOrEmpty'. You can also import isNotNilOrEmpty from dead-leaves. Each value is evaluated after it's children have been evaluated. In the case of isNotNilOrEmpty, if an object or array are empty after their children have been evaluated, they will also be removed. The passing values are copied into a new object, so the data is immutable. The parent object is always returned even if it fails the filter function.

Custom filter function

import { prune, isNotNilOrEmpty } from 'dead-leaves'

// removes: 2, null, undefined, '', {}, []
const filterFn = value => {
  return value !== 2 && isNotNilOrEmpty(value)
}

const nextObj = prune(obj, filterFn)

dead-leaves's People

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.