feat(immutable): add removeItems

Author: thetarnav

packages/immutable/README.md

@@ -56,7 +56,7 @@ setUser(p => update(p, "street", "number", 64));
 
 - **`push`** - non-mutating `Array.prototype.push()`
 - **`drop`** - non-mutating function that drops n items from the array start
-- **`dropRight`** - non-mutating function that drops n items from the array end
+- **`pop`** - non-mutating function that drops n items from the array end
 - **`filterOut`** - standalone `Array.prototype.filter()` that filters out passed item
 - **`filter`** - standalone `Array.prototype.filter()`
 - **`sort`** - non-mutating `Array.prototype.sort()` as a standalone function
@@ -66,6 +66,7 @@ setUser(p => update(p, "street", "number", 64));
 - **`fill`** - non-mutating `Array.prototype.fill()` as a standalone function
 - **`concat`** - Creates a new array concatenating array with any additional arrays and/or values.
 - **`remove`** - Remove item from array
+- **`removeItems`** - Remove multiple items from an array
 - **`flatten`** - Flattens a nested array into a one-level array
 - **`sortBy`** - Sort an array by object key, or multiple keys
 

packages/immutable/src/array.ts

@@ -31,14 +31,14 @@ export const drop = <T>(list: T[], n = 1): T[] => list.slice(n);
  *
  * @example
  * ```ts
- * const newList = dropRight([1,2,3])
+ * const newList = pop([1,2,3])
  * newList // => [1,2]
  *
- * const newList = dropRight([1,2,3], 2)
+ * const newList = pop([1,2,3], 2)
  * newList // => [1]
  * ```
  */
-export const dropRight = <T>(list: T[], n = 1): T[] => list.slice(0, list.length - n);
+export const pop = <T>(list: T[], n = 1): T[] => list.slice(0, list.length - n);
 
 /**
  * standalone `Array.prototype.filter()` that filters out passed item
@@ -62,7 +62,7 @@ export function filter<T>(list: readonly T[], predicate: Predicate<T>): T[] & {
  * @returns changed array copy
  */
 export const sort = <T>(list: T[], compareFn?: (a: T, b: T) => number): T[] =>
-  withArrayCopy(list, list => list.sort(compareFn));
+  list.slice().sort(compareFn);
 
 /**
  * standalone `Array.prototype.map()` function
@@ -84,14 +84,14 @@ export const splice = <T>(
   start: number,
   deleteCount: number = 0,
   ...items: T[]
-): T[] => withArrayCopy(list, list => list.splice(start, deleteCount, ...items));
+): T[] => list.slice().splice(start, deleteCount, ...items);
 
 /**
  * non-mutating `Array.prototype.fill()` as a standalone function
  * @returns changed array copy
  */
 export const fill = <T>(list: readonly T[], value: T, start?: number, end?: number): T[] =>
-  withArrayCopy(list, list => list.fill(value, start, end));
+  list.slice().fill(value, start, end);
 
 /**
  * Creates a new array concatenating array with any additional arrays and/or values.
@@ -117,6 +117,21 @@ export const remove = <T>(list: readonly T[], item: T): T[] => {
   return splice(list, index, 1);
 };
 
+/**
+ * Remove multiple items from an array
+ * @returns changed array copy
+ */
+export const removeItems = <T>(list: readonly T[], ...items: T[]): T[] => {
+  const res = [];
+  for (let i = 0; i < list.length; i++) {
+    const item = list[i];
+    const ii = items.indexOf(item);
+    if (ii !== -1) items.splice(ii, 1);
+    else res.push(item);
+  }
+  return res;
+};
+
 /**
  * Flattens a nested array into a one-level array
  * @returns changed array copy

packages/immutable/test/index.test.ts

@@ -1,4 +1,4 @@
-import { update, concat, split, get, sortBy, merge } from "../src";
+import { update, concat, split, get, sortBy, merge, removeItems } from "../src";
 import { suite } from "uvu";
 import * as assert from "uvu/assert";
 import { cloneDeep } from "lodash";
@@ -155,3 +155,12 @@ testMerge("merges", () => {
 });
 
 testMerge.run();
+
+const testRemoveItems = suite("removeItems");
+
+testRemoveItems("", () => {
+  const res = removeItems([1, 2, 3, 4, 5, 6, 7, 8, 9], 2, 6, 7, 11);
+  assert.equal(res, [1, 3, 4, 5, 8, 9]);
+});
+
+testRemoveItems.run();