lukeed

@arr/filter.mutate

Fastest Array.filter alternative --- mutates original array!

❗ Unlike native, @arr/filter.mutate mutates the original array! Use @arr/filter for a non-mutating version.

#Install

$ npm install --save @arr/filter.mutate

#Usage

import filter from '@arr/filter.mutate';

const words = ['spray', 'limit', 'elite', 'exuberant', 'destruction', 'present'];

filter(words, str => str.length > 6);
//=> ['exuberant', 'destruction', 'present']

console.log(words);
//=> ['exuberant', 'destruction', 'present']

#API

#filter(arr, callback)

#arr

Type: Array
The array to iterate upon.

#callback(value[, index, array])

Type: Function
Function to test for each element, taking three arguments:

  • value (required) -- The current element being processed in the array.
  • index (optional) -- The index of the current element being processed in the array.
  • array (optional) -- The array filter.mutate was called upon.

#License

MIT © Luke Edwards

See also

@arr/every(3), @arr/filter(3), @arr/find(3), @arr/findindex(3), @arr/flatten(3), @arr/foreach(3), @arr/foreach.spec(3), @arr/includes(3), @arr/indexof(3), @arr/lastindexof(3)