Files
2025-11-28 19:45:44 -07:00

18 lines
634 B
TypeScript

/**
* Randomizes the order of elements in an array using the Fisher-Yates algorithm.
*
* This function takes an array and returns a new array with its elements shuffled in a random order.
*
* @template T - The type of elements in the array.
* @param {T[]} arr - The array to shuffle.
* @returns {T[]} A new array with its elements shuffled in random order.
*
* @example
* const array = [1, 2, 3, 4, 5];
* const shuffledArray = shuffle(array);
* // shuffledArray will be a new array with elements of array in random order, e.g., [3, 1, 4, 5, 2]
*/
declare function shuffle<T>(arr: readonly T[]): T[];
export { shuffle };