@jumpn/utils-array

Array utilities (immutability, fp helpers)

Stats

StarsIssuesVersionUpdatedCreatedSize
@jumpn/utils-array
000.3.44 years ago4 years agoMinified + gzip package size for @jumpn/utils-array in KB

Readme

@jumpn/utils-array

Array utilities (immutability, fp helpers)

NOTE: All the functions described in API are curried

Installation

Using npm

$ npm install --save @jumpn/utils-array

Using yarn

$ yarn add @jumpn/utils-array

API

append

Returns a new Array with elements appended to the one given.

Parameters

Returns Array<Element>

convertIfNot

Returns input if it is an Array or returns a new Array with input inside if it is not.

Parameters

  • input Input

Returns (Input | Array<Input>)

cycleNext

Returns 0 if current index is the last one, or returns next if it is not.

Parameters

Returns number

fromObject

Creates a new array using the given object If all of its entries are array keys.

(it could also have a property length with its size)

Parameters

Returns Array<any>

insert

Returns a new Array with the result of having inserted the given elements at the specified index.

Parameters

Returns Array<Element>

isKey

Returns true if the given string is an Array key or false otherwise.

Parameters

Returns boolean

isLastIndex

Returns true if given index is the last one or false otherwise.

Parameters

Returns boolean

isPossibleFromObject

Returns true if an Array can be created from the given Object, or in other words, if it has or not a length property, and the rest of its keys are Array ones.

Parameters

  • $0 any
    • $0.length
    • $0.rest ...any

Returns boolean

prepend

Returns a new Array with elements prepended to the one given.

Parameters

Returns Array<Element>

reduceIf

Reduce the given array applying reduce function only to elements filtered.

Parameters

Returns Result

reduceWhile

Reduce the given array applying reduce function while shouldProceed function returns true.

Parameters

Returns Result

remove

Returns a new Array with the result of having removed the specified amount (count) of elements at the given index.

Parameters

Returns Array<Element>

repeat

Returns a new Array with the given size (count) filled with the specified element.

Parameters

Returns Array<Element>

replace

Returns a new Array with the result of having replaced the elements at the given index with the ones specified.

Parameters

Returns Array<Element>

resolveIndex

Returns an absolute index from a relative one.

Relative indexes differ from absolute ones in that they can be negative and in those cases it would be as simple as substracting them from the length of the array from where they belong to obtain their absolute counterparts.

Parameters

Returns number

License

MIT :copyright: Jumpn Limited / Mauro Titimoli (mauro@jumpn.com)

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.