Array.prototype.includes()

Метод includes() визначає, чи список містить певний елемент, повертаючи відповідно true або false. 

Синтаксис

var boolean = array.includes(searchElement[, fromIndex])

Параметри

searchElement

Елемент, котрий шукається.

fromIndex Optional

Позиція у цьому списку, з якої починатиметься пошук елемента searchElement. Від'ємне значення шукатиме починаючи з array.length + fromIndex і далі у зворотньому порядку. Типово використовується значення 0.

Вертає

Boolean.

Приклади

[1, 2, 3].includes(2);      // true
[1, 2, 3].includes(4);      // false
[1, 2, 3].includes(3, 3);   // false
[1, 2, 3].includes(3, -1);  // true
[1, 2, NaN].includes(NaN);  // true

Якщо fromIndex >= array.length

Якщо fromIndex дорівнює або перевищує довжину масиву, пошук не здійснюється й завжди вертається false:

var arr = ['a', 'b', 'c'];

arr.includes('c', 3);    // вертає false
arr.includes('c', 100);  // вертає false

Якщо fromIndex < 0

Якщо значення fromIndex від'ємне, викорстовується обчислений індекс, що визначається відносно кінця масиву:

// Довжина масиву дорівнює 4
// fromIndex дорівнює -2
// Обчислений індекс дорівнює 4 - 2 = 2 (length - fromIndex)

var arr = ['a', 'b', 'c', 'd'];

arr.includes('b', -2);  // вертає false
arr.includes('c', -2);  // вертає true

Водночас, якщо обчислений індекс також менше нуля, пошук здійснюється по всьому масиву:

var arr = ['a', 'b', 'c'];

arr.includes('a', -100);  // вертає true
arr.includes('b', -100);  // вертає true
arr.includes('c', -100);  // вертає true

Узагальнене застосування метода includes()

Реалізація метода includes() є зумисне узагальненою. Об'єкт, на який вказує this, не обов'язково повинен належати до класу Array, тож використання includes() можна поширити на інші масивоподібні об'єкти. В наведеному нижче прикладі його застосовано до об'єкта arguments:

(function() {
  console.log([].includes.call(arguments, 'a'));  // виводить true
  console.log([].includes.call(arguments, 'd'));  // виводить false
})('a','b','c');

Запасний варіант (поліфіл)

// https://tc39.github.io/ecma262/#sec-array.prototype.includes
if (!Array.prototype.includes) {
  Object.defineProperty(Array.prototype, 'includes', {
    value: function(searchElement, fromIndex) {

      // 1. Let O be ? ToObject(this value).
      if (this == null) {
        throw new TypeError('"this" is null or not defined');
      }

      var o = Object(this);

      // 2. Let len be ? ToLength(? Get(O, "length")).
      var len = o.length >>> 0;

      // 3. If len is 0, return false.
      if (len === 0) {
        return false;
      }

      // 4. Let n be ? ToInteger(fromIndex).
      //    (If fromIndex is undefined, this step produces the value 0.)
      var n = fromIndex | 0;

      // 5. If n ≥ 0, then
      //  a. Let k be n.
      // 6. Else n < 0,
      //  a. Let k be len + n.
      //  b. If k < 0, let k be 0.
      var k = Math.max(n >= 0 ? n : len - Math.abs(n), 0);

      function sameValueZero(x, y) {
        return x === y || (typeof x === 'number' && typeof y === 'number' && isNaN(x) && isNaN(y));
      }

      // 7. Repeat, while k < len
      while (k < len) {
        // a. Let elementK be the result of ? Get(O, ! ToString(k)).
        // b. If SameValueZero(searchElement, elementK) is true, return true.
        // c. Increase k by 1. 
        if (sameValueZero(o[k], searchElement)) {
          return true;
        }
        k++;
      }

      // 8. Return false
      return false;
    }
  });
}

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

Підтримка веб-переглядачами

Див. також

• TypedArray.prototype.includes()
• String.prototype.includes()
• Array.prototype.indexOf()