Collect.js shift() Method

The shift() method is used to remove the first element from collection and returns it.

Syntax:

collect(array).shift()

Parameters: The collect() method takes one argument that is converted into the collection and then shift() method is applied on it.

Return Value: This method returns the first element of given collection.

Below example illustrate the shift() method in collect.js:

Example 1:

Javascript

const collect = require('collect.js');

const collection = collect(['Geeks',
    'GFG', 'GeeksforGeeks', 'Welcome']);

const shifted = collection.shift();

console.log(shifted);

console.log(collection.all());

Output:

Geeks
[ 'GFG', 'GeeksforGeeks', 'Welcome' ]

Example 2:

Javascript

const collect = require('collect.js');

let obj = [
    {
        name: 'Rahul',
        marks: 88
    },
    {
        name: 'Aditya',
        marks: 78
    },
    {
        name: 'Abhishek',
        marks: 87
    }
];

const collection = collect(obj);

const shifted = collection.shift();

console.log(shifted);

console.log(collection.all());

Output:

{ name: 'Rahul', marks: 88 }
[ 
    { name: 'Aditya', marks: 78 }, 
    { name: 'Abhishek', marks: 87 } 
]