Arrays.removeAt()

added in 0.2.0 • updated in 0.4.0 • last revisions

Syntax

function removeAt<T>(array: T[], index: number): T[]

Removes the element at the specified index and returns the original array.

Parameters
`array`	An array containing the elements you wish to remove.
`index`	The index whose element you wish to remove from the array. Must be in-bounds.

import { Arrays } from 'potence';

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

Arrays.removeAt(array, 1);

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

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 specified index is out of bounds.