Array.prototype.includes()

この記事は翻訳作業中です。

includes() メソッドは、特定の要素が配列に含まれているかどうかを true または false で返します。

構文

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

引数

searchElement
検索対象の要素
fromIndex(オプション)
任意。searchElement の配列の検索を開始する位置。負の値であれば、配列の末尾から検索します。既定値は 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 が配列の長さと同じか大きい場合

fromIndex が配列の長さと同じか大きい場合は配列を検索せずに false を返します。

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

arr.includes('c', 3);   //false
arr.includes('c', 100); // false

補正されたインデックスが0より小さい場合

fromIndex が負の値である場合、配列中の searchElement を検索する起点として補正されたインデックスを算出します。補正されたインデックスが0より小さい場合は配列のすべてを検索します。

// 配列の長さは 3
// fromIndex は -100
// 補正されたインデックスは 3 + (-100) = -97

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

arr.includes('a', -100); // true
arr.includes('b', -100); // true
arr.includes('c', -100); // true

includes() used as a generic method

includes() は意図的に一般化されています。元の値が配列である必要がないため、他の種類の(配列のような)オブジェクトにも適用することができます。以下は 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);

      // 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.
        // NOTE: === provides the correct "SameValueZero" comparison needed here.
        if (o[k] === searchElement) {
          return true;
        }
        k++;
      }

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

もし Object.defineProperty をサポートしないような本当に古いJavaScriptエンジンをサポートしなければならない場合は、non-enumerable化することができないため、Array.prototype メソッドをポリフィルしないほうが良いでしょう。

仕様

仕様書 策定状況 コメント
ECMAScript Latest Draft (ECMA-262)
Array.prototype.includes の定義
現行の標準 ECMAScript 2016 で最初に定義


ブラウザ実装状況

機能 Chrome Firefox (Gecko) Internet Explorer Edge Opera Safari
基本サポート 47 43 未サポート 13 34 9
機能 Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
基本サポート 未サポート 47 43 未サポート 34 9 47

関連情報

ドキュメントのタグと貢献者

 このページの貢献者: kdex, htsign, obaratch, isdh, yyss, Marsf, shide55
 最終更新者: kdex,