@nbogie/useful-array-functions v0.2.0
A set of array utility functions. Only published as an exercise in npm package creation and maintenance.
Functions
Typedefs
collect(numElems, creatorCallback)
Create an array populated by the results of a given number of calls to a given creator function.
Kind: global function
| Param | Type | Description |
|---|---|---|
| numElems | number | number of elements to populate the array with. |
| creatorCallback | creatorCallback | a function to call |
repeat(numReps, callbackFn) ⇒ void
Repeatedly perform a given action, a given number of times, for its side effects. The callback's return values will be ignored (and should always be undefined)
Kind: global function
Returns: void - returns nothing. The return values from the actionCallback are ignored.
| Param | Type | Description |
|---|---|---|
| numReps | number | number of repetitions |
| callbackFn | actionCallback | will be called numReps times, and each time passed an argument from 0 to numReps-1 |
zip(inputArr1, inputArr2) ⇒ Array.<Pair>
Combine the elements of two given arrays into a single array of pairs. If the input arrays are not the same length, excess elements will be ignored.
Kind: global function
Returns: Array.<Pair> - array of tuples (2-element array)
| Param | Type |
|---|---|
| inputArr1 | Array.<any> |
| inputArr2 | Array.<any> |
zip~pair : Pair
Kind: inner constant of zip
creatorCallback ⇒ *
A creator function. Used to create something!
Kind: global typedef
Returns: * - - should return something, to be useful!
| Param | Type | Description |
|---|---|---|
| index | number | a numeric index to help the callback return different things per call, deterministically |
actionCallback ⇒ void
An action callback function - used for its side-effects.
Kind: global typedef
Returns: void - - should not return anything - will be ignored.
| Param | Type | Description |
|---|---|---|
| index | number | a numeric index to help the callback do different things per call, deterministically |
Pair : Array.<string>
Kind: global typedef
Done in 0.26s.