Licence
MIT
Version
3.1.2
Deps
4
Size
248 kB
Vulns
0
Weekly
0
calculate-from-index-x
Calculates a fromIndex of a given value for an array.
module.exports(array, fromIndex) ⇒ number
This method calculates a fromIndex of a given value for an array.
Kind: Exported function
Returns: number - The calculated fromIndex. Default is 0.
Throws:
TypeErrorIf array is null or undefined.
| Param | Type | Description |
|---|---|---|
| array | array |
* The array on which to calculate the starting index. |
| fromIndex | number |
* The position in this array at which to begin. A negative value gives the index of array.length + fromIndex by asc. |
Example
import calcFromIndex from 'calculate-from-index-x';
console.log(calcFromIndex([1, 2, 3], 1)); // 1
console.log(calcFromIndex([1, 2, 3], Infinity)); // Infinity
console.log(calcFromIndex([1, 2, 3], -Infinity)); // 0
console.log(calcFromIndex([1, 2, 3], -1)); // 2