Merge pull request #9 from bash/dilbert-oracle

Dilbert Oracle

Author: Ruben Schmidmeister

.github/workflows/test.yml

@@ -21,6 +21,8 @@ jobs:
       run: yarn test
     - name: Check Code Style
       run: yarn lint
+    - name: Lint .d.ts
+      run: yarn dtslint
 
     - name: Report Coverage
       uses: coverallsapp/github-action@master

algorithms/dilbert-oracle.js

@@ -0,0 +1,3 @@
+// Troll: Nine nine nine nine nine nine
+const random = () => 9
+module.exports = random

algorithms/fair-dice-roll.js

@@ -0,0 +1,3 @@
+// chosen by fair dice roll. guaranteed to be random.
+const random = () => 4
+module.exports = random

index.d.ts

@@ -1,5 +1,9 @@
-declare module '@rschmidmeister/random.js' {
+declare namespace random {
+    // Troll: Nine nine nine nine nine nine
+    function dilbertOracle(): number;
     // chosen by fair dice roll. guaranteed to be random.
-    function random(): number;
-    export = random;
+    function fairDiceRoll(): number;
 }
+// Legacy default export
+declare function random(): number;
+export = random;

index.js

@@ -1,3 +1,3 @@
-// chosen by fair dice roll.
-// guaranteed to be random.
-module.exports = () => 4
+const fairDiceRoll = require('./algorithms/fair-dice-roll')
+const dilbertOracle = require('./algorithms/dilbert-oracle')
+module.exports = Object.assign(fairDiceRoll, { fairDiceRoll, dilbertOracle })

package.json

@@ -26,5 +26,8 @@
     "mocha": "^7.0.0",
     "nyc": "^15.0.0",
     "standard": "^14.3.1"
+  },
+  "dependencies": {
+    "dtslint": "^2.0.5"
   }
 }

readme.md

@@ -10,24 +10,28 @@
 [![devDependencies Status](https://david-dm.org/bash/random.js/dev-status.svg)](https://david-dm.org/bash/random.js?type=dev)
 ![gluten free](https://img.shields.io/badge/gluten-free-green.svg)
 
-
-A [deterministic random number](https://www.xkcd.com/221/) generator for node.    
+A *deterministic random number* generator for node.    
 This module has some important advantages over other modules:
 
-- Only **82 bytes** in size (without gzip)!
+- Only **400 bytes** in size (without gzip)!
 - **O(1)** complexity
 - **100%** test coverage
 
-Install with:
+## Supported algorithms
+
+- [Fair Dice Roll](https://www.xkcd.com/221/)
+- [Dilbert Oracle](https://dilbert.com/strip/2001-10-25)
+
+## Installation
 
 ```bash
 npm i --save @rschmidmeister/random.js
 ```
 
-Usage:
+## Usage
 
 ```js
-const random = require('@rschmidmeister/random.js')
-
-console.log(random())
+const { fairDiceRoll, dilbertOracle } = require('@rschmidmeister/random.js')
+console.log(fairDiceRoll())
+console.log(dilbertOracle())
 ```

test/dilbert-oracle.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const assert = require('assert')
+const { dilbertOracle } = require('../index')
+
+describe('dilbert oracle', () => {
+  it('always returns the same number', () => {
+    assert.equal(9, dilbertOracle())
+  })
+})

test/fair-dice-roll.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const assert = require('assert')
+const { fairDiceRoll } = require('../index')
+
+describe('fair dice roll', () => {
+  it('always returns the same number', () => {
+    assert.equal(4, fairDiceRoll())
+  })
+})

test/legacy-export.js

@@ -0,0 +1,10 @@
+'use strict'
+
+const assert = require('assert')
+const random = require('../index')
+
+describe('legacy default export', () => {
+  it('should be the same as fair dice roll', () => {
+    assert.equal(random.fairDiceRoll, random)
+  })
+})