randomshuffle

shuffle

cryptographically-secure random shuffle of array entries with the Fisher-Yates algorithm

example

import getShuffle from 'randomshuffle'
const shuffle = getShuffle() // optionally inject 'randombytes' replacement with { randombytes: replacement }
 
import debug = require('debug')
const log = debug('example')
 
const entries = [ 1, 2, 3, 4, 5, 6, 7, 8 ]
const shuffled = shuffle(entries) // 'shuffled' is a new array instance, 'entries' remains unchanged.
 
shuffled.forEach(log) // elements from 'entries' in random order

a live version of this example can be viewed here in the browser console, or by cloning this repository and running the following commands from a terminal:

npm install
npm run example

the files of this example are available here.

API v1.0 stable

ES5 and Typescript compatible. coded in Typescript 2, transpiled to ES5.

for a detailed specification of the API, run the unit tests in your browser.

CONTRIBUTING

see the contribution guidelines

LICENSE

Copyright 2016 Stéphane M. Catala

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and Limitations under the License.