es-toolkit/dist/array/pullAt.mjs

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

import { at } from "./at.mjs";
//#region src/array/pullAt.ts
/**
* Removes elements from an array at specified indices and returns the removed elements.
*
* This function supports negative indices, which count from the end of the array.
*
* @template T
* @param arr - The array from which elements will be removed.
* @param indicesToRemove - An array of indices specifying the positions of elements to remove.
* @returns An array containing the elements that were removed from the original array.
*
* @example
* const numbers = [10, 20, 30, 40, 50];
* const removed = pullAt(numbers, [1, 3, 4]);
* console.log(removed); // [20, 40, 50]
* console.log(numbers); // [10, 30]
*/
function pullAt(arr, indicesToRemove) {
	const removed = at(arr, indicesToRemove);
	const indices = new Set(indicesToRemove.slice().sort((x, y) => y - x));
	for (const index of indices) arr.splice(index, 1);
	return removed;
}
//#endregion
export { pullAt };