bias-random 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # bias-random
 
+## 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.2",
   "description": "Generates biased random numbers with a customizable bias level, direction, and range",
   "author": "Reid Moffat <reid.moffat9@gmail.com>",
   "license": "MIT",