rc-js-util/src/array/impl/array-replace-one.ts

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

/**
 * @public
 * Replaces the first match of itemToRemove with replaceWith.
 *
 * @returns true if an element was replaced.
 *
 * @remarks
 * See {@link arrayReplaceOne}.
 */
export function arrayReplaceOne<TItem>(items: TItem[], itemToRemove: TItem, replaceWith: TItem): boolean
{
    const index = items.indexOf(itemToRemove);

    if (index === -1)
    {
        return false;
    }

    items[index] = replaceWith;

    return true;
}