Array Utilities

Utilities for working with arrays, including grouping, filtering, removing duplicates, and other operations.

Array Methods

groupBy

Groups array elements by a specified key.

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const users = [
  { name: "Alice", department: "Engineering" },
  { name: "Bob", department: "Engineering" },
  { name: "Charlie", department: "Marketing" }
];

const grouped = users.groupBy("department");
// Result:
// [
//   { key: "Engineering", items: [
//     { name: "Alice", department: "Engineering" },
//     { name: "Bob", department: "Engineering" }
//   ]},
//   { key: "Marketing", items: [
//     { name: "Charlie", department: "Marketing" }
//   ]}
// ]

trimNotDefinedValuesBy

Removes boundary elements containing null or undefined values in the specified key.

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [
  { id: null, name: "first" },
  { id: undefined, name: "second" },
  { id: 1, name: "third" },
  { id: 2, name: "fourth" },
  { id: null, name: "fifth" }
];

const result = arr.trimNotDefinedValuesBy(item => item.id);
// Result: [{ id: 1, name: "third" }, { id: 2, name: "fourth" }, { id: null, name: "fifth" }]

chunk

Splits an array into chunks of a specified size.

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [1, 2, 3, 4, 5, 6, 7];
const chunks = arr.chunk(3);
// Result: [[1, 2, 3], [4, 5, 6], [7]]

remove

Removes the specified element from the array (mutates the array).

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [1, 2, 3, 2, 4];
arr.remove(2);
// arr is now [1, 3, 2, 4] (only first occurrence removed)

removeByFn

Removes elements from the array by a specified predicate function (mutates the array).

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [1, 2, 3, 4, 5];
arr.removeByFn(item => item % 2 === 0);
// arr is now [1, 3, 5]

removeByKey

Removes elements whose keys are not present in the array of allowed keys (mutates the array).

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [
  { id: 1, name: "Alice" },
  { id: 2, name: "Bob" },
  { id: 3, name: "Charlie" },
  { id: 4, name: "David" }
];

arr.removeByKey([1, 3], "id");
// arr is now [{ id: 1, name: "Alice" }, { id: 3, name: "Charlie" }]

removeDuplicate

Removes duplicates from the current array (mutates the array).

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [1, 2, 2, 3, 3, 4];
arr.removeDuplicate();
// arr is now [1, 2, 3, 4]

removeDuplicateBy

Removes duplicates from the current array by a specified key selector (mutates the array).

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [
  { id: 1, name: "Alice" },
  { id: 2, name: "Bob" },
  { id: 1, name: "Alice Copy" },
  { id: 3, name: "Charlie" }
];

arr.removeDuplicateBy(item => item.id);
// arr is now [{ id: 1, name: "Alice" }, { id: 2, name: "Bob" }, { id: 3, name: "Charlie" }]

withoutEmpty

Removes empty values ([null, undefined] & [""] depending on the removeEmptyString flag).

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr1 = [1, undefined, 2, 3, "some", "", null, "undefined", "text"];
const result1 = arr1.withoutEmpty();
// result1 is [1, 2, 3, "some", "", "undefined", "text"]

const result2 = arr1.withoutEmpty(true);
// result2 is [1, 2, 3, "some", "undefined", "text"]

const arr2 = [{ id: 1, name: "Alice" }, { id: null, name: "" }, { id: 3, name: "Charlie" }];
const result3 = arr2.withoutEmpty(false, item => item.id);
// result3 is [{ id: 1, name: "Alice" }, { id: 3, name: "Charlie" }]

withoutDuplicate

Creates a new array from the current one without duplicate values.

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [1, 2, 2, 3, 3, 4];
const result = arr.withoutDuplicate();
// result is [1, 2, 3, 4]
// arr is still [1, 2, 2, 3, 3, 4]

withoutDuplicateBy

Creates a new array from the current one without duplicate values by a specified key selector.

import "@bodynarf/utils/array"; // Must be imported to extend the prototype

const arr = [
  { id: 1, name: "Alice" },
  { id: 2, name: "Bob" },
  { id: 1, name: "Alice Copy" },
  { id: 3, name: "Charlie" }
];

const result = arr.withoutDuplicateBy(item => item.id);
// result is [{ id: 1, name: "Alice" }, { id: 2, name: "Bob" }, { id: 3, name: "Charlie" }]
// arr is still the original array