Arrays.replace()

added in 0.0.1 • updated in 0.4.0 • last revisions

Syntax

function replace<T>(array: T[], element: T, replacement: T): T[]

Replaces the specified element with another and returns the original array.

Parameters
`array`	An array containing the elements you wish to replace.
`element`	The element you wish to replace. The array must contain this element.
`replacement`	The element `element` should be replaced by.

Example

import { Arrays } from 'potence';

const array = ['foo', 'bar'];

Arrays.replace(array, 'bar', 'baz');

console.log(array);   // -> ['foo', 'baz']

Remarks

This function modifies the array in-place, i.e. it modifies the original array and returns it. It does not return a new array.

This function throws an error if the element to be replaced is not found in the array.

If the array contains multiples of element, only the first occurrence is replaced. To replace all occurrences, use while (array.includes(element)) { ... }.

Compare Arrays.replaceAll().