bias-random 1.0.3 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # bias-random
 
+## 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/README.md

@@ -7,19 +7,17 @@
 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 +31,38 @@ 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 });
 ```
+
+## 🌐 CDN Usage
+
+You can also use bias-random directly in the browser via CDN:
+```html
+<!-- Using unpkg -->
+<script src="https://unpkg.com/bias-random"></script>
+
+<!-- Using jsdelivr -->
+<script src="https://cdn.jsdelivr.net/npm/bias-random"></script>
+
+<!-- Specify version (recommended for production) -->
+<script src="https://unpkg.com/bias-random@1.1.0"></script>
+<script src="https://cdn.jsdelivr.net/npm/bias-random@1.1.0"></script>
+```
+
+When loaded via CDN, the library is available as the global variable `biasRandom`:
+```html
+<script>
+  const result = biasRandom();
+  console.log(result);
+</script>
+```
+
+## 📃 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 u=Object.getOwnPropertyDescriptor;var s=Object.getOwnPropertyNames;var m=Object.prototype.hasOwnProperty;var i=(a,e)=>{for(var r in e)n(a,r,{get:e[r],enumerable:!0})},p=(a,e,r,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let o of s(e))!m.call(a,o)&&o!==r&&n(a,o,{get:()=>e[o],enumerable:!(t=u(e,o))||t.enumerable});return a};var b=a=>p(n({},"__esModule",{value:!0}),a);var f={};i(f,{default:()=>d});module.exports=b(f);var l=({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' must 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)},d=l;

package/dist/index.d.cts

@@ -1,9 +1,18 @@
-interface BiasedRandomOptions {
+/**
+ * Options object to customize the biased random generated result.
+ *
+ * The whole object as well as every field is optional.
+ */
+type BiasedRandomOptions = {
+    /** Bias towards the higher number if true, otherwise lower */
     upperBias?: boolean;
+    /** Bias factor, must be 1 or greater, default is 2 (1 is no bias) */
     biasLevel?: number;
+    /** Minimum value, default is 0 */
     min?: number;
+    /** Maximum value, default is 1 */
     max?: number;
-}
+};
 /**
  * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound.
  *
@@ -19,6 +28,6 @@ interface BiasedRandomOptions {
  * @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 };

package/dist/index.d.ts

@@ -1,9 +1,18 @@
-interface BiasedRandomOptions {
+/**
+ * Options object to customize the biased random generated result.
+ *
+ * The whole object as well as every field is optional.
+ */
+type BiasedRandomOptions = {
+    /** Bias towards the higher number if true, otherwise lower */
     upperBias?: boolean;
+    /** Bias factor, must be 1 or greater, default is 2 (1 is no bias) */
     biasLevel?: number;
+    /** Minimum value, default is 0 */
     min?: number;
+    /** Maximum value, default is 1 */
     max?: number;
-}
+};
 /**
  * Generates a random number between `min` and `max`, with an optional bias towards the lower or upper bound.
  *
@@ -19,6 +28,6 @@ interface BiasedRandomOptions {
  * @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 };

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 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' must 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};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bias-random",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "Generates biased random numbers with a customizable bias level, direction, and range",
   "author": "Reid Moffat <reid.moffat9@gmail.com>",
   "license": "MIT",
@@ -28,6 +28,8 @@
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "unpkg": "dist/index.js",
+  "jsdelivr": "dist/index.js",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -39,7 +41,8 @@
         "types": "./dist/index.d.cts",
         "default": "./dist/index.cjs"
       }
-    }
+    },
+    "./package.json": "./package.json"
   },
   "scripts": {
     "lint": "tsc",
@@ -56,25 +59,40 @@
     "README.md",
     "package.json"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/reid-moffat/bias-random"
-  },
-  "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",
+    "@changesets/cli": "^2.29.7",
+    "@types/chai": "^5.2.3",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24.9.1",
+    "chai": "^6.2.0",
+    "cross-env": "^10.1.0",
     "generate-arrays": "^2.0.0",
-    "mocha": "^10.7.3",
-    "suite-metrics": "^1.3.1",
+    "mocha": "^11.7.4",
+    "suite-metrics": "^2.4.0",
     "test-inputs": "^1.3.0",
     "ts-node": "^10.9.2",
     "tsup": "^8.5.0",
-    "typescript": "^5.6.2"
+    "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",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "sideEffects": false,
+  "pnpm": {
+    "onlyBuiltDependencies": [
+      "esbuild",
+      "microtime"
+    ]
   },
   "packageManager": "pnpm@10.18.3"
 }