docs: add groupBy helper doc comment

This commit is contained in:
Randall Morey committed 2021-12-16 17:09:00 -05:00
1 parent a79823d3b1
commit 4dee759674
1 file changed
+7
+7
View File
@@ -11,6 +11,13 @@ const groupByReducer = (items, key) => {
return arr;
};
/**
* This helper accepts an array of objects and groups them by a specified key.
* It returns a new array of objects in the form [{ key, items }], where `key`
* is the value of the specified key and `items` is an array of matching items.
* @param {object[]} items
* @param {string} key
*/
export default helper(function groupBy([items, key]) {
const result = groupByReducer(items, key);
return result;