44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
[](https://www.npmjs.org/package/find-replace)
|
|
[](https://www.npmjs.org/package/find-replace)
|
|
[](https://travis-ci.org/75lb/find-replace)
|
|
[](https://david-dm.org/75lb/find-replace)
|
|
[](https://github.com/feross/standard)
|
|
|
|
<a name="module_find-replace"></a>
|
|
|
|
## find-replace
|
|
Find and either replace or remove items in an array.
|
|
|
|
**Example**
|
|
```js
|
|
> 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 ]
|
|
```
|
|
<a name="exp_module_find-replace--findReplace"></a>
|
|
|
|
### findReplace(array, testFn, [...replaceWith]) ⇒ <code>array</code> ⏏
|
|
**Kind**: Exported function
|
|
|
|
| Param | Type | Description |
|
|
| --- | --- | --- |
|
|
| array | <code>array</code> | The input array |
|
|
| testFn | <code>testFn</code> | A predicate function which, if returning `true` causes the current item to be operated on. |
|
|
| [...replaceWith] | <code>any</code> | If specified, found values will be replaced with these values, else removed. |
|
|
|
|
|
|
* * *
|
|
|
|
© 2015-19 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
|