Array Utilities

Array utility functions provide a variety of methods for manipulating and transforming arrays. They help simplify common operations, such as splitting, flattening, shuffling, and finding differences between arrays, among others.

Installation

To install the array utility functions, use one of the following commands, depending on your package manager:

npm install @utilify/array

yarn add @utilify/array

pnpm add @utilify/array

Once installed, you can import the functions into your project, using either ESM or CJS.

Usage

This library supports both the ESM and CJS module systems.

import { shuffle } from '@utilify/array'; 

const { shuffle } = require('@utilify/array');  

Overview

Here’s an overview of the functions available in the array utility package:

after

function after(array: any[], n: number): any[]  

Returns the elements of the array after the index n.

before

function before(array: any[], n: number): any[]  

Returns the elements of the array before the index n.

chunk

function chunk(array: any[], size: number): any[][]  

Divides the array into smaller chunks of size size.

difference

function difference(array: any[], values: any[]): any[]  

Returns the elements of the array that are not present in the second array.

first

function first(array: any[], n?: number): any[]  

Returns the first n elements of the array.

flattenArr

function flattenArr(array: any[], depth?: number): any[]  

Flattens the array to the specified depth.

getRandom

function getRandom(array: any[]): any  

Returns a random element from the array.

isIterable

function isIterable(obj: any): boolean  

Checks if the object is iterable.

last

function last(array: any[], n?: number): any[]  

Returns the last n elements of the array.

rotate

function rotate(array: any[], n: number): any[]  

Rotates the elements of the array by n positions.

sanitizeArr

function sanitizeArr(array: any[], values: any[], replaceValue?: any): any[]  

Removes or replaces specified values in the array.

shuffle

function shuffle(array: any[]): any[]  

Shuffles the elements of the array.

swap

function swap(array: any[], index1: number, index2: number): any[]  

Swaps the elements at positions index1 and index2.

union

function union(...arrays: any[][]): any[]  

Returns the union of multiple arrays.

unique

function unique(array: any[]): any[]  

Returns an array with unique elements.