Filter

Filter the array to a subset of it based on provided criteria.

Install

$ npm i @mcabreradev/filter

$ yarn add @mcabreradev/filter

Usage

const filter = require("@mcabreradev/filter");

const customers = [
  { "name" : "Alfreds Futterkiste", "city" : "Berlin" },
  { "name" : "Around the Horn", "city" : "London" },
  { "name" : "B's Beverages", "city" : "London" },
  { "name" : "Bolido Comidas preparadas", "city" : "Madrid" },
  { "name" : "Bon app", "city" : "Marseille" },
  { "name" : "Bottom-Dollar Marketse" ,"city" : "Tsawassen" },
  { "name" : "Cactus Comidas para llevar", "city" : "Buenos Aires" }
];

Filter customers with a specific city

filter(customers, 'Berlin' );

// [ { name: 'Alfreds Futterkiste', city: 'Berlin' } ]

Filter customer with a specific city and name containing 'o' letter

filter(customers, {'name' : 'O', 'city' : 'London'});

// [ { name: 'Around the Horn', city: 'London' } ]

Filter customers with a half name of city

filter(customers, {'city' : 'Mars'} );

// [ { name: 'Bon app', city: 'Marseille' } ]

Filter customers with a single letter

filter(customers, {'city' : 's'} );

// [
//   { name: 'Bon app', city: 'Marseille' },
//   { name: 'Bottom-Dollar Marketse', city: 'Tsawassen' },
//   { name: 'Cactus Comidas para llevar', city: 'Buenos Aires' }
// ]

Filter customers with two single letters

filter(customers, {'city' : 'B', 'city' : 'L'} );

// [
//   { name: 'Bon app', city: 'Marseille' },
//   { name: 'Bottom-Dollar Marketse', city: 'Tsawassen' },
//   { name: 'Cactus Comidas para llevar', city: 'Buenos Aires' }
// ]

Tests

$ npm test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.