Library that lets you filter an array and keep both pieces

Sven Slootweg ae9995707e 1.1.2 3 weeks ago
README.md 7b5bf2c415 Fix changelog formatting 3 weeks ago
example.js dd1e088dd5 Initial commit 4 weeks ago
index.js 78a78b44cb Also pass index into predicate 4 weeks ago
package.json ae9995707e 1.1.2 3 weeks ago

README.md

split-filter

Like Array#filter, but you get to keep both pieces. Quite literally. Splits the array by a predicate function.

If you want to split an array into more than two arrays, you'll want to use split-filter-n instead.

Example

"use strict";

const splitFilter = require("split-filter");

function isEven(number) {
	return Math.abs(number) % 2 === 0;
}

let numbers = [0, 1, 2, 3, 4, 5, 6, 7, 8];

let [ even, odd ] = splitFilter(numbers, (number) => isEven(number));

console.log(even); // [ 0, 2, 4, 6, 8 ]
console.log(odd); // [ 1, 3, 5, 7 ]

API

splitFilter(array, predicate)

Splits the array into a truthy and a falsy side, based on what the predicate function returns. Note that like Array#map, whether a value 'matches' depends on whether the returned value is truthy, not just a literal true.

  • array: The array to split.
  • predicate: The function that determines which side to sort the value into. This predicate function receives two arguments, of which you'll usually only need the first one:
    • value: The value itself.
    • index: The index of the value in the array you've provided.

Returns an array with two elements:

  • 0: The elements that matched the predicate function (ie. for which the predicate function returned a truthy value).
  • 1: The elements that did not match the predicate function (ie. returned a falsy value).

It's strongly recommended to use array destructuring in handling the returned array (like in the example), as this will greatly improve readability of your code.

Changelog

1.1.2 (August 26, 2019)

  • Fixed changelog formatting

1.1.1 (August 26, 2019)

  • Fixed incorrect require in documentation example.

1.1.0 (August 19, 2019)

  • New: Predicate function now also receives the index of the value as an argument, not just the value itself.

1.0.0 (August 19, 2019)

Initial release.