Spaces:
Sleeping
Sleeping
[](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 from an array. | |
**Example** | |
```js | |
> findReplace = require('find-replace') | |
> findReplace([ 1, 2, 3], 2, 'two') | |
[ 1, 'two', 3 ] | |
> findReplace([ 1, 2, 3], 2, [ 'two', 'zwei' ]) | |
[ 1, [ 'two', 'zwei' ], 3 ] | |
> findReplace([ 1, 2, 3], 2, 'two', 'zwei') | |
[ 1, 'two', 'zwei', 3 ] | |
> findReplace([ 1, 2, 3], 2) // no replacement, so remove | |
[ 1, 3 ] | |
``` | |
<a name="exp_module_find-replace--findReplace"></a> | |
### findReplace(array, valueTest, [...replaceWith]) ⇒ <code>array</code> ⏏ | |
**Kind**: Exported function | |
| Param | Type | Description | | |
| --- | --- | --- | | |
| array | <code>array</code> | the input array | | |
| valueTest | <code>valueTest</code> | a [test-value](https://github.com/75lb/test-value) query to match the value you're looking for | | |
| [...replaceWith] | <code>any</code> | If specified, found values will be replaced with these values, else removed. | | |
* * * | |
© 2015-18 Lloyd Brookes \<[email protected]\>. Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). | |