purge
Mutates an array by filtering out elements in-place.
Installation
Requires Node.js 6.0.0 or above.
npm i purge
API
The module exports a single function.
Parameters
- Bindable:
arr
(array): The array to modify. - Optional:
test
(function, array, or any): Specifies the elements to be removed. (Note that this behavior is opposite that ofArray.prototype.filter()
, which asks you to specify elements to keep.) If a function is provided, it will be called for each array element. Elements for which the function returns true will be removed. If a blacklist array is provided, elements contained in the blacklist array will be removed fromarr
. In other cases, elements inarr
which strictly equaltest
will be removed. Iftest
is omitted entirely, thenarr
will be purged of falsey elements.
Return Value
The mutated arr
.
Examples
Purge by Function Test
const purge = const isOdd = n % 2 === 1const arr = 1 2 3 // Purge odd numbersarr // [2]
Purge by Blacklist Array
const purge = const arr = 1 2 3 // Purge any of these elements if foundarr // [1, 2]
Purge Specific Element
const purge = const arr = 1 2 3 // Purge this element if foundarr // [2, 3]
Purge Falsey Elements
const purge = const arr = -1 0 1arr // [-1, 1]
Bind Operator
This module supports the bind operator. Any of the above examples can be rewritten to use it.
const purge = const isOdd = n % 2 === 1const arr = 1 2 3arr::arr // [2]
Related
- ltrim-array: Removes specified values from the beginning of an array.
- rtrim-array: Removes specified values from the end of an array.
- unique-array-by: Filters an array by testing uniqueness with a callback, an index, or a key.