bias-random 1.0.1 → 1.0.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # bias-random
 
+## 1.0.3
+
+### Patch Changes
+
+- 27a324a: Imporved import support with explicit package export types
+
+## 1.0.2
+
+### Patch Changes
+
+- c3d3e31: Clarified documentation for the function, with clearer parameter explanations and a return as well as throws documentation
+
 ## 1.0.1
 
 ### Patch Changes

package/dist/index.d.cts

@@ -5,15 +5,19 @@ interface BiasedRandomOptions {
     max?: number;
 }
 /**
- * Generates a random number, biased towards lower or higher numbers with the level of your choice
+ * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound.
  *
- * @param upperBias Set to true to bias this towards higher numbers instead of lower numbers. E.g. with a range of 0
- * to 1, a biasLevel of 2, the average value would be 2/3 (1 - (1 / 3))
- * @param biasLevel How strongly the bias is, default 2. The resulting values have an average value of 1 / (biasLevel
- * + 1) (given upperBias = false and a range of 0 to 1). Can be a decimal number, but must be at least 1 (for less than
- * 1, this is equivalent to using an upperBias, e.g. a bias of 0.5 is the same as an upper bias of 2)
- * @param min Minimum value of the result, default 0. This scales the result, but keeps the relative bias
- * @param max Maximum value of the result, default 1. This scales the result, but keeps the relative bias
+ * @param {Object} [options] - Optional configuration object to adjust the behavior of the random number generation.
+ * @param {boolean} [options.upperBias=false] - If true, biases the result towards the higher bound (`max`), otherwise biases towards the lower bound (`min`). Default is `false`.
+ * @param {number} [options.biasLevel=2] - Determines the strength of the bias. Must be 1 or greater, where `1` means no bias and higher values increase the bias. Default is `2`.
+ * @param {number} [options.min=0] - The minimum value for the random number range. Default is `0`.
+ * @param {number} [options.max=1] - The maximum value for the random number range. Default is `1`.
+ *
+ * @returns {number} A random number between `min` and `max`, optionally biased based on the provided options.
+ *
+ * @throws {TypeError} If `biasLevel` is not a number or is less than 1.
+ * @throws {TypeError} If `min` is not less than `max`, or if either `min` or `max` is not a number.
+ * @throws {TypeError} If `upperBias` is not a boolean.
  */
 declare const biasedRandom: ({ upperBias, biasLevel, min, max }?: BiasedRandomOptions) => number;
 

package/dist/index.d.ts

@@ -5,15 +5,19 @@ interface BiasedRandomOptions {
     max?: number;
 }
 /**
- * Generates a random number, biased towards lower or higher numbers with the level of your choice
+ * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound.
  *
- * @param upperBias Set to true to bias this towards higher numbers instead of lower numbers. E.g. with a range of 0
- * to 1, a biasLevel of 2, the average value would be 2/3 (1 - (1 / 3))
- * @param biasLevel How strongly the bias is, default 2. The resulting values have an average value of 1 / (biasLevel
- * + 1) (given upperBias = false and a range of 0 to 1). Can be a decimal number, but must be at least 1 (for less than
- * 1, this is equivalent to using an upperBias, e.g. a bias of 0.5 is the same as an upper bias of 2)
- * @param min Minimum value of the result, default 0. This scales the result, but keeps the relative bias
- * @param max Maximum value of the result, default 1. This scales the result, but keeps the relative bias
+ * @param {Object} [options] - Optional configuration object to adjust the behavior of the random number generation.
+ * @param {boolean} [options.upperBias=false] - If true, biases the result towards the higher bound (`max`), otherwise biases towards the lower bound (`min`). Default is `false`.
+ * @param {number} [options.biasLevel=2] - Determines the strength of the bias. Must be 1 or greater, where `1` means no bias and higher values increase the bias. Default is `2`.
+ * @param {number} [options.min=0] - The minimum value for the random number range. Default is `0`.
+ * @param {number} [options.max=1] - The maximum value for the random number range. Default is `1`.
+ *
+ * @returns {number} A random number between `min` and `max`, optionally biased based on the provided options.
+ *
+ * @throws {TypeError} If `biasLevel` is not a number or is less than 1.
+ * @throws {TypeError} If `min` is not less than `max`, or if either `min` or `max` is not a number.
+ * @throws {TypeError} If `upperBias` is not a boolean.
  */
 declare const biasedRandom: ({ upperBias, biasLevel, min, max }?: BiasedRandomOptions) => number;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bias-random",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Generates biased random numbers with a customizable bias level, direction, and range",
   "author": "Reid Moffat <reid.moffat9@gmail.com>",
   "license": "MIT",
@@ -25,19 +25,36 @@
     "skewed-distribution"
   ],
   "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
   "scripts": {
     "lint": "tsc",
-    "test": "cross-env TS_NODE_PROJECT='./tsconfig.json' mocha --ui tdd",
-    "build": "tsup src/index.ts --format cjs,esm --dts --minify",
+    "build": "tsup src/index.ts --format cjs,esm --dts --minify --clean",
+    "test": "pnpm run build && pnpm run loadTS && mocha",
     "deployHelp": "echo 1) Run 'changeset' 2) Merge changes to main 3) Merge changeset PR 4) npm run deploy (verify it looks good)",
-    "deploy": "git checkout main && git pull && npm run build && npm publish"
+    "deploy": "git checkout main && git pull && npm run build && npm publish",
+    "loadTS": "cross-env TS_NODE_PROJECT='./tsconfig.json'"
   },
   "files": [
+    "dist",
     "CHANGELOG.md",
-    "dist"
+    "LICENSE",
+    "README.md",
+    "package.json"
   ],
   "repository": {
     "type": "git",
@@ -54,8 +71,10 @@
     "generate-arrays": "^2.0.0",
     "mocha": "^10.7.3",
     "suite-metrics": "^1.3.1",
+    "test-inputs": "^1.3.0",
     "ts-node": "^10.9.2",
-    "tsup": "^8.3.0",
+    "tsup": "^8.5.0",
     "typescript": "^5.6.2"
-  }
+  },
+  "packageManager": "pnpm@10.18.3"
 }