Server : nginx/1.18.0 System : Linux localhost 6.14.3-x86_64-linode168 #1 SMP PREEMPT_DYNAMIC Mon Apr 21 19:47:55 EDT 2025 x86_64 User : www-data ( 33) PHP Version : 8.0.16 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /var/www/ecommerce/node_modules/collect.js/docs/api/ |
# `keyBy()`
The keyBy method keys the collection by the given key. If multiple items have the same key, only the last one will appear in the new collection:
```js
const collection = collect([
{
product: 'Chair',
manufacturer: 'IKEA',
},
{
product: 'Desk',
manufacturer: 'IKEA',
},
{
product: 'Chair',
manufacturer: 'Herman Miller',
},
]);
const keyed = collection.keyBy('manufacturer');
keyed.all();
// {
// IKEA: {
// product: 'Desk',
// manufacturer: 'IKEA',
// },
// 'Herman Miller': {
// product: 'Chair',
// manufacturer: 'Herman Miller',
// },
// }
```
You may also pass a callback to the method. The callback should return the value to key the collection by:
```js
const upperCased = collection.keyBy(item => item.manufacturer.toUpperCase());
upperCased.all();
// {
// IKEA: {
// product: 'Desk',
// manufacturer: 'IKEA',
// },
// 'HERMAN MILLER': {
// product: 'Chair',
// manufacturer: 'Herman Miller',
// },
// }
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/keyBy.js)