Array.prototype.findIndex()

Метод findIndex() (знайти індекс) повертає індекс першого елемента масиву, що задовольняє надану перевіркову функцію. Якщо жоден елемент не задовольняє перевіркову функцію, повертається -1.

Спробуйте його в дії

Дивіться також метод find(), котрий повертає перший елемент, що задовольняє перевіркову функцію (а не його індекс).

Синтаксис

// Стрілкова функція
findIndex((element) => { /* … */ } )
findIndex((element, index) => { /* … */ } )
findIndex((element, index, array) => { /* … */ } )

// Функція зворотного виклику
findIndex(callbackFn)
findIndex(callbackFn, thisArg)

// Вбудована функція зворотного виклику
findIndex(function(element) { /* … */ })
findIndex(function(element, index) { /* … */ })
findIndex(function(element, index, array){ /* … */ })
findIndex(function(element, index, array) { /* … */ }, thisArg)

Параметри

callbackFn (функція зворотного виклику)

Функція для виконання на кожному елементі масиву. Повинна повернути значення істинності, аби показати, що шуканий елемент знайдено.

Ця функція викликається з наступними аргументами:

element (елемент)

Елемент масиву, що наразі обробляється.

index (індекс)

Індекс елемента масиву, що наразі обробляється.

array (масив)

Масив, на котрому викликали findIndex().

thisArg (аргумент this) Необов'язкове

Значення для використання за this при виконанні callbackFn. Більше про це – в ітеративних методах.

Повернене значення

Індекс першого елемента масиву, що проходить перевірку. Інакше – -1.

Опис

findIndex() є ітеративним методом. Він викликає передану функцію callbackFn один раз для кожного елемента масиву, в порядку зростання індексів, поки callbackFn не поверне значення істинності. Тоді findIndex() повертає індекс цього елемента – і зупиняє ітерацію масиву. Якщо callbackFn взагалі не повертає значення істинності, то findIndex() повертає -1.

callbackFn закликається для кожного індексу в масиві, а не лише тих, що мають присвоєні значення. Порожні комірки в розріджених масивах поводяться так само як undefined.

findIndex() не змінює масиву, на якому викликаний, але функція, передана за callbackFn, може це робити. Проте зверніть увагу, що довжина масиву зберігається до першого заклику callbackFn. Таким чином:

• callbackFn не обробить жодних елементів, доданих поза початковою довжиною масиву, актуальною на початок виклику findIndex().
• Зміни за вже обробленими індексами не призведуть до повторного заклику на них callbackFn.
• Якщо наявний, іще не оброблений елемент масиву змінюється callbackFn, то його значення, передане в callbackFn, буде його значенням на ту мить, коли цей елемент обробляється. Видалені елементи обробляються так, ніби в них undefined.

Застереження: Паралельні зміни такого роду, як описано вище, часто призводять до важкого в розумінні коду, загалом їх слід уникати (окрім особливих випадків).

Метод findIndex() є узагальненим. Він лишень очікує, що значення this матиме властивість length, а також властивості з цілочисловими ключами.

Приклади

Пошук в масиві індексу простого числа

Наступний приклад повертає індекс першого елемента масиву, що є простим числом, або -1, якщо простого числа там немає.

function isPrime(element) {
  if (element % 2 === 0 || element < 2) {
    return false;
  }
  for (let factor = 3; factor <= Math.sqrt(element); factor += 2) {
    if (element % factor === 0) {
      return false;
    }
  }
  return true;
}

console.log([4, 6, 8, 9, 12].findIndex(isPrime)); // -1, не знайдено
console.log([4, 6, 7, 9, 12].findIndex(isPrime)); // 2 (array[2] – це 7)

Використання findIndex() на розріджених масивах

Можна шукати в розрідженому масиві undefined – і отримати індекс порожньої комірки.

console.log([1, , 3].findIndex((x) => x === undefined)); // 1

Виклик findIndex() на об'єктах-немасивах

Метод findIndex() зчитує з this властивість length, а потім звертається до кожної цілочислової властивості.

const arrayLike = {
  length: 3,
  0: 2,
  1: 7.3,
  2: 4,
};
console.log(
  Array.prototype.findIndex.call(arrayLike, (x) => !Number.isInteger(x))
); // 1

Специфікації

Сумісність із браузерами

Дивіться також

• Поліфіл Array.prototype.findIndex у core-js
• Array.prototype.find()
• Array.prototype.indexOf()