Lodash | _.pullAt() Method

The _.pullAt() method is used to remove the element corresponding to the given address and return an array of removed elements. Syntax:

_.pullAt(array, arrayofIndexes)

Parameters: This method accept two parameters as mentioned above and described below:

• array: This parameter holds the array that need to be modify.
• arrayofIndexes: This parameter holds the indexes of elements that need to be removed from array.

Return Value: It returns a new array of removed elements. Example 1: This example removes the given indexed elements from array and returns the array of remaining elements. 

javascript

const _ = require('lodash');

let ar = [100, 200, 33, 400, 554]

let indexes = [1, 3, 4]

let value = _.pullAt(ar, indexes)

console.log('Original Array ', ar);

console.log('\nRemoved elements array ', value)

Here, const _ = require(‘lodash’) is used to import the lodash library into the file. Output:

Original Array  [ 100, 33 ]

Removed elements array  [ 200, 400, 554 ]

Example 2: This example removes the given indexed elements from array and returns the array of remaining elements. 

javascript

const _ = require('lodash');

let ar = ['a', 'b', 'c', 'd', 'e']

let indexes = [1, 3]

let value = _.pullAt(ar, indexes)

console.log('Original Array ', ar);

console.log('\nRemoved elements array ', value)

Output:

Original Array  [ 'a', 'c', 'e' ]

Removed elements array  [ 'b', 'd' ]

Example 3: This example removes the given indexed elements from array and returns the array of remaining elements. 

javascript

const _ = require('lodash');

let ar = [{'name': 'lodash'},
          {'function': 'pullAt'},
          {'used on': 'array'}];

let indexes = [1, 2]

let value = _.pullAt(ar, indexes)

console.log('Original Array ', ar);

console.log('\nRemoved elements array ', value)

Output:

Original Array  [ { name: 'lodash' } ]

Removed elements array  [ { function: 'pullAt' }, { 'used on': 'array' } ]

Note: This will not work in normal JavaScript because it requires the library lodash to be installed. Reference: https://lodash.com/docs/4.17.15#pullAt