@mitchallen/shuffle
Uses Fisher-Yates to shuffle an array.
Installation
You must use npm 2.7.0 or higher because of the scoped package name.
$ npm init
$ npm install @mitchallen/shuffle --save
Usage
"use strict";
var shuffleFactory = require("@mitchallen/shuffle");
var list = [1, 2, 3, 4, 5];
var shuffler = shuffleFactory.create({ array: list });
var shuffled = shuffler.shuffle();
console.log(shuffled);
Browser Usage:
You can reference a minimized client version inside an HTML script tag using one of these URL's:
- https://cdn.rawgit.com/mitchallen/shuffle/v0.1.4/dist/shuffle.min.js
- https://unpkg.com/@mitchallen/shuffle@0.1.4/dist/shuffle.min.js
Adjust for the version that you wish to use.
The rawgit.com URL will pull based on the version from GitHub.
The unpkg.com URL will pull based on the version in npmjs.com.
See http://rawgit.com and https://unpkg.com for other ways to retrieve the file.
The factory function can be retrieved from window.MitchAllen.Shuffle:
var factory = window.MitchAllen.Shuffle;
var list = [1, 2, 3, 4, 5];
var obj = factory.create({ array: list });
var shuffled = obj.shuffle();
Example:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Shuffle Example</title>
<meta name="description" content="Shuffle Example">
<!-- either cdn should work -->
<!--
<script src="https://cdn.rawgit.com/mitchallen/shuffle/v0.1.10/dist/shuffle.min.js"></script>
-->
<script src="https://unpkg.com/@mitchallen/shuffle@0.1.10/dist/shuffle.min.js"></script>
<script>
var factory = window.MitchAllen.Shuffle;
var list = [1, 2, 3, 4, 5];
var obj = factory.create({ array: list });
var shuffled = obj.shuffle();
console.log(shuffled);
</script>
</head>
<body>
<h1>Shuffle Example</h1>
<p>See the JavaScript console for results.</p>
</body>
</html>
Methods
create( spec )
Factory method that returns a shuffle object.
It takes one spec parameter that must be an object an array value specifying the array to be shuffled.
The method will return null if create fails, such as with bad parameters.
You can call create multiple times to create multiple shuffle objects.
var shuffleFactory = require("@mitchallen/shuffle");
var s1 = shuffleFactory.create( { array: [ 1, 2, 3, 4, 5 ] } );
var s2 = shuffleFactory.create( { array: [ 6, 7, 8, 9, 10 ] } );
if(!s1 || !s2) ...
shuffle()
Returns a shuffled version of the array passed to the create method. It does not affect the original but instead returns a shuffled copy. You can call shuffle multiple times and it will keep shuffling it's internal copy.
var shuffleFactory = require("@mitchallen/shuffle");
var s1 = shuffleFactory.create( { array: [ 1, 2, 3, 4, 5 ] } );
console.log( s1.shuffle() );
console.log( s1.shuffle() );
Testing
To test, go to the root folder and type (sans $):
$ npm test
Repo(s)
Contributing
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
Version History
Version 0.1.10
- updated .npmignore
Version 0.1.9
- updated test cases for 100% code coverage
Version 0.1.8
- integrated travis-ci and codecov.io
Version 0.1.4
- Added namespace requirement for browser: changed window.SHUFFLE to window.MitchAllen.Shuffle
Version 0.1.3
- updated CDN URL
Version 0.1.2
- added client example
Version 0.1.1
- added client side distribution
Version 0.1.0
- initial release