nhb-toolbox 4.29.20 → 4.29.21

package/CHANGELOG.md

@@ -4,6 +4,10 @@
 
 All notable changes to the package will be documented here.
 
+## [4.29.21] - 2026-04-05
+
+- **Updated** tsdoc for `getNumbersInRange` utility to clarify the return type based on the `getAsString` flag.
+
 ## [4.29.20] - 2026-04-03
 
 - **Updated** `isEven` and `isOdd` utilities to accept *numeric string* and return `false` for `NaN` and *non-integer* values.

package/dist/cjs/number/range.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getNumbersInRange = getNumbersInRange;
 const basics_1 = require("../array/basics");
+const primitives_1 = require("../guards/primitives");
 const index_1 = require("../utils/index");
 const basics_2 = require("./basics");
 const guards_1 = require("./guards");
@@ -27,7 +28,7 @@ function getNumbersInRange(type = 'any', options) {
         }
         return numbers;
     };
-    if (type === 'prime' && multiplesOf !== undefined) {
+    if (type === 'prime' && !(0, primitives_1.isUndefined)(multiplesOf)) {
         console.warn('Warning: The "multiplesOf" option is ignored when the type is "prime"!');
     }
     switch (type) {
@@ -58,7 +59,5 @@ function getNumbersInRange(type = 'any', options) {
     if (type !== 'prime') {
         output = (0, helpers_1._applyMultiples)(output, multiplesOf);
     }
-    return getAsString
-        ? (0, index_1.convertArrayToString)(output, { separator })
-        : output;
+    return (getAsString ? (0, index_1.convertArrayToString)(output, { separator }) : output);
 }

package/dist/dts/number/range.d.ts

@@ -1,10 +1,11 @@
 import type { NumberType, RangedNumbers, RangeOptions } from './types';
 /**
- * * Function to get numbers within a range based on the provided `NumberType` and options.
- * * Returns either a string or an array of numbers based on the `getAs` property in options.
+ * * Function to get numbers within a range based on the provided {@link NumberType} and options.
+ *
+ * @remarks Returns either string or array of numbers based on the {@link RangeOptions.getAsString getAsString} option.
  *
  * @param type - The type of numbers to generate ('random', 'prime', etc.).
  * @param options - Options to configure number generation, including range and formatting.
- * @returns Either a string or an array of numbers.
+ * @returns The numbers in the range based on {@link type} and {@link options} either as string or array of numbers.
  */
 export declare function getNumbersInRange<T extends boolean = false>(type?: NumberType, options?: RangeOptions<T>): RangedNumbers<T>;

package/dist/esm/number/range.js

@@ -1,4 +1,5 @@
 import { shuffleArray } from '../array/basics.js';
+import { isUndefined } from '../guards/primitives.js';
 import { convertArrayToString } from '../utils/index.js';
 import { getRandomNumber } from './basics.js';
 import { isEven, isOdd } from './guards.js';
@@ -24,7 +25,7 @@ export function getNumbersInRange(type = 'any', options) {
         }
         return numbers;
     };
-    if (type === 'prime' && multiplesOf !== undefined) {
+    if (type === 'prime' && !isUndefined(multiplesOf)) {
         console.warn('Warning: The "multiplesOf" option is ignored when the type is "prime"!');
     }
     switch (type) {
@@ -55,7 +56,5 @@ export function getNumbersInRange(type = 'any', options) {
     if (type !== 'prime') {
         output = _applyMultiples(output, multiplesOf);
     }
-    return getAsString
-        ? convertArrayToString(output, { separator })
-        : output;
+    return (getAsString ? convertArrayToString(output, { separator }) : output);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhb-toolbox",
-  "version": "4.29.20",
+  "version": "4.29.21",
   "description": "A versatile collection of smart, efficient, and reusable utility functions, classes and types for everyday development needs.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",