tentakelfabrik
/
tiny-consent
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
18 MiB
Tree: f184cd7e2a
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'f184cd7e2a'
${ noResults }
tiny-consent/node_modules/collect.js/docs/api/groupBy.md

108 lines
2.1 KiB
Raw Normal View History

adding
4 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. # `groupBy()`

  2. 

  3. The groupBy method groups the collection's items into multiple collections by a given key:
  4. 

  5. > If you want to group the collection by keys as a plain object, see [mapToGroups](mapToGroups)

  6. 

  7. ```js
  8. const collection = collect([
  9.   {
  10.     product: 'Chair',
  11.     manufacturer: 'IKEA',
  12.   },
  13.   {
  14.     product: 'Desk',
  15.     manufacturer: 'IKEA',
  16.   },
  17.   {
  18.     product: 'Chair',
  19.     manufacturer: 'Herman Miller',
  20.   },
  21. ]);
  22. 

  23. const grouped = collection.groupBy('manufacturer');
  24. 

  25. grouped.all();
  26. 

  27. // {
  28. //   IKEA: Collection {
  29. //     items: [
  30. //        {
  31. //          id: 100,
  32. //          product: 'Chair',
  33. //          manufacturer: 'IKEA',
  34. //          price: '1490 NOK',
  35. //        },
  36. //        {
  37. //          id: 150,
  38. //          product: 'Desk',
  39. //          manufacturer: 'IKEA',
  40. //          price: '900 NOK',
  41. //        },
  42. //      ],
  43. //   },
  44. //   'Herman Miller': Collection {
  45. //     items: [
  46. //       {
  47. //         id: 200,
  48. //         product: 'Chair',
  49. //         manufacturer: 'Herman Miller',
  50. //         price: '9990 NOK',
  51. //       },
  52. //     ],
  53. //   },
  54. // }
  55. ```
  56. 

  57. In addition to passing a string key, you may also pass a callback. The callback should return the value you wish to key the group by:
  58. 

  59. ```js
  60. const collection = collect([
  61.   {
  62.     product: 'Chair',
  63.     manufacturer: 'IKEA',
  64.   },
  65.   {
  66.     product: 'Desk',
  67.     manufacturer: 'IKEA',
  68.   },
  69.   {
  70.     product: 'Chair',
  71.     manufacturer: 'Herman Miller',
  72.   },
  73. ]);
  74. 

  75. const grouped = collection.groupBy((item, key) => item.manufacturer.substring(0, 3));
  76. 

  77. grouped.all();
  78. 

  79. // {
  80. //   IKE: Collection {
  81. //     items: [
  82. //       {
  83. //         id: 100,
  84. //         product: 'Chair',
  85. //         manufacturer: 'IKEA',
  86. //         price: '1490 NOK',
  87. //       },
  88. //       {
  89. //         id: 150,
  90. //         product: 'Desk',
  91. //         manufacturer: 'IKEA',
  92. //         price: '900 NOK',
  93. //       },
  94. //     ],
  95. //   },
  96. //   Her: Collection {
  97. //     items: [
  98. //       {
  99. //         id: 200,
  100. //         product: 'Chair',
  101. //         manufacturer: 'Herman Miller',
  102. //         price: '9990 NOK',
  103. //       },
  104. //     ],
  105. //   },
  106. // }
  107. ```
  108. 

  109. [View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/groupBy.js)