1.7 KiB
1.7 KiB
find-replace
Find and either replace or remove items in an array.
Example
> const findReplace = require('find-replace')
> const numbers = [ 1, 2, 3]
> findReplace(numbers, n => n === 2, 'two')
[ 1, 'two', 3 ]
> findReplace(numbers, n => n === 2, [ 'two', 'zwei' ])
[ 1, [ 'two', 'zwei' ], 3 ]
> findReplace(numbers, n => n === 2, 'two', 'zwei')
[ 1, 'two', 'zwei', 3 ]
> findReplace(numbers, n => n === 2) // no replacement, so remove
[ 1, 3 ]
findReplace(array, testFn, [...replaceWith]) ⇒ array ⏏
Kind: Exported function
| Param | Type | Description |
|---|---|---|
| array | array |
The input array |
| testFn | testFn |
A predicate function which, if returning true causes the current item to be operated on. |
| [...replaceWith] | any |
If specified, found values will be replaced with these values, else removed. |
© 2015-19 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.