@alextheman/utility 5.14.0 → 5.15.1

package/dist/index.cjs

@@ -133,6 +133,21 @@ var CodeError = class CodeError extends Error {
 		throw error;
 	}
 	/**
+	* Check a `CodeError` against its error code
+	*
+	* This will also automatically narrow down the type of the input to be `CodeError`, with its error code properly typed if this function returns true.
+	*
+	* @template ErrorCode The type of the error code
+	*
+	* @param input - The input to check.
+	* @param code - The expected code of the resulting error.
+	*
+	* @returns `true` if the error code matches the expected code, and `false` otherwise. The type of the input will also be narrowed down to CodeError, and its code will be narrowed to the expected code's type if the function returns `true`.
+	*/
+	static checkWithCode(input, code) {
+		return this.check(input) && input.code === code;
+	}
+	/**
 	* Gets the thrown `CodeError` from a given function if one was thrown, and re-throws any other errors, or throws a default `CodeError` if no error thrown.
 	*
 	* @param errorFunction - The function expected to throw the error.
@@ -188,11 +203,10 @@ var DataError$1 = class DataError$1 extends CodeError {
 	* @param message  - A human-readable error message (e.g. The data provided is invalid).
 	* @param options - Extra options to pass to super Error constructor.
 	*/
-	constructor(data, code = "INVALID_DATA", message = "The data provided is invalid", options) {
+	constructor(data, code, message = "The data provided is invalid", options) {
 		super(code, message, options);
 		if (Error.captureStackTrace) Error.captureStackTrace(this, new.target);
 		this.name = new.target.name;
-		this.code = code;
 		this.data = data;
 		Object.defineProperty(this, "message", { enumerable: true });
 		Object.setPrototypeOf(this, new.target.prototype);
@@ -209,6 +223,21 @@ var DataError$1 = class DataError$1 extends CodeError {
 		return typeof input === "object" && input !== null && "message" in input && typeof input.message === "string" && "code" in input && typeof input.code === "string" && "data" in input;
 	}
 	/**
+	* Check a `DataError` against its error code
+	*
+	* This will also automatically narrow down the type of the input to be `DataError`, with its error code properly typed if this function returns true.
+	*
+	* @template ErrorCode The type of the error code
+	*
+	* @param input - The input to check.
+	* @param code - The expected code of the resulting error.
+	*
+	* @returns `true` if the error code matches the expected code, and `false` otherwise. The type of the input will also be narrowed down to `DataError`, and its code will be narrowed to the expected code's type if the function returns `true`.
+	*/
+	static checkWithCode(input, code) {
+		return this.check(input) && input.code === code;
+	}
+	/**
 	* Gets the thrown `DataError` from a given function if one was thrown, and re-throws any other errors, or throws a default `DataError` if no error thrown.
 	*
 	* @param errorFunction - The function expected to throw the error.
@@ -1801,6 +1830,22 @@ var DataError = class DataError extends Error {
 	}
 };
 //#endregion
+//#region src/root/errors/assertNotNull.ts
+/**
+* Asserts that a given input is not `null`, and throws a DataError if it does.
+*
+* If no error is thrown from this, the input type gets narrowed down to not include `null`.
+*
+* @template InputType The type of the input.
+*
+* @param input - The input to assert against
+*
+* @throws {DataError} If the input is `null`.
+*/
+function assertNotNull(input) {
+	if (input === null) throw new DataError$1({ input }, "NULL_INPUT", "Expected the input not to be null");
+}
+//#endregion
 exports.APIError = APIError;
 exports.DataError = DataError;
 exports.Env = Env;
@@ -1815,6 +1860,7 @@ exports.VersionNumber = VersionNumber;
 exports.VersionType = VersionType;
 exports.addDaysToDate = addDaysToDate;
 exports.appendSemicolon = appendSemicolon;
+exports.assertNotNull = assertNotNull;
 exports.az = az;
 exports.calculateMonthlyDifference = calculateMonthlyDifference;
 exports.camelToKebab = camelToKebab;