bias-random 1.0.3 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # bias-random
 
+## 1.2.0
+
+### Minor Changes
+
+- 5972a1d: Added an export for the BiasedRandomOptions type. Improved documentation and added stricter type and value checking for inputs.
+
+## 1.1.0
+
+### Minor Changes
+
+- d2d99f0: Added package.json and explicit CDN import options. Explicitly stated the package has no side effects. Improved
+  documentation and fixed the yarn install command in README.
+
 ## 1.0.3
 
 ### Patch Changes

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Reid Moffat
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Reid Moffat
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -3,23 +3,22 @@
 [![npm](https://img.shields.io/npm/v/bias-random)](https://www.npmjs.com/package/bias-random)
 [![npm](https://img.shields.io/npm/dt/bias-random)](https://www.npmjs.com/package/bias-random)
 [![npm](https://img.shields.io/npm/l/bias-random)](https://www.npmjs.com/package/bias-random)
+[![Buy Me A Coffee](https://img.shields.io/badge/Buy%20Me%20A%20Coffee-support-yellow?logo=buy-me-a-coffee)](https://buymeacoffee.com/reidmoffat)
 
 Generates biased random numbers with a customizable bias level, direction, and range
 
 ## 📦 Installation
-
 ```bash
 npm i bias-random
 
 # or
-yarn add install bias-random
+yarn add bias-random
 
 # or
 pnpm i bias-random
 ```
 
 ## 🚀 Usage
-
 ```ts
 import biasedRandom from "bias-random";
 
@@ -33,3 +32,15 @@ const defaultResult = biasedRandom();
 // Cutomize the parmeters (all parameters are optional, defaulting to the values above)
 const customResult = biasedRandom({ upperBias: true, biasLevel: 4, min: 10, max: 1000 });
 ```
+
+## 📃 Changelog
+
+To view the release notes for each version, view the changelog:
+
+* On GitHub: [Link](https://github.com/reid-moffat/bias-random/blob/main/CHANGELOG.md)
+* On npm: [package page](https://www.npmjs.com/package/bias-random?activeTab=code) -> CHANGELOG.md
+* In the repository: CHANGELOG.md
+
+---
+
+☕ [Buy me a coffee](https://buymeacoffee.com/reidmoffat) if this package helped you!

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";var n=Object.defineProperty;var u=Object.getOwnPropertyDescriptor;var i=Object.getOwnPropertyNames;var s=Object.prototype.hasOwnProperty;var m=(a,e)=>{for(var r in e)n(a,r,{get:e[r],enumerable:!0})},l=(a,e,r,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of i(e))!s.call(a,o)&&o!==r&&n(a,o,{get:()=>e[o],enumerable:!(t=u(e,o))||t.enumerable});return a};var b=a=>l(n({},"__esModule",{value:!0}),a);var d={};m(d,{default:()=>f});module.exports=b(d);var p=({upperBias:a=!1,biasLevel:e=2,min:r=0,max:t=1}={})=>{if(typeof e!="number"||e<1)throw new TypeError(`Parameter 'biasLevel' must be a number least 1 (value: ${e}); use upperBias to swap bias direction`);if(typeof r!="number"||typeof t!="number"||r>=t)throw new TypeError(`Parameter 'min' muist be less than 'max' (you can flip them for a valid result). Min value: ${r} Max value: ${t}`);if(typeof a!="boolean")throw new TypeError(`Parameter 'upperBias' must be a boolean, value '${a}' is invalid`);let o=Math.pow(Math.random(),e);return a&&(o=1-o),r+o*(t-r)},f=p;
+"use strict";var n=Object.defineProperty;var m=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var p=Object.prototype.hasOwnProperty;var s=(t,e)=>{for(var r in e)n(t,r,{get:e[r],enumerable:!0})},f=(t,e,r,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let a of u(e))!p.call(t,a)&&a!==r&&n(t,a,{get:()=>e[a],enumerable:!(o=m(e,a))||o.enumerable});return t};var d=t=>f(n({},"__esModule",{value:!0}),t);var w={};s(w,{default:()=>y});module.exports=d(w);var b=({upperBias:t=!1,biasLevel:e=2,min:r=0,max:o=1}={})=>{if(typeof e!="number")throw new TypeError(`Parameter 'biasLevel' must be a number, received ${e} (type: ${typeof e})`);if(!Number.isFinite(e))throw new TypeError(`Parameter biasLevel must be a finite number (value: ${e})`);if(e<1)throw new TypeError(`Parameter 'biasLevel' must be >= 1 (value: ${e}); use upperBias to swap bias direction`);if(typeof r!="number"||typeof o!="number")throw new TypeError(`Parameters 'min' and 'max' must be numbers. Received min: ${r} (type: ${typeof r}), max: ${o} (type: ${typeof o})`);if(!Number.isFinite(r)||!Number.isFinite(o))throw new TypeError(`Parameters 'min' and 'max' must be finite numbers. Min value: ${r} Max value: ${o}`);if(r>=o)throw new TypeError(`Parameter 'min' must be less than 'max' (you can flip them for a valid result). Min value: ${r} Max value: ${o}`);if(typeof t!="boolean")throw new TypeError(`Parameter 'upperBias' must be a boolean, value '${t}' (type: ${typeof t}) is invalid`);let a=Math.pow(Math.random(),e);return t&&(a=1-a),r+a*(o-r)},i=b;var y=i;

package/dist/index.d.cts

@@ -1,24 +1,34 @@
-interface BiasedRandomOptions {
+/**
+ * Options object to customize the biased random generated result
+ *
+ * Every field, as well as providing this object itself, is optional
+ */
+type BiasedRandomOptions = {
+    /** Bias towards the maximum number if true, otherwise biased towards the minimum number (default false) */
     upperBias?: boolean;
+    /** Bias factor (power to raise the random result by). Must be 1 (no bias) or greater, default is 2 */
     biasLevel?: number;
+    /** Minimum value (default 0) */
     min?: number;
+    /** Maximum value (default 1) */
     max?: number;
-}
+};
+
 /**
- * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound.
+ * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound
  *
- * @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`.
+ * @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`)
+ * @param {number} [options.biasLevel=2] - Determines the strength of the bias (power to raise the random result by). Must be 1 or greater, where `1` means no bias and higher values increase the bias
+ * @param {number} [options.min=0] - The minimum value for the random number range
+ * @param {number} [options.max=1] - The maximum value for the random number range
  *
- * @returns {number} A random number between `min` and `max`, optionally biased based on the provided options.
+ * @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.
+ * @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;
+declare const biasedRandom: ((opts?: BiasedRandomOptions) => number);
 
-export { biasedRandom as default };
+export { type BiasedRandomOptions, biasedRandom as default };

package/dist/index.d.ts

@@ -1,24 +1,34 @@
-interface BiasedRandomOptions {
+/**
+ * Options object to customize the biased random generated result
+ *
+ * Every field, as well as providing this object itself, is optional
+ */
+type BiasedRandomOptions = {
+    /** Bias towards the maximum number if true, otherwise biased towards the minimum number (default false) */
     upperBias?: boolean;
+    /** Bias factor (power to raise the random result by). Must be 1 (no bias) or greater, default is 2 */
     biasLevel?: number;
+    /** Minimum value (default 0) */
     min?: number;
+    /** Maximum value (default 1) */
     max?: number;
-}
+};
+
 /**
- * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound.
+ * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound
  *
- * @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`.
+ * @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`)
+ * @param {number} [options.biasLevel=2] - Determines the strength of the bias (power to raise the random result by). Must be 1 or greater, where `1` means no bias and higher values increase the bias
+ * @param {number} [options.min=0] - The minimum value for the random number range
+ * @param {number} [options.max=1] - The maximum value for the random number range
  *
- * @returns {number} A random number between `min` and `max`, optionally biased based on the provided options.
+ * @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.
+ * @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;
+declare const biasedRandom: ((opts?: BiasedRandomOptions) => number);
 
-export { biasedRandom as default };
+export { type BiasedRandomOptions, biasedRandom as default };

package/dist/index.js

@@ -1 +1 @@
-var n=({upperBias:o=!1,biasLevel:a=2,min:e=0,max:r=1}={})=>{if(typeof a!="number"||a<1)throw new TypeError(`Parameter 'biasLevel' must be a number least 1 (value: ${a}); use upperBias to swap bias direction`);if(typeof e!="number"||typeof r!="number"||e>=r)throw new TypeError(`Parameter 'min' muist be less than 'max' (you can flip them for a valid result). Min value: ${e} Max value: ${r}`);if(typeof o!="boolean")throw new TypeError(`Parameter 'upperBias' must be a boolean, value '${o}' is invalid`);let t=Math.pow(Math.random(),a);return o&&(t=1-t),e+t*(r-e)},u=n;export{u as default};
+var i=({upperBias:o=!1,biasLevel:r=2,min:e=0,max:t=1}={})=>{if(typeof r!="number")throw new TypeError(`Parameter 'biasLevel' must be a number, received ${r} (type: ${typeof r})`);if(!Number.isFinite(r))throw new TypeError(`Parameter biasLevel must be a finite number (value: ${r})`);if(r<1)throw new TypeError(`Parameter 'biasLevel' must be >= 1 (value: ${r}); use upperBias to swap bias direction`);if(typeof e!="number"||typeof t!="number")throw new TypeError(`Parameters 'min' and 'max' must be numbers. Received min: ${e} (type: ${typeof e}), max: ${t} (type: ${typeof t})`);if(!Number.isFinite(e)||!Number.isFinite(t))throw new TypeError(`Parameters 'min' and 'max' must be finite numbers. Min value: ${e} Max value: ${t}`);if(e>=t)throw new TypeError(`Parameter 'min' must be less than 'max' (you can flip them for a valid result). Min value: ${e} Max value: ${t}`);if(typeof o!="boolean")throw new TypeError(`Parameter 'upperBias' must be a boolean, value '${o}' (type: ${typeof o}) is invalid`);let a=Math.pow(Math.random(),r);return o&&(a=1-a),e+a*(t-e)},n=i;var p=n;export{p as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bias-random",
-  "version": "1.0.3",
+  "version": "1.2.0",
   "description": "Generates biased random numbers with a customizable bias level, direction, and range",
   "author": "Reid Moffat <reid.moffat9@gmail.com>",
   "license": "MIT",
@@ -39,7 +39,8 @@
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       }
-    }
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
     "lint": "tsc",
@@ -56,25 +57,42 @@
     "README.md",
     "package.json"
   ],
+  "devDependencies": {
+    "@changesets/cli": "^2.29.8",
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.9",
+    "@types/stringify-object": "^4.0.5",
+    "chai": "^6.2.2",
+    "cross-env": "^10.1.0",
+    "generate-arrays": "^2.0.0",
+    "mocha": "^11.7.5",
+    "stringify-object": "^6.0.0",
+    "suite-metrics": "^2.5.0",
+    "test-inputs": "^1.4.0",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/reid-moffat/bias-random"
   },
+  "homepage": "https://www.npmjs.com/package/bias-random?activeTab=readme",
+  "funding": {
+    "type": "buymeacoffee",
+    "url": "https://buymeacoffee.com/reidmoffat"
+  },
   "bugs": "https://github.com/reid-moffat/bias-random/issues",
-  "devDependencies": {
-    "@changesets/cli": "^2.27.8",
-    "@types/chai": "^4.3.19",
-    "@types/mocha": "^10.0.8",
-    "@types/node": "^22.6.1",
-    "chai": "^5.1.1",
-    "cross-env": "^7.0.3",
-    "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.5.0",
-    "typescript": "^5.6.2"
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "sideEffects": false,
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "microtime"
+    ]
   },
   "packageManager": "pnpm@10.18.3"
 }