LendAndRegret/node_modules/es-toolkit/dist/compat/array/indexOf.d.ts
2026-05-02 17:27:43 +08:00

21 lines
848 B
TypeScript

/**
* Finds the index of the first occurrence of a value in an array.
*
* This method is similar to `Array.prototype.indexOf`, but it also finds `NaN` values.
* It uses strict equality (`===`) to compare elements.
*
* @template T - The type of elements in the array.
* @param {ArrayLike<T> | null | undefined} array - The array to search.
* @param {T} searchElement - The value to search for.
* @param {number} [fromIndex] - The index to start the search at.
* @returns {number} The index (zero-based) of the first occurrence of the value in the array, or `-1` if the value is not found.
*
* @example
* const array = [1, 2, 3, NaN];
* indexOf(array, 3); // => 2
* indexOf(array, NaN); // => 3
*/
declare function indexOf<T>(array: ArrayLike<T> | null | undefined, searchElement: T, fromIndex?: number): number;
export { indexOf };