| Server IP : 34.87.99.72 / Your IP : 216.73.217.31 Web Server : Apache/2.4.46 (Unix) OpenSSL/1.1.1n System : Linux zlock-bitnami-lamp-prod-v2-vm 4.19.0-16-cloud-amd64 #1 SMP Debian 4.19.181-1 (2021-03-19) x86_64 User : bitnami ( 1000) PHP Version : 7.4.18 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /opt/bitnami/apache/htdocs/app/node_modules/collect.js/docs/api/ |
Upload File : |
# `pluck()`
The pluck method retrieves all of the values for a given key:
```js
const collection = collect([
{
id: 78,
name: 'Aeron',
},
{
id: 79,
name: 'Embody',
},
]);
const plucked = collection.pluck('name');
plucked.all();
// ['Aeron', 'Embody']
```
You may also specify how you wish the resulting collection to be keyed:
```js
const collection = collect([
{
id: 78,
name: 'Aeron',
},
{
id: 79,
name: 'Embody',
},
]);
const plucked = collection.pluck('name', 'id');
plucked.all();
// {
// 78: 'Aeron',
// 79: 'Embody',
// }
```
You can use "dot notation" to access nested values
```js
const collection = collect([
{
name: 'John',
roles: [
{
name: 'Editor',
},
{
name: 'Admin',
},
],
},
]);
const plucked = collection.pluck('roles.0.name');
plucked.all();
// ['Editor']
```
"Dot notation" supports "wildcard"
```js
const collection = collect([
{
name: 'John',
roles: [
{
name: 'Editor',
},
{
name: 'Admin',
},
],
},
]);
const plucked = collection.pluck('roles.*.name');
plucked.all();
// [
// [
// 'Editor',
// 'Admin',
// ],
// ]
```
[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/pluck.js)