Description

The filter() method is used run a function on every item in the array and returns an array of all items for which the function returns true.

This method has the form:

Array.filter(callback[, thisObject])

Parameter	Description
callback	(required) Specifies the function to test for each element The callback is invoked with three arguments: 1. the value of the element, 2. the index of the element, and 3. the Array object being traversed
thisObject	(optional) Specifies the object to use as this when executing callback If a this parameter is specified, 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.

Note: The specified 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.

Examples

The following example shows the basic use of this method.

<script>
function needToReorder(element, index, array) {
  return (element < 5);
}

var reorderList = [2, 9, 3, 5, 8, 4].filter(needToReorder);
document.write("reorderList = " + reorderList);
</script>

This produces the following result:

Browser Support

Firefox	IE	Chrome	Opera	Safari

Version Information

This form was added in version: 1.6