si-funciona 2.6.1 → 2.6.2

package/dist/helpers/functions.js

@@ -1,105 +1,105 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-Object.defineProperty(exports, 'callWithParams', {
-  enumerable: true,
-  get: function () {
-    return _callWithParams.default
-  }
-})
-Object.defineProperty(exports, 'curry', {
-  enumerable: true,
-  get: function () {
-    return _curry.default
-  }
-})
-exports.default = void 0
-Object.defineProperty(exports, 'delay', {
-  enumerable: true,
-  get: function () {
-    return _delay.default
-  }
-})
-Object.defineProperty(exports, 'makeBasicQueue', {
-  enumerable: true,
-  get: function () {
-    return _makeBasicQueue.default
-  }
-})
-Object.defineProperty(exports, 'onBodyLoad', {
-  enumerable: true,
-  get: function () {
-    return _onBodyLoad.default
-  }
-})
-Object.defineProperty(exports, 'pipe', {
-  enumerable: true,
-  get: function () {
-    return _pipe.default
-  }
-})
-Object.defineProperty(exports, 'preloadParams', {
-  enumerable: true,
-  get: function () {
-    return _preloadParams.default
-  }
-})
-Object.defineProperty(exports, 'queueManager', {
-  enumerable: true,
-  get: function () {
-    return _queueManager.default
-  }
-})
-Object.defineProperty(exports, 'queueTimeout', {
-  enumerable: true,
-  get: function () {
-    return _queueTimeout.default
-  }
-})
-Object.defineProperty(exports, 'relevancyFilter', {
-  enumerable: true,
-  get: function () {
-    return _relevancyFilter.default
-  }
-})
-Object.defineProperty(exports, 'trace', {
-  enumerable: true,
-  get: function () {
-    return _trace.default
-  }
-})
-var _callWithParams = _interopRequireDefault(require('./functions/callWithParams'))
-var _curry = _interopRequireDefault(require('./functions/curry'))
-var _delay = _interopRequireDefault(require('./functions/delay'))
-var _makeBasicQueue = _interopRequireDefault(require('./functions/makeBasicQueue'))
-var _onBodyLoad = _interopRequireDefault(require('./functions/onBodyLoad'))
-var _pipe = _interopRequireDefault(require('./functions/pipe'))
-var _preloadParams = _interopRequireDefault(require('./functions/preloadParams'))
-var _queueManager = _interopRequireDefault(require('./functions/queueManager'))
-var _queueTimeout = _interopRequireDefault(require('./functions/queueTimeout'))
-var _relevancyFilter = _interopRequireDefault(require('./functions/relevancyFilter'))
-var _trace = _interopRequireDefault(require('./functions/trace'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Manage how functions are called with these utilities.
- * @file
- * @author Joshua Heagle <joshuaheagle@gmail.com>
- * @version 1.0.0
- * @module functionHelpers
- * @memberOf module:siFunciona
- */
-const _default = exports.default = {
-  callWithParams: _callWithParams.default,
-  curry: _curry.default,
-  delay: _delay.default,
-  makeBasicQueue: _makeBasicQueue.default,
-  onBodyLoad: _onBodyLoad.default,
-  pipe: _pipe.default,
-  preloadParams: _preloadParams.default,
-  queueManager: _queueManager.default,
-  queueTimeout: _queueTimeout.default,
-  relevancyFilter: _relevancyFilter.default,
-  trace: _trace.default
-}
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+Object.defineProperty(exports, 'callWithParams', {
+  enumerable: true,
+  get: function () {
+    return _callWithParams.default
+  }
+})
+Object.defineProperty(exports, 'curry', {
+  enumerable: true,
+  get: function () {
+    return _curry.default
+  }
+})
+exports.default = void 0
+Object.defineProperty(exports, 'delay', {
+  enumerable: true,
+  get: function () {
+    return _delay.default
+  }
+})
+Object.defineProperty(exports, 'makeBasicQueue', {
+  enumerable: true,
+  get: function () {
+    return _makeBasicQueue.default
+  }
+})
+Object.defineProperty(exports, 'onBodyLoad', {
+  enumerable: true,
+  get: function () {
+    return _onBodyLoad.default
+  }
+})
+Object.defineProperty(exports, 'pipe', {
+  enumerable: true,
+  get: function () {
+    return _pipe.default
+  }
+})
+Object.defineProperty(exports, 'preloadParams', {
+  enumerable: true,
+  get: function () {
+    return _preloadParams.default
+  }
+})
+Object.defineProperty(exports, 'queueManager', {
+  enumerable: true,
+  get: function () {
+    return _queueManager.default
+  }
+})
+Object.defineProperty(exports, 'queueTimeout', {
+  enumerable: true,
+  get: function () {
+    return _queueTimeout.default
+  }
+})
+Object.defineProperty(exports, 'relevancyFilter', {
+  enumerable: true,
+  get: function () {
+    return _relevancyFilter.default
+  }
+})
+Object.defineProperty(exports, 'trace', {
+  enumerable: true,
+  get: function () {
+    return _trace.default
+  }
+})
+var _callWithParams = _interopRequireDefault(require('./functions/callWithParams'))
+var _curry = _interopRequireDefault(require('./functions/curry'))
+var _delay = _interopRequireDefault(require('./functions/delay'))
+var _makeBasicQueue = _interopRequireDefault(require('./functions/makeBasicQueue'))
+var _onBodyLoad = _interopRequireDefault(require('./functions/onBodyLoad'))
+var _pipe = _interopRequireDefault(require('./functions/pipe'))
+var _preloadParams = _interopRequireDefault(require('./functions/preloadParams'))
+var _queueManager = _interopRequireDefault(require('./functions/queueManager'))
+var _queueTimeout = _interopRequireDefault(require('./functions/queueTimeout'))
+var _relevancyFilter = _interopRequireDefault(require('./functions/relevancyFilter'))
+var _trace = _interopRequireDefault(require('./functions/trace'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Manage how functions are called with these utilities.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 1.0.0
+ * @module functionHelpers
+ * @memberOf module:siFunciona
+ */
+const _default = exports.default = {
+  callWithParams: _callWithParams.default,
+  curry: _curry.default,
+  delay: _delay.default,
+  makeBasicQueue: _makeBasicQueue.default,
+  onBodyLoad: _onBodyLoad.default,
+  pipe: _pipe.default,
+  preloadParams: _preloadParams.default,
+  queueManager: _queueManager.default,
+  queueTimeout: _queueTimeout.default,
+  relevancyFilter: _relevancyFilter.default,
+  trace: _trace.default
+}

package/dist/helpers/numbers/absoluteMax.d.ts

@@ -1,10 +1,10 @@
-/**
- * Helper for returning the absolute max value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-declare const absoluteMax: (num1: number, num2: number) => number;
-export default absoluteMax;
+/**
+ * Helper for returning the absolute max value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+declare const absoluteMax: (num1: number, num2: number) => number;
+export default absoluteMax;
 //# sourceMappingURL=absoluteMax.d.ts.map

package/dist/helpers/numbers/absoluteMax.js

@@ -1,15 +1,15 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-/**
- * Helper for returning the absolute max value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-const absoluteMax = (num1, num2) => Math.abs(num1) > Math.abs(num2) ? num1 : num2
-const _default = exports.default = absoluteMax
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+/**
+ * Helper for returning the absolute max value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+const absoluteMax = (num1, num2) => Math.abs(num1) > Math.abs(num2) ? num1 : num2
+const _default = exports.default = absoluteMax

package/dist/helpers/numbers/absoluteMin.d.ts

@@ -1,10 +1,10 @@
-/**
- * Helper for returning the absolute min value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-declare const absoluteMin: (num1: number, num2: number) => number;
-export default absoluteMin;
+/**
+ * Helper for returning the absolute min value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+declare const absoluteMin: (num1: number, num2: number) => number;
+export default absoluteMin;
 //# sourceMappingURL=absoluteMin.d.ts.map

package/dist/helpers/numbers/absoluteMin.js

@@ -1,15 +1,15 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-/**
- * Helper for returning the absolute min value
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-const absoluteMin = (num1, num2) => Math.abs(num1) < Math.abs(num2) ? num1 : num2
-const _default = exports.default = absoluteMin
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+/**
+ * Helper for returning the absolute min value
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+const absoluteMin = (num1, num2) => Math.abs(num1) < Math.abs(num2) ? num1 : num2
+const _default = exports.default = absoluteMin

package/dist/helpers/numbers/compare.d.ts

@@ -1,13 +1,13 @@
-/**
- * Compare two numbers and return:
- * -1 to indicate val1 is less than val2
- * 0 to indicate both values are the equal
- * 1 to indicate val1 is greater than val2
- * @memberOf module:numberHelpers
- * @param {number} val1 - The first number to compare
- * @param {number} val2 - The second number to compare
- * @returns {number}
- */
-declare const compare: (val1: number, val2: number) => number;
-export default compare;
+/**
+ * Compare two numbers and return:
+ * -1 to indicate val1 is less than val2
+ * 0 to indicate both values are the equal
+ * 1 to indicate val1 is greater than val2
+ * @memberOf module:numberHelpers
+ * @param {number} val1 - The first number to compare
+ * @param {number} val2 - The second number to compare
+ * @returns {number}
+ */
+declare const compare: (val1: number, val2: number) => number;
+export default compare;
 //# sourceMappingURL=compare.d.ts.map

package/dist/helpers/numbers/compare.js

@@ -1,18 +1,18 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-/**
- * Compare two numbers and return:
- * -1 to indicate val1 is less than val2
- * 0 to indicate both values are the equal
- * 1 to indicate val1 is greater than val2
- * @memberOf module:numberHelpers
- * @param {number} val1 - The first number to compare
- * @param {number} val2 - The second number to compare
- * @returns {number}
- */
-const compare = (val1, val2) => val1 === val2 ? 0 : val1 > val2 ? 1 : -1
-const _default = exports.default = compare
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+/**
+ * Compare two numbers and return:
+ * -1 to indicate val1 is less than val2
+ * 0 to indicate both values are the equal
+ * 1 to indicate val1 is greater than val2
+ * @memberOf module:numberHelpers
+ * @param {number} val1 - The first number to compare
+ * @param {number} val2 - The second number to compare
+ * @returns {number}
+ */
+const compare = (val1, val2) => val1 === val2 ? 0 : val1 > val2 ? 1 : -1
+const _default = exports.default = compare

package/dist/helpers/numbers/greatestCommonDivisor.d.ts

@@ -1,10 +1,10 @@
-/**
- * Return the highest number that can be divided into both numbers.
- * @memberOf module:numberHelpers
- * @param {number} num1 - First number to assess
- * @param {number} num2 - Second number to compare for common divisor
- * @returns {number}
- */
-declare const greatestCommonDivisor: (num1: number, num2: number) => number;
-export default greatestCommonDivisor;
+/**
+ * Return the highest number that can be divided into both numbers.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - First number to assess
+ * @param {number} num2 - Second number to compare for common divisor
+ * @returns {number}
+ */
+declare const greatestCommonDivisor: (num1: number, num2: number) => number;
+export default greatestCommonDivisor;
 //# sourceMappingURL=greatestCommonDivisor.d.ts.map

package/dist/helpers/numbers/greatestCommonDivisor.js

@@ -1,15 +1,15 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-/**
- * Return the highest number that can be divided into both numbers.
- * @memberOf module:numberHelpers
- * @param {number} num1 - First number to assess
- * @param {number} num2 - Second number to compare for common divisor
- * @returns {number}
- */
-const greatestCommonDivisor = (num1, num2) => num2 === 0 ? num1 : greatestCommonDivisor(num2, num1 % num2)
-const _default = exports.default = greatestCommonDivisor
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+/**
+ * Return the highest number that can be divided into both numbers.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - First number to assess
+ * @param {number} num2 - Second number to compare for common divisor
+ * @returns {number}
+ */
+const greatestCommonDivisor = (num1, num2) => num2 === 0 ? num1 : greatestCommonDivisor(num2, num1 % num2)
+const _default = exports.default = greatestCommonDivisor

package/dist/helpers/numbers/leastCommonMultiple.d.ts

@@ -1,10 +1,10 @@
-/**
- * Helper for calculating the multiplier that would make each number relative to each other.
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-declare const leastCommonMultiple: (num1: number, num2: number) => number;
-export default leastCommonMultiple;
+/**
+ * Helper for calculating the multiplier that would make each number relative to each other.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+declare const leastCommonMultiple: (num1: number, num2: number) => number;
+export default leastCommonMultiple;
 //# sourceMappingURL=leastCommonMultiple.d.ts.map

package/dist/helpers/numbers/leastCommonMultiple.js

@@ -1,17 +1,17 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-const _greatestCommonDivisor = _interopRequireDefault(require('./greatestCommonDivisor'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Helper for calculating the multiplier that would make each number relative to each other.
- * @memberOf module:numberHelpers
- * @param {number} num1 - A number to compare
- * @param {number} num2 - Another number to be compared against
- * @returns {number}
- */
-const leastCommonMultiple = (num1, num2) => num1 === 0 || num2 === 0 ? 0 : num1 * num2 / (0, _greatestCommonDivisor.default)(num1, num2)
-const _default = exports.default = leastCommonMultiple
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+const _greatestCommonDivisor = _interopRequireDefault(require('./greatestCommonDivisor'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Helper for calculating the multiplier that would make each number relative to each other.
+ * @memberOf module:numberHelpers
+ * @param {number} num1 - A number to compare
+ * @param {number} num2 - Another number to be compared against
+ * @returns {number}
+ */
+const leastCommonMultiple = (num1, num2) => num1 === 0 || num2 === 0 ? 0 : num1 * num2 / (0, _greatestCommonDivisor.default)(num1, num2)
+const _default = exports.default = leastCommonMultiple

package/dist/helpers/numbers/lowestCommonDenominator.d.ts

@@ -1,10 +1,10 @@
-/**
- * Find the smallest number that all the given numbers divide into evenly, by reducing them pairwise with
- * leastCommonMultiple.
- * @memberOf module:numberHelpers
- * @param {...number} numbers - Two or more numbers to find the lowest common denominator of.
- * @returns {number}
- */
-declare const lowestCommonDenominator: (...numbers: number[]) => number;
-export default lowestCommonDenominator;
+/**
+ * Find the smallest number that all the given numbers divide into evenly, by reducing them pairwise with
+ * leastCommonMultiple.
+ * @memberOf module:numberHelpers
+ * @param {...number} numbers - Two or more numbers to find the lowest common denominator of.
+ * @returns {number}
+ */
+declare const lowestCommonDenominator: (...numbers: number[]) => number;
+export default lowestCommonDenominator;
 //# sourceMappingURL=lowestCommonDenominator.d.ts.map

package/dist/helpers/numbers/lowestCommonDenominator.js

@@ -1,19 +1,19 @@
-'use strict'
-
-Object.defineProperty(exports, '__esModule', {
-  value: true
-})
-exports.default = void 0
-require('core-js/modules/esnext.iterator.constructor.js')
-require('core-js/modules/esnext.iterator.reduce.js')
-const _leastCommonMultiple = _interopRequireDefault(require('./leastCommonMultiple'))
-function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
-/**
- * Find the smallest number that all the given numbers divide into evenly, by reducing them pairwise with
- * leastCommonMultiple.
- * @memberOf module:numberHelpers
- * @param {...number} numbers - Two or more numbers to find the lowest common denominator of.
- * @returns {number}
- */
-const lowestCommonDenominator = (...numbers) => numbers.reduce((num1, num2) => (0, _leastCommonMultiple.default)(num1, num2), 1)
-const _default = exports.default = lowestCommonDenominator
+'use strict'
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+})
+exports.default = void 0
+require('core-js/modules/esnext.iterator.constructor.js')
+require('core-js/modules/esnext.iterator.reduce.js')
+const _leastCommonMultiple = _interopRequireDefault(require('./leastCommonMultiple'))
+function _interopRequireDefault (e) { return e && e.__esModule ? e : { default: e } }
+/**
+ * Find the smallest number that all the given numbers divide into evenly, by reducing them pairwise with
+ * leastCommonMultiple.
+ * @memberOf module:numberHelpers
+ * @param {...number} numbers - Two or more numbers to find the lowest common denominator of.
+ * @returns {number}
+ */
+const lowestCommonDenominator = (...numbers) => numbers.reduce((num1, num2) => (0, _leastCommonMultiple.default)(num1, num2), 1)
+const _default = exports.default = lowestCommonDenominator

package/dist/helpers/numbers/randomInteger.d.ts

@@ -1,11 +1,17 @@
 /**
- * Create a single random integer within provide range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
+ * Create a single random integer from a set of `range` possible values, starting at the optional offset.
+ * With no offset the result is 0 to range - 1 (so range is the number of possible values, the same as an array length
+ * when choosing an index). The distance between the result numbers can be adjusted with interval.
+ * @example
+ * randomInteger(1) // always 0 (one possible value)
+ * randomInteger(2) // 0 or 1
+ * randomInteger(3, 1, 5) // 5, 10 or 15
+ * items[randomInteger(items.length)] // a random valid index
  * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
+ * @param {number} range - The number of possible values (0-99 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 10 for range)
  * @param {number} [interval=1] - Choose the distance between numbers (5, 10, 15 would be 5 for interval, 1 for
- * offset, 2 for range)
+ * offset, 3 for range)
  * @returns {number}
  */
 declare const randomInteger: (range: number, offset?: number, interval?: number) => number;

package/dist/helpers/numbers/randomInteger.js

@@ -5,13 +5,19 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 /**
- * Create a single random integer within provide range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
+ * Create a single random integer from a set of `range` possible values, starting at the optional offset.
+ * With no offset the result is 0 to range - 1 (so range is the number of possible values, the same as an array length
+ * when choosing an index). The distance between the result numbers can be adjusted with interval.
+ * @example
+ * randomInteger(1) // always 0 (one possible value)
+ * randomInteger(2) // 0 or 1
+ * randomInteger(3, 1, 5) // 5, 10 or 15
+ * items[randomInteger(items.length)] // a random valid index
  * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
+ * @param {number} range - The number of possible values (0-99 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 10 for range)
  * @param {number} [interval=1] - Choose the distance between numbers (5, 10, 15 would be 5 for interval, 1 for
- * offset, 2 for range)
+ * offset, 3 for range)
  * @returns {number}
  */
 const randomInteger = (range, offset = 0, interval = 1) => (Math.floor(Math.random() * range) + offset) * interval

package/dist/helpers/numbers/randomNumber.d.ts

@@ -1,11 +1,12 @@
 /**
- * Create a single random number within provided range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
+ * Create a single random number from offset up to (but never including) offset + range. With optional offset,
+ * the distance between the result numbers can be adjusted with interval. Matches randomInteger, which gives the
+ * whole numbers of the same span.
  * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
- * @param {number} [interval=1] - Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for
- * offset, 2 for range)
+ * @param {number} range - Choose the breadth of the random number (0 up to, but not including, 100 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1 up to, but not including, 10 would be 1 for offset, 9 for range)
+ * @param {number} [interval=1] - Choose the multiplier applied to the result (~5, ~10, ~15 would be 5 for interval,
+ * 1 for offset, 2 for range)
  * @returns {number}
  */
 declare const randomNumber: (range: number, offset?: number, interval?: number) => number;

package/dist/helpers/numbers/randomNumber.js

@@ -5,13 +5,14 @@ Object.defineProperty(exports, '__esModule', {
 })
 exports.default = void 0
 /**
- * Create a single random number within provided range. And with optional offset,
- * The distance between the result numbers can be adjusted with interval.
+ * Create a single random number from offset up to (but never including) offset + range. With optional offset,
+ * the distance between the result numbers can be adjusted with interval. Matches randomInteger, which gives the
+ * whole numbers of the same span.
  * @memberOf module:numberHelpers
- * @param {number} range - Choose the breadth of the random number (0-100 would be 100 for range)
- * @param {number} [offset=0] - Choose the starting number (1-10 would be 1 for offset, 9 for range)
- * @param {number} [interval=1] - Choose the distance between numbers (~5, ~10, ~15 would be 5 for interval, 1 for
- * offset, 2 for range)
+ * @param {number} range - Choose the breadth of the random number (0 up to, but not including, 100 would be 100 for range)
+ * @param {number} [offset=0] - Choose the starting number (1 up to, but not including, 10 would be 1 for offset, 9 for range)
+ * @param {number} [interval=1] - Choose the multiplier applied to the result (~5, ~10, ~15 would be 5 for interval,
+ * 1 for offset, 2 for range)
  * @returns {number}
  */
 const randomNumber = (range, offset = 0, interval = 1) => (Math.random() * range + offset) * interval