@alextheman/utility 5.14.0 → 5.15.0

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.

package/dist/index.d.cts

@@ -17,7 +17,7 @@ declare const VERSION_NUMBER_PATTERN: string;
 declare const VERSION_NUMBER_REGEX: RegExp;
 //#endregion
 //#region src/root/deprecated/DataError.d.ts
-interface ExpectErrorOptions$2 {
+interface ExpectErrorOptions$1 {
   expectedCode?: string;
 }
 /**
@@ -59,7 +59,7 @@ declare class DataError<DataType extends Record<PropertyKey, unknown> = Record<P
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectError(errorFunction: () => unknown, options?: ExpectErrorOptions$2): DataError;
+  static expectError(errorFunction: () => unknown, options?: ExpectErrorOptions$1): DataError;
   /**
    * 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.
    *
@@ -71,7 +71,7 @@ declare class DataError<DataType extends Record<PropertyKey, unknown> = Record<P
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$2): Promise<DataError>;
+  static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$1): Promise<DataError>;
 }
 //#endregion
 //#region src/root/deprecated/RecordKey.d.ts
@@ -674,9 +674,19 @@ type IgnoreCase<StringType extends string> = string extends StringType ? string
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
+//#region src/root/types/NonNull.d.ts
+/**
+ * Removes `null` from a type.
+ *
+ * @category Types
+ *
+ * @template InputType - The type to check.
+ */
+type NonNull<InputType> = InputType extends null ? never : InputType;
+//#endregion
 //#region src/root/types/NonUndefined.d.ts
 /**
- * Resolves to `never` if the given type may be undefined.
+ * Removes `undefined` from a type.
  *
  * @category Types
  *
@@ -1112,7 +1122,7 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
 //#region src/v6/CodeError.d.ts
-interface ExpectErrorOptions$1<ErrorCode extends string = string> {
+interface ExpectErrorOptions<ErrorCode extends string = string> {
   expectedCode?: ErrorCode;
 }
 /**
@@ -1137,8 +1147,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.
    *
@@ -1150,7 +1173,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.
    *
@@ -1162,18 +1185,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/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.
  *
@@ -1181,7 +1196,7 @@ type DataErrorCode = CreateEnumType<typeof DataErrorCode>;
  *
  * @template DataType - The type of the data that caused the error.
  */
-declare class DataError$1<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = DataErrorCode> extends CodeError<ErrorCode | DataErrorCode> {
+declare class DataError$1<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string> extends CodeError<ErrorCode> {
   data: DataType;
   /**
    * @param data - The data that caused the error.
@@ -1189,7 +1204,7 @@ declare class DataError$1<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.
    *
@@ -1197,7 +1212,20 @@ declare class DataError$1<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$1<DataType, ErrorCode>;
+  static check<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string>(input: unknown): input is DataError$1<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$1<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.
    *
@@ -1209,7 +1237,7 @@ declare class DataError$1<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$1<DataType, ErrorCode>;
+  static expectError<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): DataError$1<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.
    *
@@ -1221,7 +1249,7 @@ declare class DataError$1<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$1<DataType, ErrorCode>>;
+  static expectErrorAsync<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<DataError$1<DataType, ErrorCode>>;
 }
 //#endregion
 //#region src/root/zod/parseZodSchema.d.ts
@@ -1278,9 +1306,9 @@ declare const az: {
   versionNumber: () => ZodType<VersionNumber, unknown>;
   fieldDate: () => ZodCoercedDate<string | null>;
   with: <SchemaType extends ZodType>(schema: SchemaType) => {
-    parse: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, "INVALID_DATA">>(input: unknown, error?: ErrorType | ((zodError: z.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchema<SchemaType, ErrorType>>;
-    parseAsync: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, "INVALID_DATA">>(input: unknown, error?: ErrorType | ((zodError: z.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchemaAsync<SchemaType, ErrorType>>;
+    parse: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchema<SchemaType, ErrorType>>;
+    parseAsync: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchemaAsync<SchemaType, ErrorType>>;
   };
 };
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, az, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonNull, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, az, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/index.d.ts

@@ -17,7 +17,7 @@ declare const VERSION_NUMBER_PATTERN: string;
 declare const VERSION_NUMBER_REGEX: RegExp;
 //#endregion
 //#region src/root/deprecated/DataError.d.ts
-interface ExpectErrorOptions$2 {
+interface ExpectErrorOptions$1 {
   expectedCode?: string;
 }
 /**
@@ -59,7 +59,7 @@ declare class DataError<DataType extends Record<PropertyKey, unknown> = Record<P
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectError(errorFunction: () => unknown, options?: ExpectErrorOptions$2): DataError;
+  static expectError(errorFunction: () => unknown, options?: ExpectErrorOptions$1): DataError;
   /**
    * 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.
    *
@@ -71,7 +71,7 @@ declare class DataError<DataType extends Record<PropertyKey, unknown> = Record<P
    *
    * @returns The `DataError` that was thrown by the `errorFunction`
    */
-  static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$2): Promise<DataError>;
+  static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions$1): Promise<DataError>;
 }
 //#endregion
 //#region src/root/deprecated/RecordKey.d.ts
@@ -674,9 +674,19 @@ type IgnoreCase<StringType extends string> = string extends StringType ? string
 //#region src/root/types/IsTypeArgumentString.d.ts
 type IsTypeArgumentString<Argument extends string> = Argument;
 //#endregion
+//#region src/root/types/NonNull.d.ts
+/**
+ * Removes `null` from a type.
+ *
+ * @category Types
+ *
+ * @template InputType - The type to check.
+ */
+type NonNull<InputType> = InputType extends null ? never : InputType;
+//#endregion
 //#region src/root/types/NonUndefined.d.ts
 /**
- * Resolves to `never` if the given type may be undefined.
+ * Removes `undefined` from a type.
  *
  * @category Types
  *
@@ -1112,7 +1122,7 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
 //#region src/v6/CodeError.d.ts
-interface ExpectErrorOptions$1<ErrorCode extends string = string> {
+interface ExpectErrorOptions<ErrorCode extends string = string> {
   expectedCode?: ErrorCode;
 }
 /**
@@ -1137,8 +1147,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.
    *
@@ -1150,7 +1173,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.
    *
@@ -1162,18 +1185,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/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.
  *
@@ -1181,7 +1196,7 @@ type DataErrorCode = CreateEnumType<typeof DataErrorCode>;
  *
  * @template DataType - The type of the data that caused the error.
  */
-declare class DataError$1<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = DataErrorCode> extends CodeError<ErrorCode | DataErrorCode> {
+declare class DataError$1<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string> extends CodeError<ErrorCode> {
   data: DataType;
   /**
    * @param data - The data that caused the error.
@@ -1189,7 +1204,7 @@ declare class DataError$1<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.
    *
@@ -1197,7 +1212,20 @@ declare class DataError$1<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$1<DataType, ErrorCode>;
+  static check<DataType extends object = Record<PropertyKey, unknown>, ErrorCode extends string = string>(input: unknown): input is DataError$1<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$1<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.
    *
@@ -1209,7 +1237,7 @@ declare class DataError$1<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$1<DataType, ErrorCode>;
+  static expectError<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => unknown, options?: ExpectErrorOptions<ErrorCode>): DataError$1<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.
    *
@@ -1221,7 +1249,7 @@ declare class DataError$1<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$1<DataType, ErrorCode>>;
+  static expectErrorAsync<DataType extends Record<PropertyKey, unknown>, ErrorCode extends string = string>(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions<ErrorCode>): Promise<DataError$1<DataType, ErrorCode>>;
 }
 //#endregion
 //#region src/root/zod/parseZodSchema.d.ts
@@ -1278,9 +1306,9 @@ declare const az: {
   versionNumber: () => ZodType<VersionNumber, unknown>;
   fieldDate: () => ZodCoercedDate<string | null>;
   with: <SchemaType extends ZodType>(schema: SchemaType) => {
-    parse: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, "INVALID_DATA">>(input: unknown, error?: ErrorType | ((zodError: z$1.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchema<SchemaType, ErrorType>>;
-    parseAsync: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, "INVALID_DATA">>(input: unknown, error?: ErrorType | ((zodError: z$1.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchemaAsync<SchemaType, ErrorType>>;
+    parse: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z$1.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchema<SchemaType, ErrorType>>;
+    parseAsync: <ErrorType extends Error = DataError$1<Record<PropertyKey, unknown>, string>>(input: unknown, error?: ErrorType | ((zodError: z$1.ZodError<unknown>) => void | ErrorType)) => ReturnType<typeof parseZodSchemaAsync<SchemaType, ErrorType>>;
   };
 };
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, az, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, KebabToCamelOptions, type NonNull, type NonUndefined, NormaliseIndentsFunction, NormaliseIndentsOptions, NormalizeIndentsFunction, NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, ParallelTuple, RecordKey, RemoveUndefined, type StringListToArrayOptions, ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, addDaysToDate, appendSemicolon, az, calculateMonthlyDifference, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/index.js

@@ -109,6 +109,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.
@@ -164,11 +179,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);
@@ -185,6 +199,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.

package/dist/internal/index.cjs

@@ -132,6 +132,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.
@@ -187,11 +202,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);
@@ -208,6 +222,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.