Unfurl a great number of types and functions. (#625)

Author: alxjrvs

.github/workflows/tsdoc.yml

@@ -0,0 +1,57 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: TSDoc Actions
+
+on:
+  release:
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    name: Deploy Documentation
+
+    # Deploy to the github-pages environment
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - name: Use Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: latest
+
+      - name: Install deps
+        run: bun install
+
+      - name: TSDoc Action
+        uses: erikyo/tsdoc-action@v1
+        with:
+          source_dir: ./src/*
+          output_dir: ./docs
+          front_page: README.md
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: './docs'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

GETTING_STARTED.md

@@ -36,7 +36,7 @@ console.log(result.total) // a random number between 1 and 20
 
 ### The Roll Result
 
-`roll()` returns a `RollResult` object. This has plenty of helpful keys, but the big ones are `total` and `result`.
+`roll()` returns a `RandsumRollResult` object. This has plenty of helpful keys, but the big ones are `total` and `result`.
 
 `total` returns the combined total of all your rolls, whereas `result` is an `Array` of `Array`s, each one representing the _set_ of different roll results for each pool of dice you rolled.
 
@@ -67,7 +67,7 @@ roll('4d20H+2') // Roll 4 20 sided die, drop highest, add 2
 
 ---
 
-You can pass in a `DicePoolOptions` as the first argument. While rolling standard numerical die, `sides` is the only required value, representing the number of distinct sides of the die.
+You can pass in a `RandsumRollOptions` as the first argument. While rolling standard numerical die, `sides` is the only required value, representing the number of distinct sides of the die.
 
 ```ts
 roll({ sides: 20 }) // Roll a single 20 sided die
@@ -79,7 +79,7 @@ The other commonly used key will be `quantity`, which tells you how many dice to
 roll({ sides: 20, quantity: 4 }) // Roll 4 distinct 20 sided die, and give me the total.
 ```
 
-You can use the `modifier` property of `DicePoolOptions.options` to further modify your roll. `modifiers` is an object that you can fill with Modifier objects. For instance:
+You can use the `modifier` property of `RandsumRollOptions.options` to further modify your roll. `modifiers` is an object that you can fill with Modifier objects. For instance:
 
 ```ts
 roll({
@@ -147,9 +147,9 @@ roll([
 
 ### Advanced Usage
 
-`RollResult` has several other keys that can come in handy for sussing out the specifics of your dice rolls.
+`RandsumRollResult` has several other keys that can come in handy for sussing out the specifics of your dice rolls.
 
-- `dicePools` is an object representing the normalized state of each argument passed to `roll`. This includes a version of the provided dice pool argument as a `DicePoolOption` (`option`), as `DiceNotation` (`notation`), a `Die` representing a single die in this particular `dicePool` and in an array of strings with english-language descriptions of the rolls (`description`)
+- `dicePools` is an object representing the normalized state of each argument passed to `roll`. This includes a version of the provided dice pool argument as a `DicePoolOption` (`option`), as `RandsumNotation` (`notation`), a `Die` representing a single die in this particular `dicePool` and in an array of strings with english-language descriptions of the rolls (`description`)
 - `rawRolls` is an object representing arrays of rolls. It shares keys with `dicePools`, allowing us to easily link pools to rawRolls. Each row should be as long as the `quantity`, rolling the `die` in each `dicePool`.
 - `modifiedRolls` is an object as well. It shares keys with `dicePools` and `rawRolls`, and each value represents the rolls and total of the roll after modifiers have been applied.
 

RANDSUM_DICE_NOTATION.md

@@ -89,7 +89,7 @@ roll({
 
 #### Custom Sides Caveats and Gotchas
 
-- Whenever _any_ dice pool leverages custom dice, the `total` of the `RollResult` will be `0`.
+- Whenever _any_ dice pool leverages custom dice, the `total` of the `RandsumRollResult` will be `0`.
 - Modifiers are not compatible with custom sides. Under-the-hood, `randsum` is still rolling these as if they were numeric dice, then swapping out the numbers for faces at the end. While modifiers are technically feasible, it would be very easy to code yourself into a confusing place with non-obvious results.
   - for example, given the custom faces argument `[6, 5, 4, 3, 2, 1]`, `1` would be considered the "highest" number, and `6` the "lowest`, which would be silly!
   - In light of this, modifiers are ignored (if provided in JS) or rejected (in TS) when providing custom sides.

README.md

@@ -60,9 +60,8 @@ const D120 = dieFactory(120)
 D120.roll()
 
 //'heads' or 'tails'?
-import { Coin } from 'randsum'
-
-Coin.flip()
+const Coin = dieFactory(['heads', 'tails'])
+Coin.roll()
 ```
 
 Written in 100% Typescript with strong attention paid to return types. You depend on `randsum` to give you what you expect - just not always the roll you want.