@alextheman/utility 5.14.0 → 5.15.1

package/dist/v6/index.d.cts

@@ -1,5 +1,5 @@
 //#region src/v6/CodeError.d.ts
-interface ExpectErrorOptions$1<ErrorCode extends string = string> {
+interface ExpectErrorOptions<ErrorCode extends string = string> {
   expectedCode?: ErrorCode;
 }
 /**
@@ -24,8 +24,21 @@ declare class CodeError<ErrorCode extends string = string> extends Error {
    *
    * @returns `true` if the input is a CodeError, and `false` otherwise. The type of the input will also be narrowed down to CodeError if `true`.
    */
-  static check(input: unknown): input is CodeError<string>;
-  protected static checkCaughtError<ErrorCode extends string = string>(this: typeof CodeError, error: unknown, options?: ExpectErrorOptions$1<ErrorCode>): CodeError;
+  static check<ErrorCode extends string = string>(input: unknown): input is CodeError<ErrorCode>;
+  protected static checkCaughtError<ErrorCode extends string = string>(this: typeof CodeError, error: unknown, options?: ExpectErrorOptions<ErrorCode>): CodeError<ErrorCode>;
+  /**
+   * 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<ErrorCode extends string = string>(input: unknown, code: ErrorCode): input is CodeError<ErrorCode>;
   /**
    * 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.
    *
@@ -37,7 +50,7 @@ declare class CodeError<ErrorCode extends string = string> extends Error {
    *
    * @returns The `CodeError` that was thrown by the `errorFunction`
    */
-  static expectError<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => unknown, options?: ExpectErrorOptions$1<ErrorCode>): CodeError;
+  static expectError<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): CodeError<ErrorCode>;
   /**
    * Gets the thrown `CodeError` from a given asynchronous function if one was thrown, and re-throws any other errors, or throws a default `CodeError` if no error thrown.
    *
@@ -49,31 +62,10 @@ declare class CodeError<ErrorCode extends string = string> extends Error {
    *
    * @returns The `CodeError` that was thrown by the `errorFunction`
    */
-  static expectErrorAsync<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$1<ErrorCode>): Promise<CodeError>;
+  static expectErrorAsync<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<CodeError>;
 }
 //#endregion
-//#region src/root/types/CreateEnumType.d.ts
-/**
- * Get the value types from a const object so the object can behave similarly to an enum.
- *
- * @category Types
- *
- * @template ObjectType - The type of the object to get the value types for.
- */
-type CreateEnumType<ObjectType extends Record<PropertyKey, unknown>> = ObjectType[keyof ObjectType];
-//#endregion
-//#region src/root/types/IsTypeArgumentString.d.ts
-type IsTypeArgumentString<Argument extends string> = Argument;
-//#endregion
 //#region src/v6/DataError.d.ts
-type DefaultDataErrorCode = "INVALID_DATA";
-interface ExpectErrorOptions<ErrorCode extends string = DefaultDataErrorCode> {
-  expectedCode?: ErrorCode | DefaultDataErrorCode;
-}
-declare const DataErrorCode: {
-  readonly INVALID_DATA: "INVALID_DATA";
-};
-type DataErrorCode = CreateEnumType<typeof DataErrorCode>;
 /**
  * Represents errors you may get that may've been caused by a specific piece of data.
  *
@@ -81,7 +73,7 @@ type DataErrorCode = CreateEnumType<typeof DataErrorCode>;
  *
  * @template DataType - The type of the data that caused the error.
  */
-declare class DataError<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = DataErrorCode> extends CodeError<ErrorCode | DataErrorCode> {
+declare class DataError<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string> extends CodeError<ErrorCode> {
   data: DataType;
   /**
    * @param data - The data that caused the error.
@@ -89,7 +81,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    * @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: DataType, code?: ErrorCode | DefaultDataErrorCode, message?: string, options?: ErrorOptions);
+  constructor(data: DataType, code: ErrorCode, message?: string, options?: ErrorOptions);
   /**
    * Checks whether the given input may have been caused by a DataError.
    *
@@ -97,7 +89,20 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    *
    * @returns `true` if the input is a DataError, and `false` otherwise. The type of the input will also be narrowed down to DataError if `true`.
    */
-  static check<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = DataErrorCode>(input: unknown): input is DataError<DataType, ErrorCode>;
+  static check<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string>(input: unknown): input is DataError<DataType, ErrorCode>;
+  /**
+   * 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<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string>(input: unknown, code: ErrorCode): input is DataError<DataType, ErrorCode>;
   /**
    * 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.
    *
@@ -109,7 +114,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectError<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = DefaultDataErrorCode>(errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): DataError<DataType, ErrorCode>;
+  static expectError<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): DataError<DataType, ErrorCode>;
   /**
    * Gets the thrown `DataError` from a given asynchronous function if one was thrown, and re-throws any other errors, or throws a default `DataError` if no error thrown.
    *
@@ -121,7 +126,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectErrorAsync<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = DefaultDataErrorCode>(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<DataError<DataType, ErrorCode>>;
+  static expectErrorAsync<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<DataError<DataType, ErrorCode>>;
 }
 //#endregion
 //#region src/v6/sayHello.d.ts
@@ -134,4 +139,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
  */
 declare function sayHello(): string;
 //#endregion
-export { CodeError, DataError, DataErrorCode, type ExpectErrorOptions, type IsTypeArgumentString, sayHello };
+//#region src/root/types/IsTypeArgumentString.d.ts
+type IsTypeArgumentString<Argument extends string> = Argument;
+//#endregion
+export { CodeError, DataError, type ExpectErrorOptions, type IsTypeArgumentString, sayHello };

package/dist/v6/index.d.ts

@@ -1,5 +1,5 @@
 //#region src/v6/CodeError.d.ts
-interface ExpectErrorOptions$1<ErrorCode extends string = string> {
+interface ExpectErrorOptions<ErrorCode extends string = string> {
   expectedCode?: ErrorCode;
 }
 /**
@@ -24,8 +24,21 @@ declare class CodeError<ErrorCode extends string = string> extends Error {
    *
    * @returns `true` if the input is a CodeError, and `false` otherwise. The type of the input will also be narrowed down to CodeError if `true`.
    */
-  static check(input: unknown): input is CodeError<string>;
-  protected static checkCaughtError<ErrorCode extends string = string>(this: typeof CodeError, error: unknown, options?: ExpectErrorOptions$1<ErrorCode>): CodeError;
+  static check<ErrorCode extends string = string>(input: unknown): input is CodeError<ErrorCode>;
+  protected static checkCaughtError<ErrorCode extends string = string>(this: typeof CodeError, error: unknown, options?: ExpectErrorOptions<ErrorCode>): CodeError<ErrorCode>;
+  /**
+   * 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<ErrorCode extends string = string>(input: unknown, code: ErrorCode): input is CodeError<ErrorCode>;
   /**
    * 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.
    *
@@ -37,7 +50,7 @@ declare class CodeError<ErrorCode extends string = string> extends Error {
    *
    * @returns The `CodeError` that was thrown by the `errorFunction`
    */
-  static expectError<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => unknown, options?: ExpectErrorOptions$1<ErrorCode>): CodeError;
+  static expectError<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): CodeError<ErrorCode>;
   /**
    * Gets the thrown `CodeError` from a given asynchronous function if one was thrown, and re-throws any other errors, or throws a default `CodeError` if no error thrown.
    *
@@ -49,31 +62,10 @@ declare class CodeError<ErrorCode extends string = string> extends Error {
    *
    * @returns The `CodeError` that was thrown by the `errorFunction`
    */
-  static expectErrorAsync<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$1<ErrorCode>): Promise<CodeError>;
+  static expectErrorAsync<ErrorCode extends string = string>(this: typeof CodeError, errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<CodeError>;
 }
 //#endregion
-//#region src/root/types/CreateEnumType.d.ts
-/**
- * Get the value types from a const object so the object can behave similarly to an enum.
- *
- * @category Types
- *
- * @template ObjectType - The type of the object to get the value types for.
- */
-type CreateEnumType<ObjectType extends Record<PropertyKey, unknown>> = ObjectType[keyof ObjectType];
-//#endregion
-//#region src/root/types/IsTypeArgumentString.d.ts
-type IsTypeArgumentString<Argument extends string> = Argument;
-//#endregion
 //#region src/v6/DataError.d.ts
-type DefaultDataErrorCode = "INVALID_DATA";
-interface ExpectErrorOptions<ErrorCode extends string = DefaultDataErrorCode> {
-  expectedCode?: ErrorCode | DefaultDataErrorCode;
-}
-declare const DataErrorCode: {
-  readonly INVALID_DATA: "INVALID_DATA";
-};
-type DataErrorCode = CreateEnumType<typeof DataErrorCode>;
 /**
  * Represents errors you may get that may've been caused by a specific piece of data.
  *
@@ -81,7 +73,7 @@ type DataErrorCode = CreateEnumType<typeof DataErrorCode>;
  *
  * @template DataType - The type of the data that caused the error.
  */
-declare class DataError<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = DataErrorCode> extends CodeError<ErrorCode | DataErrorCode> {
+declare class DataError<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string> extends CodeError<ErrorCode> {
   data: DataType;
   /**
    * @param data - The data that caused the error.
@@ -89,7 +81,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    * @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: DataType, code?: ErrorCode | DefaultDataErrorCode, message?: string, options?: ErrorOptions);
+  constructor(data: DataType, code: ErrorCode, message?: string, options?: ErrorOptions);
   /**
    * Checks whether the given input may have been caused by a DataError.
    *
@@ -97,7 +89,20 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    *
    * @returns `true` if the input is a DataError, and `false` otherwise. The type of the input will also be narrowed down to DataError if `true`.
    */
-  static check<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = DataErrorCode>(input: unknown): input is DataError<DataType, ErrorCode>;
+  static check<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string>(input: unknown): input is DataError<DataType, ErrorCode>;
+  /**
+   * 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<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string>(input: unknown, code: ErrorCode): input is DataError<DataType, ErrorCode>;
   /**
    * 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.
    *
@@ -109,7 +114,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectError<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = DefaultDataErrorCode>(errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): DataError<DataType, ErrorCode>;
+  static expectError<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): DataError<DataType, ErrorCode>;
   /**
    * Gets the thrown `DataError` from a given asynchronous function if one was thrown, and re-throws any other errors, or throws a default `DataError` if no error thrown.
    *
@@ -121,7 +126,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectErrorAsync<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = DefaultDataErrorCode>(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<DataError<DataType, ErrorCode>>;
+  static expectErrorAsync<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<DataError<DataType, ErrorCode>>;
 }
 //#endregion
 //#region src/v6/sayHello.d.ts
@@ -134,4 +139,7 @@ declare class DataError<DataType extends object = Record<PropertyKey, unknown>,
  */
 declare function sayHello(): string;
 //#endregion
-export { CodeError, DataError, DataErrorCode, type ExpectErrorOptions, type IsTypeArgumentString, sayHello };
+//#region src/root/types/IsTypeArgumentString.d.ts
+type IsTypeArgumentString<Argument extends string> = Argument;
+//#endregion
+export { CodeError, DataError, type ExpectErrorOptions, type IsTypeArgumentString, sayHello };

package/dist/v6/index.js

@@ -183,6 +183,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.
@@ -223,7 +238,6 @@ var CodeError = class CodeError extends Error {
 };
 //#endregion
 //#region src/v6/DataError.ts
-const DataErrorCode = { INVALID_DATA: "INVALID_DATA" };
 /**
 * Represents errors you may get that may've been caused by a specific piece of data.
 *
@@ -239,11 +253,10 @@ var DataError = class DataError 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);
@@ -260,6 +273,21 @@ var DataError = class DataError 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.
@@ -402,4 +430,4 @@ I'll commit to you!
     `;
 }
 //#endregion
-export { CodeError, DataError, DataErrorCode, sayHello };
+export { CodeError, DataError, sayHello };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.14.0",
+  "version": "5.15.1",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -41,9 +41,9 @@
     "zod": "4.3.6"
   },
   "devDependencies": {
-    "@alextheman/eslint-plugin": "5.13.0",
+    "@alextheman/eslint-plugin": "5.13.1",
     "@types/node": "25.6.0",
-    "alex-c-line": "2.7.0",
+    "alex-c-line": "2.7.1",
     "cross-env": "10.1.0",
     "dotenv-cli": "11.0.0",
     "eslint": "10.2.1",
@@ -58,9 +58,9 @@
     "typedoc-plugin-markdown": "4.11.0",
     "typedoc-rhineai-theme": "1.2.0",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.58.2",
-    "vite": "8.0.8",
-    "vitest": "4.1.4"
+    "typescript-eslint": "8.59.0",
+    "vite": "8.0.10",
+    "vitest": "4.1.5"
   },
   "engines": {
     "node": ">=22.3.0"