@alextheman/utility 4.3.3 → 4.3.5

package/dist/index.cjs

@@ -49,7 +49,7 @@ var VERSION_NUMBER_REGEX_default = VERSION_NUMBER_REGEX;
 *
 * @category Array Helpers
 *
-* @template ItemType
+* @template ItemType - The return type of the callback (awaited if any items are a Promise) that becomes the type of the array items.
 *
 * @param callback - A function invoked with the current index. May return a value or a Promise.
 * @param length - The desired length of the resulting array.
@@ -244,7 +244,7 @@ var VersionNumber = class VersionNumber {
 		return firstVersion.major === secondVersion.major && firstVersion.minor === secondVersion.minor && firstVersion.patch === secondVersion.patch;
 	}
 	/**
-	* Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+	* Increments the current version number by the given increment type, returning the result as a new reference in memory.
 	*
 	* @param incrementType - The type of increment. Can be one of the following:
 	* - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -273,6 +273,25 @@ var VersionNumber = class VersionNumber {
 		}[incrementType];
 	}
 	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+	*
+	* @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	[Symbol.toPrimitive](hint) {
+		if (hint === "number") throw new DataError_default(this.toString(), "INVALID_COERCION", "VersionNumber cannot be coerced to a number type.");
+		return this.toString();
+	}
+	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	toJSON() {
+		return this.toString();
+	}
+	/**
 	* Get a string representation of the current version number.
 	*
 	* @param options - Extra additional options to apply.

package/dist/index.d.cts

@@ -13,7 +13,7 @@ declare const VERSION_NUMBER_REGEX: string;
  * The callback will be invoked once for each index from `0` to `length - 1`.
  * If no length is provided, a single-element array will be produced.
  *
- * @template ItemType
+ * @template ItemType - The awaited return type of the callback that becomes the type of the array items.
  *
  * @param callback - An asynchronous function invoked with the current index.
  * @param length - The desired length of the resulting array.
@@ -27,7 +27,7 @@ declare function fillArray<ItemType>(callback: (index: number) => Promise<ItemTy
  * The callback will be invoked once for each index from `0` to `length - 1`.
  * If no length is provided, a single-element array will be produced.
  *
- * @template ItemType
+ * @template ItemType - The return type of the callback that becomes the type of the array items.
  *
  * @param callback - A synchronous function invoked with the current index.
  * @param length - The desired length of the resulting array.
@@ -296,7 +296,7 @@ declare class VersionNumber {
    */
   static isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean;
   /**
-   * Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+   * Increments the current version number by the given increment type, returning the result as a new reference in memory.
    *
    * @param incrementType - The type of increment. Can be one of the following:
    * - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -306,6 +306,20 @@ declare class VersionNumber {
    * @returns A new instance of `VersionNumber` with the increment applied.
    */
   increment(incrementType: VersionType): VersionNumber;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+   *
+   * @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  [Symbol.toPrimitive](hint: "default" | "string" | "number"): string;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  toJSON(): string;
   /**
    * Get a string representation of the current version number.
    *

package/dist/index.d.ts

@@ -13,7 +13,7 @@ declare const VERSION_NUMBER_REGEX: string;
  * The callback will be invoked once for each index from `0` to `length - 1`.
  * If no length is provided, a single-element array will be produced.
  *
- * @template ItemType
+ * @template ItemType - The awaited return type of the callback that becomes the type of the array items.
  *
  * @param callback - An asynchronous function invoked with the current index.
  * @param length - The desired length of the resulting array.
@@ -27,7 +27,7 @@ declare function fillArray<ItemType>(callback: (index: number) => Promise<ItemTy
  * The callback will be invoked once for each index from `0` to `length - 1`.
  * If no length is provided, a single-element array will be produced.
  *
- * @template ItemType
+ * @template ItemType - The return type of the callback that becomes the type of the array items.
  *
  * @param callback - A synchronous function invoked with the current index.
  * @param length - The desired length of the resulting array.
@@ -296,7 +296,7 @@ declare class VersionNumber {
    */
   static isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean;
   /**
-   * Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+   * Increments the current version number by the given increment type, returning the result as a new reference in memory.
    *
    * @param incrementType - The type of increment. Can be one of the following:
    * - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -306,6 +306,20 @@ declare class VersionNumber {
    * @returns A new instance of `VersionNumber` with the increment applied.
    */
   increment(incrementType: VersionType): VersionNumber;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+   *
+   * @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  [Symbol.toPrimitive](hint: "default" | "string" | "number"): string;
+  /**
+   * Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+   *
+   * @returns A stringified representation of the current version number, prefixed with `v`.
+   */
+  toJSON(): string;
   /**
    * Get a string representation of the current version number.
    *

package/dist/index.js

@@ -20,7 +20,7 @@ var VERSION_NUMBER_REGEX_default = VERSION_NUMBER_REGEX;
 *
 * @category Array Helpers
 *
-* @template ItemType
+* @template ItemType - The return type of the callback (awaited if any items are a Promise) that becomes the type of the array items.
 *
 * @param callback - A function invoked with the current index. May return a value or a Promise.
 * @param length - The desired length of the resulting array.
@@ -215,7 +215,7 @@ var VersionNumber = class VersionNumber {
 		return firstVersion.major === secondVersion.major && firstVersion.minor === secondVersion.minor && firstVersion.patch === secondVersion.patch;
 	}
 	/**
-	* Determines whether the current instance of `VersionNumber` is a major, minor, or patch version.
+	* Increments the current version number by the given increment type, returning the result as a new reference in memory.
 	*
 	* @param incrementType - The type of increment. Can be one of the following:
 	* - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
@@ -244,6 +244,25 @@ var VersionNumber = class VersionNumber {
 		}[incrementType];
 	}
 	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
+	*
+	* @param hint - Not used as of now, but generally used to help with numeric coercion, I think (which we most likely do not need for version numbers).
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	[Symbol.toPrimitive](hint) {
+		if (hint === "number") throw new DataError_default(this.toString(), "INVALID_COERCION", "VersionNumber cannot be coerced to a number type.");
+		return this.toString();
+	}
+	/**
+	* Ensures that the VersionNumber behaves correctly when attempted to be converted to JSON.
+	*
+	* @returns A stringified representation of the current version number, prefixed with `v`.
+	*/
+	toJSON() {
+		return this.toString();
+	}
+	/**
 	* Get a string representation of the current version number.
 	*
 	* @param options - Extra additional options to apply.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "4.3.3",
+  "version": "4.3.5",
   "description": "Helpful utility functions",
   "repository": {
     "type": "git",