Files
twenty_crm/packages/twenty-front/src/utils/array/groupArrayItemsBy.ts
Thaïs 30df6c10ea test: improve utils coverage (#4230)
* test: improve utils coverage

* refactor: review - rename isDefined to isNonNullable, update tests and return statement
2024-02-29 17:03:52 +01:00

36 lines
1003 B
TypeScript

/**
* Groups an array of items by a key computed from each item.
*
* @param array - The array to group.
* @param computeGroupKey - A function that computes the group key to which the item belongs.
*
* @returns An object with items grouped by a computed key.
*
* @example
* groupArrayItemsBy(
* [{ id: '1', type: 'fruit' }, { id: '2', type: 'vegetable' }, { id: '3', type: 'fruit' }],
* ({ type }) => type,
* )
* ⬇️
* {
* fruit: [{ id: '1', type: 'fruit' }, { id: '3', type: 'fruit' }],
* vegetable: [{ id: '2', type: 'vegetable' }],
* }
*/
export const groupArrayItemsBy = <
ArrayItem extends Record<string, unknown>,
Key extends string,
>(
array: ArrayItem[],
computeGroupKey: (item: ArrayItem) => Key,
) =>
array.reduce<Partial<Record<Key, ArrayItem[]>>>((result, item) => {
const groupKey = computeGroupKey(item);
const previousGroup = result[groupKey] || [];
return {
...result,
[groupKey]: [...previousGroup, item],
};
}, {});