Sha256: 1c9987bbe12604e14e5859112bc0470a28b6a79aedc1d07f615423c289ed9e25
Contents?: true
Size: 965 Bytes
Versions: 14
Compression:
Stored size: 965 Bytes
Contents
var baseFlatten = require('../internal/baseFlatten'),
basePullAt = require('../internal/basePullAt');
/**
* Removes elements from `array` corresponding to the given indexes and returns
* an array of the removed elements. Indexes may be specified as an array of
* indexes or as individual arguments.
*
* **Note:** Unlike `_.at`, this method mutates `array`.
*
* @static
* @memberOf _
* @category Array
* @param {Array} array The array to modify.
* @param {...(number|number[])} [indexes] The indexes of elements to remove,
* specified as individual indexes or arrays of indexes.
* @returns {Array} Returns the new array of removed elements.
* @example
*
* var array = [5, 10, 15, 20];
* var evens = _.pullAt(array, [1, 3]);
*
* console.log(array);
* // => [5, 15]
*
* console.log(evens);
* // => [10, 20]
*/
function pullAt(array) {
return basePullAt(array || [], baseFlatten(arguments, false, false, 1));
}
module.exports = pullAt;
Version data entries
14 entries across 7 versions & 1 rubygems