calculate-from-index-x

calculate-from-index-x

Calculates a fromIndex of a given value for an array.

Version: 2.2.0
Author: Xotic750 [e-mail]
License: MIT
Copyright: Xotic750

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:

• TypeError If 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

var calcFromIndex = require('calculate-from-index-x');

calcFromIndex([1, 2, 3], 1); // 1
calcFromIndex([1, 2, 3], Infinity); // Infinity
calcFromIndex([1, 2, 3], -Infinity); // 0
calcFromIndex([1, 2, 3], -1); // 2