indexOf
arrays
Gets the index at which the first occurrence of value is found in array.
Installation
Import
import { indexOf } from '@tulx/utils';Source Code
Implementation
/**
* Gets the index at which the first occurrence of value is found in array.
*
* @param array - The array to inspect.
* @param value - The value to search for.
* @param fromIndex - The index to search from.
* @returns The index of the matched value, else -1.
*
* @example
* ```ts
* indexOf([1, 2, 1, 2], 2); // 1
* indexOf([1, 2, 1, 2], 2, 2); // 3
* ```
*/
export function indexOf<T>(
array: readonly T[],
value: T,
fromIndex: number = 0
): number {
const startIndex =
fromIndex < 0 ? Math.max(array.length + fromIndex, 0) : fromIndex;
for (let i = startIndex; i < array.length; i++) {
if (array[i] === value) {
return i;
}
}
return -1;
}
Example
import { indexOf } from '@tulx/utils';
indexOf([1, 2, 1, 2], 2); // 1
indexOf([1, 2, 1, 2], 2, 2); // 3Related Functions
chunk
Creates an array of elements split into groups the length of size. If array can't be split evenly, the final chunk will be the remaining elements.
compact
Creates an array with all falsy values removed. The values false, null, 0, "", undefined, and NaN are falsy.
concat
Creates a new array concatenating array with any additional arrays and/or values.
difference
Creates an array of array values not included in the other given arrays. The order and references of result values are determined by the first array.
differenceBy
This method is like difference except that it accepts iteratee which is invoked for each element of array and values to generate the criterion by which they're compared.
differenceWith
This method is like difference except that it accepts comparator which is invoked to compare elements of array to values.