object-array-filter

Explanation

Filters an array of objects by compariing a field's value in each object to a search term. The following operators can be used: "eq" | "ne" | "lt" | "gt" | "lte" | "gte". Returns a promise of a filtered array. Field values must be strings, numbers or booleans.

Installation & Usage

Run npm install --save object-array-filter

1const find = require('object-array-filter');
2
3/**
4 * @param search object
5 * @param array an array of object with the same properties
6 * @param key <optional> object key to perform comparison.
7 * @param comparison <optional> comparison operator to use.
8 * @returns {Promise<object[] | []>} Returns filtered array
9 */
10
11
12
13const testArray = [
14  { color: "black", size: 2, big: false },
15  { color: "pink", size: 3, big: false },
16  { color: "black", size: 3, big: false },
17  { color: "pink", size: 14, big: true}
18];
19
20const size = 3;
21const color = 'black';
22const big = true;
23
24const testing = async () => {
25  try {
26    const filteredSize = await find.default({ size }, testArray);
27    const filteredColor = await find.default({ color }, testArray);
28    const filteredNotBig = await find.default({ big }, testArray);
29    console.log({ filteredSize, filteredColor, filteredBig });
30  } catch (error) {
31    console.log(error);
32  }
33};
34
35//Run function
36testing();
37
38/* expected output: {
39  filteredSize: [
40    { color: 'pink', size: 3, big: false },
41    { color: 'black', size: 3, big: false }
42  ],
43  filteredColor: [
44    { color: 'black', size: 2, big: false },
45    { color: 'black', size: 3, big: false }
46  ],
47  filteredBig: [ { color: 'pink', size: 14, big: true } ]
48} */
49
50/* 
51NB: Variable name should match the name of the field in the object. 
52If the variable name does not match the field name, the following syntax must be used
53 */
54const color2 = 'pink'
55find.default({ color2 }, testArray, "color")
56  .then((filtered) => console.log(filtered))
57  .catch((error) => console.log(error));
58
59/* expected output: [ { color: 'pink', size: 3 }, { color: 'pink', size: 14 } ] */
60
61//NB: The default operator is 'eq'. If you wish to use another operator, below are some examples.
62const testingOperators = async () => {
63  try {
64    const filteredLessThanOrEqual3 = await find.default({ size }, testArray, "size", "lte");
65    const filteredGreaterThan3 = await find.default({ size }, testArray, "size", "gt");
66    const filteredNotBlack = await find.default({ color }, testArray, "color", "ne");
67    const filteredNotBig = await find.default({ big }, testArray, "big", "ne");
68    console.log({ filteredLessThanOrEqual3, filteredGreaterThan3, filteredNotBlack, filteredNotBig });
69  } catch (error) {
70    console.log(error);
71  }
72};
73
74testingOperators();
75
76/* expected output: {
77  filteredLessThanOrEqual3: [
78    { color: 'black', size: 2, big: false },
79    { color: 'pink', size: 3, big: false },
80    { color: 'black', size: 3, big: false }
81  ],
82  filteredGreaterThan3: [ { color: 'pink', size: 14, big: true } ],
83  filteredNotBlack: [
84    { color: 'pink', size: 3, big: false },
85    { color: 'pink', size: 14, big: true }
86  ],
87  filteredNotBig: [
88    { color: 'black', size: 2, big: false },
89    { color: 'pink', size: 3, big: false },
90    { color: 'black', size: 3, big: false }
91  ]
92} */
93

TypeScript Usage

1import find from 'object-array-filter';
2
3/**
4 * @param search object
5 * @param array an array of object with the same properties
6 * @param key <optional> object key to perform comparison.
7 * @param comparison <optional> comparison operator to use.
8 * @returns {Promise<object[] | []>} Returns filtered array
9 */
10
11
12
13const testArray = [
14  { color: "black", size: 2, big: false },
15  { color: "pink", size: 3, big: false },
16  { color: "black", size: 3, big: false },
17  { color: "pink", size: 14, big: true}
18];
19
20const size = 3;
21const color = 'black';
22const big = true;
23
24const testing = async () => {
25  try {
26    const filteredSize = await find({ size }, testArray);
27    const filteredColor = await find({ color }, testArray);
28    const filteredNotBig = await find({ big }, testArray);
29    console.log({ filteredSize, filteredColor, filteredBig });
30  } catch (error) {
31    console.log(error);
32  }
33};
34
35//Run function
36testing();
37
38/* expected output: {
39  filteredSize: [
40    { color: 'pink', size: 3, big: false },
41    { color: 'black', size: 3, big: false }
42  ],
43  filteredColor: [
44    { color: 'black', size: 2, big: false },
45    { color: 'black', size: 3, big: false }
46  ],
47  filteredBig: [ { color: 'pink', size: 14, big: true } ]
48} */
49