Array Utility Functions

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

Install

To install and use the array utility functions, follow these steps:

npm install array-utils

Alternatively, you can use yarn:

yarn add array-utils

After installation, you can import the functions into your project in two ways:

Namespace Import

You can import the entire module as a namespace, which will bundle all functions under a single object:

import * as ArrayUtils from 'array-utils';

Then you can access the functions like this:

ArrayUtils.after(array, 2);
ArrayUtils.shuffle(array);
ArrayUtils.union(array1, array2);

Named Imports

Alternatively, you can import specific functions by name:

import { after, before, chunk, difference, first, flattenArr, getRandom, isIterable, last, rotate, sanitizeArr, shuffle, swap, union, unique } from 'array-utils';

Both methods work, so you can choose the one that best fits your project structure. The namespace import is helpful when you want to avoid name conflicts or prefer grouping all utility functions under one object.

Overview

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

after

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

Returns the elements of the array after index n.

before

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

Returns the elements of the array before index n.

chunk

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

Splits 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 n positions.

sanitizeArr

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

Removes or replaces the 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.