JavaScript Array method: filter()
[this page | pdf | back links]
The filter() method (when applied to a JavaScript
array) creates
a new array consisting only of elements that pass a specified test. Elements
that fail the test are removed.
It
has the following syntax with the following parameters. It returns an array
as above.
array.filter(function(currentValue,
index, arr), thisValue)
|
Parameter
|
Required / Optional
|
Description
|
|
function(currentValue,
index, arr)
|
Required
|
A function to be run
for each element
|
|
thisValue
|
Optional
|
A value to be passed to
the function to be used as its ‘this’ value (if empty then thisValue
will be undefined
|
The function
arguments are:
|
Parameter
|
Required / Optional
|
Description
|
|
currentValue
|
Required
|
The value of the
current element
|
|
Index
|
Optional
|
The array index of the
current element
|
|
arr
|
Optional
|
The array object which
the current element belongs to
|
NAVIGATION LINKS
Contents | Prev | Next | JavaScript Arrays