mofilterjs

filter.js

[![NPM version][npm-version-image]][npm-url]

filter.js filters array of object with few lines of codes. It is simple to use, scalable, light weight and very easy to use

Description

filter.js is a light weight, plain javascript package that can be used to filter large array of object.

Installation

npm i filter --save

Usage

...

import filter from "filter";

...

filter is an a function that receives 4 compulsory arguments.

• An array of the object you want to filter
• An array containing strings of values or keys in the object you want to filter the it with
• a string a number you want to use and filter the object with
• a callback that receives 2 arguments.
  • The first one returns the filtered data
  • Second returns error if not null

Example codes

...

import filter from "./filter.js"

const arrayObj = [
    {
        id: "1",
        name: "name1",
        product: "product1",
        email: "[e-mail]"
    },
    {
        id: "2",
        name: "name2",
        product: "product2",
        email: "[e-mail]"
    },
    {
        id: "3",
        name: "name3",
        product: "product3",
        email: "[e-mail]"
    },
    {
        id: "3",
        name: "name3",
        product: "product3",
        email: "[e-mail]"
    }
]


const val = "name3"
//can be anything that you want the use to find the data with
//val is the value from search input

filter(arrayObj, ["name", "email", "product"], val, (data, err)=>{
    if(err){
        console.log(err)
    }else{
        console.log(data)
    }
})

//results. Two objects with the name "name3" were found and returned

/*
    {
        id: "3",
        name: "name3",
        product: "product3",
        email: "[e-mail]"
    },
    {
        id: "3",
        name: "name3",
        product: "product3",
        email: "[e-mail]"
    }
*/

//if input value is empty string, all the object will be returned

...

Limitation

Cannot do deep object filtering for now. This feature comes soon.

Thank you...