Array.prototype.every()

  • Revision slug: JavaScript/Reference/Global_Objects/Array/every
  • Revision title: Array every method
  • Revision id: 1615
  • Created:
  • Creator: Sevenspade
  • Is current revision? No
  • Comment fix deki conversion mangling; no wording changes; page display name reset to default

Revision Content

Summary

Tests whether all elements in the array pass the test implemented by the provided function.

Method of Array
Implemented in: JavaScript 1.6 (Gecko 1.8b2 and later)
ECMAScript Edition: none

Syntax

var allPassed = array.every(callback[, thisObject]);

Parameters

callback
Function to test for each element.
thisObject
Object to use as this when executing callback.

Description

every executes the provided callback function once for each element present in the array until it finds one where callback returns a false value. If such an element is found, the every method immediately returns false. Otherwise, if callback returned a true value for all elements, every will return true. callback is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.

callback is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.

If a thisObject parameter is provided to every, it will be used as the this for each invocation of the callback. If it is not provided, or is null, the global object associated with callback is used instead.

every does not mutate the array on which it is called.

The range of elements processed by every is set before the first invocation of callback. Elements which are appended to the array after the call to every begins will not be visited by callback. If existing elements of the array are changed, their value as passed to callback will be the value at the time every visits them; elements that are deleted are not visited.

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.)

Compatibility

every is a JavaScript extension to the ECMA-262 standard; as such it may not be present in other implementations of the standard. You can work around this by inserting the following code at the beginning of your scripts, allowing use of every in ECMA-262 implementations which do not natively support it. This algorithm is exactly the one used in Firefox and SpiderMonkey.

if (!Array.prototype.every)
{
  Array.prototype.every = function(fun /*, thisp*/)
  {
    var len = this.length >>> 0;
    if (typeof fun != "function")
      throw new TypeError();

    var thisp = arguments[1];
    for (var i = 0; i < len; i++)
    {
      if (i in this &&
          !fun.call(thisp, this[i], i, this))
        return false;
    }

    return true;
  };
}

Examples

Example: Testing size of all array elements

The following example tests whether all elements in the array are bigger than 10.

function isBigEnough(element, index, array) {
  return (element >= 10);
}
var passed = [12, 5, 8, 130, 44].every(isBigEnough);
// passed is false
passed = [12, 54, 18, 130, 44].every(isBigEnough);
// passed is true

 

{{ languages( { "fr": "fr/R\u00e9f\u00e9rence_de_JavaScript_1.5_Core/Objets_globaux/Array/every", "ja": "ja/Core_JavaScript_1.5_Reference/Global_Objects/Array/every", "pl": "pl/Dokumentacja_j\u0119zyka_JavaScript_1.5/Obiekty/Array/every" } ) }}

Revision Source

<h2 name="Summary">Summary</h2>
<p>Tests whether all elements in the array pass the test implemented by the provided function.</p>
<table class="fullwidth-table" style="witdth: auto;"> <tbody> <tr> <td class="header" colspan="2">Method of <a href="/en/Core_JavaScript_1.5_Reference/Global_Objects/Array" title="en/Core_JavaScript_1.5_Reference/Global_Objects/Array">Array</a></td> </tr> <tr> <td>Implemented in:</td> <td>JavaScript 1.6 (Gecko 1.8b2 and later)</td> </tr> <tr> <td>ECMAScript Edition:</td> <td>none</td> </tr> </tbody>
</table>
<h2 name="Syntax">Syntax</h2>
<pre class="eval">var <em>allPassed</em> = <em>array</em>.every(<em>callback</em>[, <em>thisObject</em>]);
</pre>
<h2 name="Parameters">Parameters</h2>
<dl> <dt><code>callback</code></dt> <dd>Function to test for each element.</dd> <dt><code>thisObject</code></dt> <dd>Object to use as <code>this</code> when executing <code>callback</code>.</dd>
</dl>
<h2 name="Description">Description</h2>
<p><code>every</code> executes the provided <code>callback</code> function once for each element present in the array until it finds one where <code>callback</code> returns a false value. If such an element is found, the <code>every</code> method immediately returns <code>false</code>. Otherwise, if <code>callback</code> returned a true value for all elements, <code>every</code> will return <code>true</code>. <code>callback</code> is invoked only for indexes of the array which have assigned values; it is not invoked for indexes which have been deleted or which have never been assigned values.</p>
<p><code>callback</code> is invoked with three arguments: the value of the element, the index of the element, and the Array object being traversed.</p>
<p>If a <code>thisObject</code> parameter is provided to <code>every</code>, it will be used as the <code>this</code> for each invocation of the <code>callback</code>. If it is not provided, or is <code>null</code>, the global object associated with <code>callback</code> is used instead.</p>
<p><code>every</code> does not mutate the array on which it is called.</p>
<p>The range of elements processed by <code>every</code> is set before the first invocation of <code>callback</code>. Elements which are appended to the array after the call to <code>every</code> begins will not be visited by <code>callback</code>. If existing elements of the array are changed, their value as passed to <code>callback</code> will be the value at the time <code>every</code> visits them; elements that are deleted are not visited.</p>
<p><code>every</code> acts like the "for all" quantifier in mathematics. In particular, for an empty array, it returns true. (It is <a class="external" href="http://en.wikipedia.org/wiki/Vacuous_truth#Vacuous_truths_in_mathematics">vacuously true</a> that all elements of the <a class="external" href="http://en.wikipedia.org/wiki/Empty_set#Common_problems">empty set</a> satisfy any given condition.)</p>
<h2 name="Compatibility">Compatibility</h2>
<p><code>every</code> is a JavaScript extension to the ECMA-262 standard; as such it may not be present in other implementations of the standard. You can work around this by inserting the following code at the beginning of your scripts, allowing use of <code>every</code> in ECMA-262 implementations which do not natively support it. This algorithm is exactly the one used in Firefox and SpiderMonkey.</p>
<pre class="eval">if (!Array.prototype.every)
{
  Array.prototype.every = function(fun /*, thisp*/)
  {
    var len = this.length &gt;&gt;&gt; 0;
    if (typeof fun != "function")
      throw new TypeError();

    var thisp = arguments[1];
    for (var i = 0; i &lt; len; i++)
    {
      if (i in this &amp;&amp;
          !fun.call(thisp, this[i], i, this))
        return false;
    }

    return true;
  };
}
</pre>
<h2 name="Examples">Examples</h2>
<h3 name="Example:_Testing_size_of_all_array_elements">Example: Testing size of all array elements</h3>
<p>The following example tests whether all elements in the array are bigger than 10.</p>
<pre class="eval">function isBigEnough(element, index, array) {
  return (element &gt;= 10);
}
var passed = [12, 5, 8, 130, 44].every(isBigEnough);
// passed is false
passed = [12, 54, 18, 130, 44].every(isBigEnough);
// passed is true
</pre>
<p> </p>

<p>{{ languages( { "fr": "fr/R\u00e9f\u00e9rence_de_JavaScript_1.5_Core/Objets_globaux/Array/every", "ja": "ja/Core_JavaScript_1.5_Reference/Global_Objects/Array/every", "pl": "pl/Dokumentacja_j\u0119zyka_JavaScript_1.5/Obiekty/Array/every" } ) }}</p>
Revert to this revision