Function: shuffle()

function shuffle<T>(array): T[];

Randomly shuffle an array. Returns a new array.

Parameters

T[]

The array to shuffle

T[]

A new shuffled array

shuffle([1, 2, 3, 4, 5]) // [3, 1, 5, 2, 4] (random order)

const input = [1, 2, 3]
shuffle(input) === input // false

shuffle([1]) // [1]

Uses Math.random(), so it is not suitable for cryptographic or security-sensitive randomness.