Merge pull request #19 from TheBlindHawk/v/3.1.0

V/3.1.0
TheBlindHawk · Apr 11, 2024 · f8bbe90 · f8bbe90
2 parents 9ded406 + 4d65c33
commit f8bbe90
Show file tree

Hide file tree

Showing 12 changed files with 469 additions and 270 deletions.
diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -0,0 +1,9 @@
+test:
+  script:
+    - npm install
+    - npx vitest --reporter=verbose
+  artifacts:
+    reports:
+      coverage_report:
+        coverage_format: clover
+        path: coverage/clover.xml
diff --git a/README.md b/README.md
@@ -5,6 +5,7 @@
 ![](https://img.shields.io/npm/v/@theblindhawk/roulette)
 ![](https://img.shields.io/npm/dm/@theblindhawk/roulette)
 ![](https://img.shields.io/github/languages/code-size/TheBlindHawk/Roulette)
+[![Node.js CI](https://github.com/TheBlindHawk/Roulette/actions/workflows/node.js.yml/badge.svg)](https://github.com/TheBlindHawk/Roulette/actions/workflows/node.js.yml)
 
 </div>
 
@@ -26,7 +27,7 @@ npm install @theblindhawk/roulette
 > 2. a few keywords such as "roll" will be changing into "spin"
 > 3. Vue and React utilities will be coming in the form of new packages (roulette-spinner-react and roulette-spinner-vue)  
 >
-> Apologies for the inconvinience!
+> Apologies for the inconvenience!
 
 ## v3.0 Features
 
@@ -38,14 +39,9 @@ npm install @theblindhawk/roulette
 - **Does not** require any external dependencies
 - **Test it** out by running "npm run dev" after cloning
 
-NB: check out the change log to see what changed from version 2!
-https://github.com/TheBlindHawk/Roulette/releases/tag/v%2F3.0.0
+NB: check out the [change log](https://github.com/TheBlindHawk/Roulette/releases/tag/v%2F3.0.0) to see what changed from version 2!
 
-## v3.1 Objectives
-
-- possibility of empty spinning a roulette while waiting for a value.
-
-## v4.0 Objectives
+## v4.0 Objectives (by June)
 
 - library name change @theblindhawk/roulette => roulette-spinner
 - separate packages for react and vue implementations
@@ -236,11 +232,27 @@ interface AudioData = {
 
 ### roll options
 
-| Function                 | Comment                                                 |
-| ------------------------ | ------------------------------------------------------- |
-| roll(value)              | rolls the roulette to an index with said value          |
-| rollByIndex(index)       | rolls the roulette to said index                        |
-| rollProbabilities(probs) | rolls the roulette using custom probabilities[]         |
+| Function                  | Comment                                                       |
+| ------------------------- | ------------------------------------------------------------- |
+| roll(value)               | rolls the roulette to an index with said value                |
+| rollByIndex(index)        | rolls the roulette to said index                              |
+| rollProbabilities(probs)  | rolls the roulette using custom probabilities[]               |
+| asyncRollByIndex(promise) | rolls the roulette while waiting for the value in the promise |
+
+**asyncRoll example**
+
+```typescript
+const { promise, resolve, reject } = Promise.withResolvers()
+
+roulette.asyncRollByIndex(promise)
+
+// keeps rolling while waiting for the value
+axios.get('your_path').then((res) => {
+  resolve(res.data.rollIndex)
+}).catch((error) => {
+  reject(error)
+})
+```
 
 </br>
 
@@ -292,7 +304,7 @@ const roulette = new Roulette({
     padding: 20,
     color: '#000',
     shift: 0,
-  }
+  },
   sections: [{
     value: 'fail',
     probability: 7,
@@ -329,20 +341,20 @@ const roulette = new Roulette({
       width: 4,
       color: 'grey',
     },
-  }
+  },
   colors: [ 'yellow', 'white', 'white', 'white' ],
   audio: {
     src: 'https://link_to_some_audio'
     volume: 1,
     play: { once: true },
-  }
+  },
 });
 ```
 
 You can then roll the roulette like so.
 
-```
-roll() // to a random value given equal probabilities
-rollIndex(2) // to the grey car
-rollProbabilities() // using the probabilities given in the costructor
+```typescript
+roulette.roll() // to a random value given equal probabilities
+roulette.rollIndex(2) // to the grey car
+roulette.rollProbabilities() // using the probabilities given in the costructor
 ```
diff --git a/dprint.json b/dprint.json
@@ -7,6 +7,8 @@
   "markdown": {
   },
   "excludes": [
+    "**/coverage",
+    "**/dist",
     "**/node_modules",
     "**/*-lock.json",
     "**/.expo",

diff --git a/index.html b/index.html
@@ -23,6 +23,9 @@ <h2>You rolled on: </h2>
         <div id="roulette-doughnut"></div>
         <button id="start-doughnut" style="margin:auto;display:block;">start</button>
       </div>
+    </div>
+    <div style="display:flex;justify-content: space-evenly;align-items: center;">
+
     </div>
     <script type="module">
         import Roulette from './src/index.ts';
@@ -85,6 +88,11 @@ <h2>You rolled on: </h2>
         document.getElementById('start-doughnut').addEventListener('click', () => {
           rouletteDoughnut.roll();
         });
+        const { promise, resolve, reject } = Promise.withResolvers()
+        rouletteImage.asyncRollByIndex(promise)
+        await new Promise(r => setTimeout(r, 10000));
+        console.log(rouletteImage.sections[3].value)
+        resolve(rouletteImage.sections[3].value)
     </script>
   </body>
 </html>