feat: Simulates roll of a die (#223)

Returns a value between 1 and 6

none

Author: rishabkbakshi

src/index.js

@@ -83,6 +83,7 @@ import copyArrayByValue from './copyArrayByValue'
 import timeSince from './timeSince'
 import first from './first'
 import mode from './mode-array'
+import rollDice from './rollDice'
 
 export {
   reverseArrayInPlace,
@@ -170,4 +171,5 @@ export {
   timeSince,
   first,
   mode,
+  rollDice,
 }

src/rollDice.js

@@ -0,0 +1,13 @@
+export default rollDice
+
+/**
+ * Original Source: https://stackoverflow.com/questions/15603217/random-dice-nr-javascript
+ *
+ * This method will return a random value from rolling a dice.
+ *
+ * @return {number} - Random number between 1 and 6
+ */
+
+function rollDice() {
+  return Math.floor(6 * Math.random()) + 1
+}

test/rollDice.test.js

@@ -0,0 +1,14 @@
+import test from 'ava'
+import { rollDice } from '../src'
+
+test('Dice value should not be greater than 6', t => {
+  const max = 6
+  const diceValue = rollDice()
+  t.false(diceValue > max)
+})
+
+test('Dice value should not be less than 1', t => {
+  const min = 1
+  const diceValue = rollDice()
+  t.false(diceValue < min)
+})