The find()
method returns the first element in the provided array that satisfies the provided testing function. If no values satisfy the testing function, undefined
is returned.
The find()
method returns the first element in the provided array that satisfies the provided testing function. If no values satisfy the testing function, undefined
is returned.
findIndex()
.indexOf()
. (It's similar to findIndex()
, but checks each element for equality with the value instead of using a testing function.) includes()
. Again, it checks each element for equality with the value instead of using a testing function. some()
.// Arrow function find((element) => { /* … */ } ) find((element, index) => { /* … */ } ) find((element, index, array) => { /* … */ } ) // Callback function find(callbackFn) find(callbackFn, thisArg) // Inline callback function find(function(element) { /* … */ }) find(function(element, index) { /* … */ }) find(function(element, index, array){ /* … */ }) find(function(element, index, array) { /* … */ }, thisArg)
callbackFn
Function to execute on each value in the array.
The function is called with the following arguments:
element
The current element in the array.
index
The index (position) of the current element in the array.
array
The array that find
was called on.
The callback must return a truthy value to indicate a matching element has been found.
thisArg
Optional
Object to use as this
inside callbackFn
.
The first element in the array that satisfies the provided testing function. Otherwise, undefined
is returned.
The find
method executes the callbackFn
function once for each index of the array until the callbackFn
returns a truthy value. If so, find
immediately returns the value of that element. Otherwise, find
returns undefined
.
callbackFn
is invoked for every index of the array, not just those with assigned values. This means it may be less efficient for sparse arrays, compared to methods that only visit assigned values.
If a thisArg
parameter is provided to find
, it will be used as the this
value inside each invocation of the callbackFn
. If it is not provided, then undefined
is used.
The find
method does not mutate the array on which it is called, but the function provided to callbackFn
can. If so, the elements processed by find
are set before the first invocation of callbackFn
. Therefore:
callbackFn
will not visit any elements added to the array after the call to find
begins.callbackFn
.callbackFn
, its value passed to the callbackFn
will be the value at the time find
visits that element's index.deleted
are still visited.Warning: Concurrent modification of the kind described in the previous paragraph frequently leads to hard-to-understand code and is generally to be avoided (except in special cases).
const inventory = [ {name: 'apples', quantity: 2}, {name: 'bananas', quantity: 0}, {name: 'cherries', quantity: 5} ]; function isCherries(fruit) { return fruit.name === 'cherries'; } console.log(inventory.find(isCherries)); // { name: 'cherries', quantity: 5 }
const inventory = [ {name: 'apples', quantity: 2}, {name: 'bananas', quantity: 0}, {name: 'cherries', quantity: 5} ]; const result = inventory.find(({ name }) => name === 'cherries'); console.log(result) // { name: 'cherries', quantity: 5 }
The following example finds an element in the array that is a prime number (or returns undefined
if there is no prime number):
function isPrime(element, index, array) { let start = 2; while (start <= Math.sqrt(element)) { if (element % start++ < 1) { return false; } } return element > 1; } console.log([4, 6, 8, 12].find(isPrime)); // undefined, not found console.log([4, 5, 8, 12].find(isPrime)); // 5
The following examples show that nonexistent and deleted elements are visited, and that the value passed to the callback is their value when visited:
// Declare array with no elements at indexes 2, 3, and 4 const array = [0,1,,,,5,6]; // Shows all indexes, not just those with assigned values array.find((value, index) => { console.log('Visited index ', index, ' with value ', value); }); // Shows all indexes, including deleted array.find((value, index) => { // Delete element 5 on first iteration if (index === 0) { console.log('Deleting array[5] with value ', array[5]); delete array[5]; } // Element 5 is still visited even though deleted console.log('Visited index ', index, ' with value ', value); }); // expected output: // Visited index 0 with value 0 // Visited index 1 with value 1 // Visited index 2 with value undefined // Visited index 3 with value undefined // Visited index 4 with value undefined // Visited index 5 with value 5 // Visited index 6 with value 6 // Deleting array[5] with value 5 // Visited index 0 with value 0 // Visited index 1 with value 1 // Visited index 2 with value undefined // Visited index 3 with value undefined // Visited index 4 with value undefined // Visited index 5 with value undefined // Visited index 6 with value 6
Desktop | Mobile | Server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | Deno | Node.js | |
find |
45 |
12 |
25 |
No |
32 |
8 |
45 |
45 |
4 |
32 |
8 |
5.0 |
1.0 |
4.0.0
0.12.0
|
Array.prototype.find
in core-js
Array.prototype.findIndex()
– find and return an indexArray.prototype.includes()
– test whether a value exists in the arrayArray.prototype.filter()
– remove all non-matching elementsArray.prototype.every()
– test all elementsArray.prototype.some()
– test until one element matches
© 2005–2022 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find