@alextheman/utility 4.16.2 → 4.17.0

package/dist/index.cjs

@@ -253,27 +253,39 @@ var VersionNumber = class VersionNumber {
 	* - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
 	* - `"minor"`: Change the minor version `v1.2.3` → `v1.3.0`
 	* - `"patch"`: Change the patch version `v1.2.3` → `v1.2.4`
+	* @param incrementAmount - The amount to increment by (defaults to 1).
 	*
 	* @returns A new instance of `VersionNumber` with the increment applied.
 	*/
-	increment(incrementType) {
-		return {
-			major: new VersionNumber([
-				this.major + 1,
+	increment(incrementType, incrementAmount = 1) {
+		const incrementBy = parseIntStrict(String(incrementAmount));
+		const calculatedRawVersion = {
+			major: [
+				this.major + incrementBy,
 				0,
 				0
-			]),
-			minor: new VersionNumber([
+			],
+			minor: [
 				this.major,
-				this.minor + 1,
+				this.minor + incrementBy,
 				0
-			]),
-			patch: new VersionNumber([
+			],
+			patch: [
 				this.major,
 				this.minor,
-				this.patch + 1
-			])
+				this.patch + incrementBy
+			]
 		}[incrementType];
+		try {
+			return new VersionNumber(calculatedRawVersion);
+		} catch (error) {
+			if (DataError.check(error) && error.code === "NEGATIVE_INPUTS") throw new DataError({
+				currentVersion: this.toString(),
+				calculatedRawVersion: `v${calculatedRawVersion.join(".")}`,
+				incrementAmount
+			}, "NEGATIVE_VERSION", "Cannot apply this increment amount as it would lead to a negative version number.");
+			else throw error;
+		}
 	}
 	/**
 	* Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.

package/dist/index.d.cts

@@ -307,10 +307,11 @@ declare class VersionNumber {
    * - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
    * - `"minor"`: Change the minor version `v1.2.3` → `v1.3.0`
    * - `"patch"`: Change the patch version `v1.2.3` → `v1.2.4`
+   * @param incrementAmount - The amount to increment by (defaults to 1).
    *
    * @returns A new instance of `VersionNumber` with the increment applied.
    */
-  increment(incrementType: VersionType): VersionNumber;
+  increment(incrementType: VersionType, incrementAmount?: number): VersionNumber;
   /**
    * Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
    *

package/dist/index.d.ts

@@ -307,10 +307,11 @@ declare class VersionNumber {
    * - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
    * - `"minor"`: Change the minor version `v1.2.3` → `v1.3.0`
    * - `"patch"`: Change the patch version `v1.2.3` → `v1.2.4`
+   * @param incrementAmount - The amount to increment by (defaults to 1).
    *
    * @returns A new instance of `VersionNumber` with the increment applied.
    */
-  increment(incrementType: VersionType): VersionNumber;
+  increment(incrementType: VersionType, incrementAmount?: number): VersionNumber;
   /**
    * Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.
    *

package/dist/index.js

@@ -222,27 +222,39 @@ var VersionNumber = class VersionNumber {
 	* - `"major"`: Change the major version `v1.2.3` → `v2.0.0`
 	* - `"minor"`: Change the minor version `v1.2.3` → `v1.3.0`
 	* - `"patch"`: Change the patch version `v1.2.3` → `v1.2.4`
+	* @param incrementAmount - The amount to increment by (defaults to 1).
 	*
 	* @returns A new instance of `VersionNumber` with the increment applied.
 	*/
-	increment(incrementType) {
-		return {
-			major: new VersionNumber([
-				this.major + 1,
+	increment(incrementType, incrementAmount = 1) {
+		const incrementBy = parseIntStrict(String(incrementAmount));
+		const calculatedRawVersion = {
+			major: [
+				this.major + incrementBy,
 				0,
 				0
-			]),
-			minor: new VersionNumber([
+			],
+			minor: [
 				this.major,
-				this.minor + 1,
+				this.minor + incrementBy,
 				0
-			]),
-			patch: new VersionNumber([
+			],
+			patch: [
 				this.major,
 				this.minor,
-				this.patch + 1
-			])
+				this.patch + incrementBy
+			]
 		}[incrementType];
+		try {
+			return new VersionNumber(calculatedRawVersion);
+		} catch (error) {
+			if (DataError.check(error) && error.code === "NEGATIVE_INPUTS") throw new DataError({
+				currentVersion: this.toString(),
+				calculatedRawVersion: `v${calculatedRawVersion.join(".")}`,
+				incrementAmount
+			}, "NEGATIVE_VERSION", "Cannot apply this increment amount as it would lead to a negative version number.");
+			else throw error;
+		}
 	}
 	/**
 	* Ensures that the VersionNumber behaves correctly when attempted to be coerced to a string.

package/package.json

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