help-array

TS package to help dealing with array

Install

$ npm install help-array

Import

This package is pure ESM. It cannot be require()'d from CommonJS.

Use import foo from 'foo' instead of const foo = require('foo') to import the package.

// Load entire build
import * as helpArray from 'help-array';

// Load by method
import {all} from 'help-array';

If the package is used in an async context, you could use await import(…) from CommonJS instead of require(…).

You also need to make sure you're on the latest minor version of Node.js. At minimum Node.js 12.20, 14.14, or 16.0.

Read more here: sindresorhus/esm-package

Usage

import {all} from 'help-array';

helpArray.all([1, 2, 3], (element) => typeof element === 'string');
//=> false

helpArray.all(['1', '2', '3'], (element) => typeof element === 'string');
//=> true

Functions

all : Returns true if the predicate function returns true for all elements in a collection and false otherwise.

allEqual : Checks whether all elements of the array are equal.

append : Append value into array.

prepend : Prepend value into array.

average : Returns the average of two or more numerical values.

cast : Converts a non-array value into array.

compact : Removes false values from an array.

countOccurrences : Counts the occurrences of a value in an array.

fromEntries : Returns an object composed from key-value pairs.

flatten : Flattens an array up to a specified depth using recursion.

deepFlatten : Flattens an array recursively.

groupMap : Group items by common key and return an map of items grouped by key.

group : Group items by common key and return an array of groups.

head : Gets the first element of array.

last : Gets the last element of array.

tail : Gets all but the first element of array.

remove : Remove an item of an array.

sample : Gets a random element from array.

shuffle : Randomly shuffle an array.

similarity : Return an array of elements that appear in two arrays.

slice : Creates a slice of array from start up to, but not including, end.

sortBy : Sort array by a category.

toChunks : Split an array into chunks.

toCSV : Converts the elements that don’t have commas or double quotes to strings with comma-separated values.

unDuplicate : Remove duplicate items from an array.

License

MIT © pnxdxt