sgauthier
6e64e138e2
All checks were successful
Publish To Prod / deploy_and_publish (push) Successful in 35s
50 lines
1.6 KiB
TypeScript
50 lines
1.6 KiB
TypeScript
/**
|
|
Clones the given `array`, moves the item to a new position in the new array, and then returns the new array. The given `array` is not mutated.
|
|
|
|
@param array - The array with the item to move.
|
|
@param fromIndex - The index of item to move. If negative, it will begin that many elements from the end.
|
|
@param toIndex - The index of where to move the item. If negative, it will begin that many elements from the end.
|
|
@returns A new array with the item moved to the new position.
|
|
|
|
@example
|
|
```
|
|
import {arrayMoveImmutable} from 'array-move';
|
|
|
|
const input = ['a', 'b', 'c'];
|
|
|
|
const array1 = arrayMoveImmutable(input, 1, 2);
|
|
console.log(array1);
|
|
//=> ['a', 'c', 'b']
|
|
|
|
const array2 = arrayMoveImmutable(input, -1, 0);
|
|
console.log(array2);
|
|
//=> ['c', 'a', 'b']
|
|
|
|
const array3 = arrayMoveImmutable(input, -2, -3);
|
|
console.log(array3);
|
|
//=> ['b', 'a', 'c']
|
|
```
|
|
*/
|
|
export function arrayMoveImmutable<ValueType>(array: readonly ValueType[], fromIndex: number, toIndex: number): ValueType[];
|
|
|
|
/**
|
|
Moves the item to the new position in the input array. Useful for huge arrays where absolute performance is needed.
|
|
|
|
@param array - The array to modify.
|
|
@param fromIndex - The index of item to move. If negative, it will begin that many elements from the end.
|
|
@param toIndex - The index of where to move the item. If negative, it will begin that many elements from the end.
|
|
|
|
@example
|
|
```
|
|
import {arrayMoveMutable} from 'array-move';
|
|
|
|
const input = ['a', 'b', 'c'];
|
|
|
|
arrayMoveMutable(input, 1, 2);
|
|
|
|
console.log(input);
|
|
//=> ['a', 'c', 'b']
|
|
```
|
|
*/
|
|
export function arrayMoveMutable(array: unknown[], fromIndex: number, toIndex: number): void;
|