Array utilities (immutability, fp helpers)
npm install @jumpn/utils-array> Array utilities (immutability, fp helpers)
>
> NOTE: All the functions described in API are curried
- Installation
- Using npm
- Using yarn
- API
- append
- convertIfNot
- cycleNext
- fromObject
- insert
- isKey
- isLastIndex
- isPossibleFromObject
- prepend
- reduceIf
- reduceWhile
- remove
- repeat
- replace
- resolveIndex
- License
$ npm install --save @jumpn/utils-array
$ yarn add @jumpn/utils-array
Returns a new Array with elements appended to the one given.
Parameters
- elements Array<Element>
- array Array<Element>
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>)
Returns 0 if current index is the last one, or returns next if it is not.
Parameters
- array Array<any>
- currentIndex number
Returns number
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
- object Object
Returns Array<any>
Returns a new Array with the result of having inserted the given elements at
the specified index.
Parameters
- index number
- elements Array<Element>
- array Array<Element>
Returns true if the given string is an Array key or false otherwise.
Parameters
- string string
Returns boolean
Returns true if given index is the last one or false otherwise.
Parameters
- array Array<any>
- index number
Returns boolean
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
Returns a new Array with elements prepended to the one given.
Parameters
- elements Array<Element>
- array Array<Element>
Reduce the given array applying reduce function only to elements filtered.
Parameters
- filter Filter<Element, Result>
- reduce Reduce<Element, Result>
- resultInitial $Subtype<Result>
- array Array<$Subtype<Element>>
Returns Result
Reduce the given array applying reduce function while shouldProceed function
returns true.
Parameters
- shouldProceed ShouldProceed<Element, Result>
- reduce Reduce<Element, Result>
- resultInitial Result
- array Array<Element>
Returns Result
Returns a new Array with the result of having removed the specified amount
(count) of elements at the given index.
Parameters
- index number
- count number
- array Array<Element>
Returns a new Array with the given size (count) filled with the specified
element.
Parameters
- count number
- element Element
Returns a new Array with the result of having replaced the elements at the
given index with the ones specified.
Parameters
- index number
- elements Array<Element>
- array Array<Element>
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
- array Array<any>
- relativeIndex number
Returns number
MIT :copyright: Jumpn Limited / Mauro Titimoli (mauro@jumpn.com)