aboutsummaryrefslogtreecommitdiff
path: root/node_modules/find-index/README.md
blob: 034832e033db02e5f6070991357ad3a9135f87a4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

# find-index

finds an item in an array matching a predicate function,
and returns its index

fast both when `thisArg` is used and also when it isn't: [jsPerf](http://jsperf.com/array-prototype-findindex-shims)

### usage
```bash
npm install find-index
```
```js
findIndex = require('find-index')
findLastIndex = require('find-index/last')
```
    findIndex(array, callback[, thisArg])
    findLastIndex(array, callback[, thisArg])
    Parameters:
      array
        The array to operate on.
      callback
        Function to execute on each value in the array, taking three 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 findIndex was called upon.
      thisArg
        Object to use as this when executing callback.

based on [array-findindex](https://www.npmjs.org/package/array-findindex)