Array.prototype.includes() 方法用于判断数组是否包含指定的值。
该方法为 ECMAScript 2015 新添加的数组方法。
arr.includes( searchValue [, fromIndex])
| 参数 | 说明 | 类型 |
|---|---|---|
searchValue | 需要查找的元素值 | any |
fromIndex | 查找数组开始的索引 | number |
返回值: 如果存在指定值则返回 true,否则返回 false。
let foo = [1, 2, 3];foo.includes(2);// truefoo.includes(4);// falsefoo.includes(3, 3);// falsefoo.includes(3, -1);// truelet bar = [1, 2, NaN];bar.includes(NaN);// true
Array.prototype.indexOf() 无法查找出数组中的 NaN,而该方法可以判断出数组中是否包含 NaN。
const a = [1, 2, 3, 4, NaN, 6, NaN];a.includes(NaN); // true
如果 fromIndex 大于等于数组长度 ,则返回 false 。该数组不会被搜索。
var arr = ['a', 'b', 'c'];arr.includes('c', 3); // falsearr.includes('c', 100); // false
如果 fromIndex 为负值,计算出的索引将作为开始搜索 searchValue 的位置。如果计算出的索引小于 0,则整个数组都会被搜索。
// 数组长度是3// fromIndex是-100// computed index 是 3 + (-100) = -97var arr = ['a', 'b', 'c'];arr.includes('a', -100);// truearr.includes('b', -100);// truearr.includes('c', -100);// true
includes() 方法有意设计为通用方法。它不要求 this 值是数组对象,所以它可以被用于其他类型的对象(比如类数组对象)。下面的例子展示了 在函数的 arguments 对象上调用的 includes() 方法。
(function () {console.log([].includes.call(arguments, 'a'));// trueconsole.log([].includes.call(arguments, 'd'));// false})('a', 'b', 'c');