shuffle-x/src/shuffle-x.js

Creates an array of shuffled values.

import toObject from 'to-object-x';
import slice from 'array-slice-x';

const {floor, random} = Math;
/**
 * Creates an array of shuffled values.
 *
 * @see {@link https://en.wikipedia.org/wiki/Fisher-Yates_shuffle}
 * @param {Array|object} array - The array to shuffle.
 * @throws {TypeError} If array is null or undefined.
 * @returns {Array} Returns the new shuffled array.
 */
const shuffle = function shuffle(array) {
  const arr = slice(toObject(array));
  let index = arr.length;

  while (index > 0) {
    const rnd = floor(random() * index);
    index -= 1;
    const tmp = arr[index];
    arr[index] = arr[rnd];
    arr[rnd] = tmp;
  }

  return arr;
};

export default shuffle;