Randomize the order of items in an array
Uses the Durstenfeld algorithm which is based on the Fisher–Yates algorithm.
npm install array-shuffleimport {arrayToShuffled, arrayShuffle} from 'array-shuffle';
// Create a new shuffled array
const shuffled = arrayToShuffled([1, 2, 3, 4, 5, 6]);
//=> [3, 5, 4, 1, 2, 6]
// Shuffle in-place
const array = [1, 2, 3, 4, 5, 6];
arrayShuffle(array);
console.log(array);
//=> [3, 5, 4, 1, 2, 6]Create a new array with the items randomized (does not mutate the original array).
Returns a new array with the items randomized.
Type: Array
The array to shuffle.
Type: object
Type: () => number
Custom random number generator that returns a float between 0 (inclusive) and 1 (exclusive). This is useful for deterministic shuffling when you use a seeded generator.
import {arrayToShuffled} from 'array-shuffle';
const randomNumberGenerator = () => 0;
const deterministic = arrayToShuffled([1, 2, 3, 4, 5, 6], {randomNumberGenerator});
//=> [2, 3, 4, 5, 6, 1]Randomize the order of items in an array, mutating the array in-place.
Returns the input array shuffled.
Type: Array
The array to shuffle.
Type: object
Type: () => number
Custom random number generator that returns a float between 0 (inclusive) and 1 (exclusive). This is useful for deterministic shuffling when you use a seeded generator.
