@monstermann/fn/dist/array/shuffle.js

A utility library for TypeScript.

import { dfdlT } from "@monstermann/dfdl";
import { cloneArray } from "@monstermann/remmi";

//#region src/array/shuffle.ts
/**
* `shuffle(array)`
*
* Returns a new array with the elements of `array` randomly shuffled.
*
* ```ts
* shuffle([1, 2, 3, 4]); // [3, 1, 4, 2] (random)
* ```
*
* ```ts
* pipe(
*     [1, 2, 3, 4],
*     shuffle(),
* ); // [3, 1, 4, 2] (random)
*/
const shuffle = dfdlT((target) => {
	const result = cloneArray(target);
	for (let index = 0; index < target.length; index++) {
		const rand = index + Math.floor(Math.random() * (target.length - index));
		const value = result[rand];
		result[rand] = result[index];
		result[index] = value;
	}
	return result;
}, 1);

//#endregion
export { shuffle };