aboutsummaryrefslogtreecommitdiff
path: root/node_modules/find-index/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/find-index/README.md')
-rw-r--r--node_modules/find-index/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/node_modules/find-index/README.md b/node_modules/find-index/README.md
new file mode 100644
index 000000000..034832e03
--- /dev/null
+++ b/node_modules/find-index/README.md
@@ -0,0 +1,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)