add missing tests; add enumerate

Author: vladkens

.vscode/settings.json

@@ -5,5 +5,9 @@
   "files.exclude": {
     "coverage": true,
     "yarn.lock": true
+  },
+  "code-runner.executorMap": {
+    "typescript": "node --loader tsm",
+    "javascript": "node"
   }
 }

package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "array-utils-ts",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "author": "Vlad Pronsky <[email protected]>",
   "repository": "vladkens/array-utils-ts",
   "description": "",
@@ -20,12 +20,12 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "c8": "^7.13.0",
-    "pkgroll": "^1.10.0",
-    "prettier": "^2.8.8",
-    "prettier-plugin-organize-imports": "^3.2.2",
+    "c8": "^8.0.1",
+    "pkgroll": "^2.0.1",
+    "prettier": "^3.1.0",
+    "prettier-plugin-organize-imports": "^3.2.4",
     "tsm": "^2.3.0",
-    "typescript": "^5.0.4",
+    "typescript": "^5.3.2",
     "uvu": "^0.5.6"
   },
   "types": "./dist/main.d.cts",

readme.md

@@ -87,18 +87,6 @@ toggleItem([1, 2, 3], 3)
 // -> [1, 2]
 ```
 
-### replaceItem
-
-```typescript
-import { replaceItem } from "array-utils-ts"
-
-toggleItem([1, 2, 3], 4)
-// -> [1, 2, 3, 4]
-
-toggleItem([1, 2, 3], 3)
-// -> [1, 2]
-```
-
 ### updateByKey
 
 ```typescript
@@ -142,40 +130,44 @@ import { toggleByKey } from "array-utils-ts"
 const arr1 = [{ id: 1, v: 1 }, { id: 2, v: 1 }]
 
 const arr2 = toggleByKey(arr1, "id", { id: 1, v: 2 })
-// -> [{ id: 2, v: 1 }]
-// arr1 !== arr2
+// -> [{ id: 2, v: 1 }]; arr1 !== arr2
 
 const arr3 = toggleByKey(arr2, "id", { id: 3, v: 1 })
-// -> [{ id: 2, v: 1 }, { id: 3, v: 1 }]
-// arr2 !== arr3
+// -> [{ id: 2, v: 1 }, { id: 3, v: 1 }]; arr2 !== arr3
 ```
 
 ### isFirstByKey
 
+Check if given object is first in collection by some key.
+
 ```typescript
 import { isFirstByKey } from "array-utils-ts"
 
-// prettier-ignore
-const arr = [{ id: 1, v: 1 }, { id: 2, v: 1 }]
-
-isFirstByKey(arr, "id", { id: 1, v: 2 })
-// -> true
-
-isFirstByKey(arr, "id", { id: 2, v: 1 })
-// -> false
+const arr = [{ id: 1 }, { id: 2 }, { id: 3 }]
+isFirstByKey(arr, "id", { id: 1 }) // -> true
+isFirstByKey(arr, "id", { id: 2 }) // -> false
+isFirstByKey(arr, "id", { id: 3 }) // -> false
 ```
 
 ### isLastByKey
 
+Check if given object is last in collection by some key.
+
 ```typescript
 import { isLastByKey } from "array-utils-ts"
 
-// prettier-ignore
-const arr = [{ id: 1, v: 1 }, { id: 2, v: 1 }]
+const arr = [{ id: 1 }, { id: 2 }, { id: 3 }]
+isLastByKey(arr, "id", { id: 1 }) // -> false
+isLastByKey(arr, "id", { id: 2 }) // -> false
+isLastByKey(arr, "id", { id: 3 }) // -> true
+```
 
-isLastByKey(arr, "id", { id: 1, v: 1 })
-// -> false
+### enumerate
 
-isLastByKey(arr, "id", { id: 2, v: 1 })
-// -> true
+```typescript
+import { enumerate } from "array-utils-ts"
+
+const arr = ["a", "b", "c"]
+enumerate(arr) // -> [[0, "a"], [1, "b"], [2, "c"]]
+enumerate(arr, 1) // -> [[1, "a"], [2, "b"], [3, "c"]]
 ```

src/main.test.ts

@@ -1,6 +1,18 @@
 import { test } from "uvu"
-import { equal } from "uvu/assert"
-import { filterEmpty, filterNullable, hasEmpty, isUniq } from "./main"
+import { equal, not } from "uvu/assert"
+import {
+  enumerate,
+  filterEmpty,
+  filterNullable,
+  hasEmpty,
+  isFirstByKey,
+  isLastByKey,
+  isUniq,
+  toggleByKey,
+  toggleItem,
+  updateByKey,
+  upsertByKey,
+} from "./main"
 
 test("filterNullable", () => {
   equal(filterNullable([1, 2, 3]), [1, 2, 3])
@@ -70,4 +82,101 @@ test("hasEmpty", () => {
   equal(hasEmpty(["a", "b", undefined]), true)
 })
 
+test("toggleItem", () => {
+  const arr1 = [1, 2, 3]
+
+  const arr2 = toggleItem(arr1, 4)
+  equal(arr2.length, 4)
+  equal(arr2, [1, 2, 3, 4])
+  not.equal(arr2, arr1)
+
+  const arr3 = toggleItem(arr1, 3)
+  equal(arr3.length, 2)
+  equal(arr3, [1, 2])
+  not.equal(arr3, arr1)
+
+  const arrobj1 = [{ id: 1 }, { id: 2 }, { id: 3 }]
+
+  // new ref so always add
+  const arrobj2 = toggleItem(arrobj1, { id: 1 })
+  equal(arrobj2.length, 4)
+  // prettier-ignore
+  equal(arrobj2.map(x => x.id), [1, 2, 3, 1])
+
+  // existing ref so remove
+  const arrobj3 = toggleItem(arrobj2, arrobj2[0])
+  equal(arrobj3.length, 3)
+  // prettier-ignore
+  equal(arrobj3.map(x => x.id), [2, 3, 1])
+})
+
+test("updateByKey", () => {
+  // prettier-ignore
+  const arr1 = [{ id: 1, v: 1 }, { id: 2, v: 1 }]
+
+  const arr2 = updateByKey(arr1, "id", { id: 1, v: 2 })
+  equal(arr2.length, 2)
+  // prettier-ignore
+  equal(arr2, [{ id: 1, v: 2 }, { id: 2, v: 1 }])
+  not.equal(arr2, arr1)
+
+  const arr3 = updateByKey(arr2, "id", { id: 3, v: 1 })
+  equal(arr3.length, 2)
+  // prettier-ignore
+  equal(arr3, [{ id: 1, v: 2 }, { id: 2, v: 1 }])
+  equal(arr2, arr3)
+})
+
+test("upsertByKey", () => {
+  // prettier-ignore
+  const arr1 = [{ id: 1, v: 1 }, { id: 2, v: 1 }]
+
+  const arr2 = upsertByKey(arr1, "id", { id: 1, v: 2 })
+  equal(arr2.length, 2)
+  // prettier-ignore
+  equal(arr2, [{ id: 1, v: 2 }, { id: 2, v: 1 }])
+  not.equal(arr2, arr1)
+
+  const arr3 = upsertByKey(arr2, "id", { id: 3, v: 1 })
+  equal(arr3.length, 3)
+  // prettier-ignore
+  equal(arr3, [{ id: 1, v: 2 }, { id: 2, v: 1 }, { id: 3, v: 1 }])
+  not.equal(arr3, arr2)
+})
+
+test("toggleByKey", () => {
+  const arr1 = [{ id: 1 }, { id: 2 }, { id: 3 }]
+
+  const arr2 = toggleByKey(arr1, "id", { id: 1 })
+  equal(arr2.length, 2)
+  equal(arr2, [{ id: 2 }, { id: 3 }])
+  not.equal(arr2, arr1)
+
+  const arr3 = toggleByKey(arr2, "id", { id: 1 })
+  equal(arr3.length, 3)
+  equal(arr3, [{ id: 2 }, { id: 3 }, { id: 1 }])
+  not.equal(arr3, arr2)
+})
+
+test("isFirstByKey", () => {
+  const arr = [{ id: 1 }, { id: 2 }, { id: 3 }]
+  equal(isFirstByKey(arr, "id", { id: 1 }), true)
+  equal(isFirstByKey(arr, "id", { id: 2 }), false)
+  equal(isFirstByKey(arr, "id", { id: 3 }), false)
+})
+
+test("isLastByKey", () => {
+  const arr = [{ id: 1 }, { id: 2 }, { id: 3 }]
+  equal(isLastByKey(arr, "id", { id: 1 }), false)
+  equal(isLastByKey(arr, "id", { id: 2 }), false)
+  equal(isLastByKey(arr, "id", { id: 3 }), true)
+})
+
+test("enumerate", () => {
+  // prettier-ignore
+  equal(enumerate(["a", "b", "c"]), [[0, "a"], [1, "b"], [2, "c"]])
+  // prettier-ignore
+  equal(enumerate(["a", "b", "c"], 1), [[1, "a"], [2, "b"], [3, "c"]])
+})
+
 test.run()

src/main.ts

@@ -52,3 +52,7 @@ export const isFirstByKey = <T extends Dict>(arr: T[], key: keyof T, obj: T): bo
 export const isLastByKey = <T extends Dict>(arr: T[], key: keyof T, obj: T): boolean => {
   return arr.findIndex((x) => x[key] === obj[key]) === arr.length - 1
 }
+
+export const enumerate = <T>(arr: T[], start = 0): [number, T][] => {
+  return arr.map((x, i) => [i + start, x])
+}