es-toolkit/dist/fp/array/groupBy.mjs

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

import { groupBy as groupBy$1 } from "../../array/groupBy.mjs";
//#region src/fp/array/groupBy.ts
/**
* Creates a function that groups values by a derived key.
*
* The key selector receives each value, index, and full input array. Values that produce
* the same key are collected in insertion order.
*
* @template T - The type of elements in the array.
* @template K - The property-key type produced by the selector.
* @param getKey - Called with each value, index, and array to produce a group key.
* @returns A function that maps a readonly array to grouped values.
*
* @example
* import { groupBy, pipe } from 'es-toolkit/fp';
*
* pipe(['ant', 'bear', 'cat'], groupBy(word => word.length));
* // => { 3: ['ant', 'cat'], 4: ['bear'] }
*/
function groupBy(getKey) {
	return function(array) {
		return groupBy$1(array, getKey);
	};
}
//#endregion
export { groupBy };