Array.prototype.every()
The every()
method tests whether
all elements in the array pass the test implemented by the provided function. It
returns a Boolean value.
Try it
Syntax
js
every(callbackFn)
every(callbackFn, thisArg)
Parameters
callbackFn
-
A function to execute for each element in the array. It should return a truthy value to indicate the element passes the test, and a falsy value otherwise. The function is called with the following arguments:
element
-
The current element being processed in the array.
index
-
The index of the current element being processed in the array.
array
-
The array
every()
was called upon.
thisArg
Optional-
A value to use as
this
when executingcallbackFn
. See iterative methods.
Return value
true
if callbackFn
returns a truthy value for every array element. Otherwise, false
.
Description
The every()
method is an iterative method. It calls a provided callbackFn
function once for each element in an array, until the callbackFn
returns a falsy value. If such an element is found, every()
immediately returns false
and stops iterating through the array. Otherwise, if callbackFn
returns a truthy value for all elements, every()
returns true
.
every
acts like the "for all" quantifier in mathematics. In particular, for an empty array, it returns true
. (It is vacuously true that all elements of the empty set satisfy any given condition.)
callbackFn
is invoked only for array indexes which have assigned values. It is not invoked for empty slots in sparse arrays.
every()
does not mutate the array on which it is called, but the function provided as callbackFn
can. Note, however, that the length of the array is saved before the first invocation of callbackFn
. Therefore:
callbackFn
will not visit any elements added beyond the array's initial length when the call toevery()
began.- Changes to already-visited indexes do not cause
callbackFn
to be invoked on them again. - If an existing, yet-unvisited element of the array is changed by
callbackFn
, its value passed to thecallbackFn
will be the value at the time that element gets visited. Deleted elements are not visited.
Warning: Concurrent modifications of the kind described above frequently lead to hard-to-understand code and are generally to be avoided (except in special cases).
The every()
method is generic. It only expects the this
value to have a length
property and integer-keyed properties.
Examples
Testing size of all array elements
The following example tests whether all elements in the array are bigger than 10.
js
function isBigEnough(element, index, array) {
return element >= 10;
}
[12, 5, 8, 130, 44].every(isBigEnough); // false
[12, 54, 18, 130, 44].every(isBigEnough); // true
Check if one array is a subset of another array
The following example tests if all the elements of an array are present in another array.
js
const isSubset = (array1, array2) =>
array2.every((element) => array1.includes(element));
console.log(isSubset([1, 2, 3, 4, 5, 6, 7], [5, 7, 6])); // true
console.log(isSubset([1, 2, 3, 4, 5, 6, 7], [5, 8, 7])); // false
Using every() on sparse arrays
every()
will not run its predicate on empty slots.
js
console.log([1, , 3].every((x) => x !== undefined)); // true
console.log([2, , 2].every((x) => x === 2)); // true
Affecting Initial Array (modifying, appending, and deleting)
The following examples tests the behavior of the every
method when the
array is modified.
js
// ---------------
// Modifying items
// ---------------
let arr = [1, 2, 3, 4];
arr.every((elem, index, arr) => {
arr[index + 1]--;
console.log(`[${arr}][${index}] -> ${elem}`);
return elem < 2;
});
// Loop runs for 3 iterations, but would
// have run 2 iterations without any modification
//
// 1st iteration: [1,1,3,4][0] -> 1
// 2nd iteration: [1,1,2,4][1] -> 1
// 3rd iteration: [1,1,2,3][2] -> 2
// ---------------
// Appending items
// ---------------
arr = [1, 2, 3];
arr.every((elem, index, arr) => {
arr.push("new");
console.log(`[${arr}][${index}] -> ${elem}`);
return elem < 4;
});
// Loop runs for 3 iterations, even after appending new items
//
// 1st iteration: [1, 2, 3, new][0] -> 1
// 2nd iteration: [1, 2, 3, new, new][1] -> 2
// 3rd iteration: [1, 2, 3, new, new, new][2] -> 3
// ---------------
// Deleting items
// ---------------
arr = [1, 2, 3, 4];
arr.every((elem, index, arr) => {
arr.pop();
console.log(`[${arr}][${index}] -> ${elem}`);
return elem < 4;
});
// Loop runs for 2 iterations only, as the remaining
// items are `pop()`ed off
//
// 1st iteration: [1,2,3][0] -> 1
// 2nd iteration: [1,2][1] -> 2
Calling every() on non-array objects
The every()
method reads the length
property of this
and then accesses each property with a nonnegative integer key less than length
until they all have been accessed or callbackFn
returns false
.
js
const arrayLike = {
length: 3,
0: "a",
1: "b",
2: "c",
3: 345, // ignored by every() since length is 3
};
console.log(
Array.prototype.every.call(arrayLike, (x) => typeof x === "string"),
); // true
Specifications
Specification |
---|
ECMAScript Language Specification # sec-array.prototype.every |
Browser compatibility
BCD tables only load in the browser