Array to record (#76)

* arrayToRecord function added

* arrayToRecord tests

* Removing unneeded import

* Prettier

* arrayToRecord renamed by keyArrayBy

* Exposing keyArrayBy

* Adding doc

* Sonar fix

* groupBy improved

* groupByUnique method

* Removing keyArrayBy

* exposing groupByUnique

* Test fixes

* Controlling type error

* Doc

* Throwing error in case of duplicated value

* Adding doc for groupBy and groupByUnique

* Tests fix

docs/array-utils.md

@@ -33,4 +33,4 @@ Return a copy of the given array without falsy values (eg: false, 0, '', null, u
 ```typescript
 const array = ['', false, null, 'valid', 1, undefined, 0]
 console.log(removeFalsy(array)) // result: ['valid', 1]
-```
+```

docs/object-utils.md

@@ -24,6 +24,10 @@ Returns an object which contains fields specified in `propNames` with the same v
 
 Returns true if `params` has no own properties or only own properties with value `undefined`, false otherwise.
 
-`groupBy<T>(inputArray: T[], propName: string): Record<string, T[]>`
+`export function groupBy<T extends { [K in keyof T]: string | number | symbol | null | undefined }, K extends keyof T>(array: T[], selector: K): Record<string | number | symbol, T[]>`
 
-Returns an object composed of keys generated from the values of `propName` field for the `inputArray` elements. The order of grouped values is determined by the order they occur in collection.
+The `groupBy` function takes an array of objects and a `selector`, groups the objects based on selected key and returns an object with unique keys from the selector and corresponding groups as arrays.
+
+`export function groupByUnique<T extends { [K in keyof T]: string | number | symbol | null | undefined }, K extends keyof T>(array: T[], selector: K): Record<string | number | symbol, T>`
+
+Similar to `groupBy`, but the value is a single element, in case of duplicated values for the same selector the method will throw a `InternalError`

index.ts

@@ -38,6 +38,7 @@ export type { Either } from './src/errors/either'
 export { chunk, callChunked, removeFalsy, removeNullish } from './src/utils/arrayUtils'
 export {
   groupBy,
+  groupByUnique,
   pick,
   pickWithoutUndefined,
   copyWithoutUndefined,

src/utils/__snapshots__/objectUtils.spec.ts.snap

@@ -31,23 +31,19 @@ exports[`groupBy > Correctly groups by string values 1`] = `
 {
   "a": [
     {
-      "id": 1,
       "name": "a",
     },
     {
-      "id": 4,
       "name": "a",
     },
   ],
   "b": [
     {
-      "id": 3,
       "name": "b",
     },
   ],
   "c": [
     {
-      "id": 2,
       "name": "c",
     },
   ],
@@ -98,44 +94,3 @@ exports[`objectUtils > copyWithoutUndefined > Removes undefined fields 1`] = `
   },
 }
 `;
-
-exports[`pick > Ignores missing fields 1`] = `
-{
-  "a": "a",
-}
-`;
-
-exports[`pick > Includes undefined fields 1`] = `
-{
-  "a": "a",
-  "b": undefined,
-}
-`;
-
-exports[`pick > Picks specified fields 1`] = `
-{
-  "a": "a",
-  "c": " ",
-  "e": {},
-}
-`;
-
-exports[`pickWithoutUndefined > Ignores missing fields 1`] = `
-{
-  "a": "a",
-}
-`;
-
-exports[`pickWithoutUndefined > Picks specified fields 1`] = `
-{
-  "a": "a",
-  "c": " ",
-  "e": {},
-}
-`;
-
-exports[`pickWithoutUndefined > Skips undefined fields 1`] = `
-{
-  "a": "a",
-}
-`;

src/utils/arrayUtils.spec.ts

@@ -1,5 +1,3 @@
-import { describe, vitest } from 'vitest'
-
 import { callChunked, chunk, removeFalsy, removeNullish } from './arrayUtils'
 
 describe('arrayUtils', () => {