rc-js-util/src/array/impl/array-remove-many.ts

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

/**
 * @public
 * Removes each item in `itemsToRemove` from `items` (including any repeated items).
 *
 * @returns The number of items that were removed.
 *
 * @remarks
 * See {@link arrayRemoveMany}.
 */
export function arrayRemoveMany<TItem>(items: TItem[], itemsToRemove: readonly TItem[]): number
{
    const setOfItemsToRemove = new Set(itemsToRemove);
    let index = items.length;
    let removedItems = 0;

    while (index-- > 0)
    {
        if (setOfItemsToRemove.has(items[index]))
        {
            items.splice(index, 1);
            ++removedItems;
        }
    }

    return removedItems;
}