JSPM

object-array-filter

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 10
  • Score
    100M100P100Q41074F
  • License ISC

Filters an array of objects by matching a field's value in each object to a search term. Returns filtered array

Package Exports

  • object-array-filter

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (object-array-filter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

object-array-filter

Explanation

Filters an array of objects by matching a field's value in each object to a search term. Returns filtered array. Field values must be strings, numbers or booleans.

Installation & Usage

Run npm install --save object-array-filter

const find = require('object-array-filter');

const testArray = [
  { color: "black", size: 2, big: false },
  { color: "pink", size: 3, big: false },
  { color: "black", size: 3, big: false },
  { color: "pink", size: 14, big: true}
];

const size = 3;
const color = 'black';

const big = true;

const filteredSize = find({size}, testArray);
const filteredColor = find({color}, testArray);
const filteredBig = find({big}, testArray);
console.log({ filteredSize, filteredColor, filteredBig });

/* expected output: {
  filteredSize: [
    { color: 'pink', size: 3, big: false },
    { color: 'black', size: 3, big: false }
  ],
  filteredColor: [
    { color: 'black', size: 2, big: false },
    { color: 'black', size: 3, big: false }
  ],
  filteredBig: [ { color: 'pink', size: 14, big: true } ]
} */

//NB: Variable name should match the name of the field in the object. If the variable name does not match the field name, the following syntax must be used

const color2 = 'pink'
const filteredPink = find({color2}, testArray, 'color');
console.log(filteredPink);

/* expected output: [ { color: 'pink', size: 3 }, { color: 'pink', size: 14 } ] */