@alextheman/utility 5.14.0 → 5.15.1

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
@@ -84,6 +84,32 @@ declare class DataError<DataType extends Record<PropertyKey, unknown> = Record<P
  */
 type RecordKey = string | number | symbol;
 //#endregion
+//#region src/root/types/APIError.d.ts
+type HTTPErrorCode = 400 | 401 | 403 | 404 | 418 | 500;
+declare const httpErrorCodeLookup: Record<HTTPErrorCode, string>;
+/**
+ * Represents common errors you may get from a HTTP API request.
+ *
+ * @category Types
+ */
+declare class APIError extends Error {
+  status: number;
+  /**
+   * @param status - A HTTP status code. Can be any number, but numbers between 400 and 600 are encouraged to fit with HTTP status code conventions.
+   * @param message - An error message to display alongside the status code.
+   * @param options - Extra options to be passed to super Error constructor.
+   */
+  constructor(status?: HTTPErrorCode | number, message?: string, options?: ErrorOptions);
+  /**
+   * Checks whether the given input may have been caused by an APIError.
+   *
+   * @param input - The input to check.
+   *
+   * @returns `true` if the input is an APIError, and `false` otherwise. The type of the input will also be narrowed down to APIError if `true`.
+   */
+  static check(input: unknown): input is APIError;
+}
+//#endregion
 //#region src/root/functions/arrayHelpers/fillArray.d.ts
 /**
  * Creates a new array where each element is the resolved result of the provided asynchronous callback.
@@ -503,209 +529,6 @@ declare function removeUndefinedFromObject<RecordType extends Record<PropertyKey
  */
 declare function parseBoolean(inputString: string): boolean;
 //#endregion
-//#region src/root/types/APIError.d.ts
-type HTTPErrorCode = 400 | 401 | 403 | 404 | 418 | 500;
-declare const httpErrorCodeLookup: Record<HTTPErrorCode, string>;
-/**
- * Represents common errors you may get from a HTTP API request.
- *
- * @category Types
- */
-declare class APIError extends Error {
-  status: number;
-  /**
-   * @param status - A HTTP status code. Can be any number, but numbers between 400 and 600 are encouraged to fit with HTTP status code conventions.
-   * @param message - An error message to display alongside the status code.
-   * @param options - Extra options to be passed to super Error constructor.
-   */
-  constructor(status?: HTTPErrorCode | number, message?: string, options?: ErrorOptions);
-  /**
-   * Checks whether the given input may have been caused by an APIError.
-   *
-   * @param input - The input to check.
-   *
-   * @returns `true` if the input is an APIError, and `false` otherwise. The type of the input will also be narrowed down to APIError if `true`.
-   */
-  static check(input: unknown): input is APIError;
-}
-//#endregion
-//#region src/root/types/VersionNumber.d.ts
-/**
- * Options to apply to the stringification of the version number.
- *
- * @category Class Options
- */
-interface FormatOptionsBase {
-  /** Whether you want to omit the "v" prefix or not (defaults to false). */
-  omitPrefix?: boolean;
-}
-interface FormatOptionsIncludeMinor extends FormatOptionsBase {
-  /** Whether you want to omit the minor version or not */
-  omitMinor?: false;
-  /** Whether you want to omit the patch version or not */
-  omitPatch?: boolean;
-}
-interface FormatOptionsOmitMinor extends FormatOptionsBase {
-  /** Whether you want to omit the minor version or not */
-  omitMinor?: true;
-  /** Whether you want to omit the patch version or not */
-  omitPatch?: never;
-}
-type FormatStringOptions = FormatOptionsIncludeMinor | FormatOptionsOmitMinor;
-/**
- * Represents a software version number, considered to be made up of a major, minor, and patch part.
- *
- * @category Types
- */
-declare class VersionNumber {
-  private static readonly NON_NEGATIVE_TUPLE_ERROR;
-  /** The major number. Increments when a feature is removed or changed in a way that is not backwards-compatible with the previous release. */
-  readonly major: number;
-  /** The minor number. Increments when a new feature is added/deprecated and is expected to be backwards-compatible with the previous release. */
-  readonly minor: number;
-  /** The patch number. Increments when the next release is fixing a bug or doing a small refactor that should not be noticeable in practice. */
-  readonly patch: number;
-  /**
-   * @param input - The input to create a new instance of `VersionNumber` from.
-   */
-  constructor(input: string | [number, number, number] | VersionNumber);
-  /**
-   * Gets the current version type of the current instance of `VersionNumber`.
-   *
-   * @returns Either `"major"`, `"minor"`, or `"patch"`, depending on the version type.
-   */
-  get type(): VersionType;
-  private static formatString;
-  /**
-   * Checks if the provided version numbers have the exact same major, minor, and patch numbers.
-   *
-   * @param firstVersion - The first version number to compare.
-   * @param secondVersion - The second version number to compare.
-   *
-   * @returns `true` if the provided version numbers have exactly the same major, minor, and patch numbers, and returns `false` otherwise.
-   */
-  static isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean;
-  /**
-   * Get a formatted string representation of the current version number
-   *
-   * @param options - Options to apply to the string formatting.
-   *
-   * @returns A formatted string representation of the current version number with the options applied.
-   */
-  format(options?: FormatStringOptions): string;
-  /**
-   * 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`
-   * - `"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, incrementAmount?: number): 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.
-   *
-   * @returns A stringified representation of the current version number with the prefix.
-   */
-  toString(): string;
-}
-declare const zodVersionNumber: z$1.ZodType<VersionNumber>;
-//#endregion
-//#region src/root/types/ArrayElement.d.ts
-/**
- * Gets the individual element types from an array type.
- *
- * @category Types
- *
- * @template ArrayType - The type of the array itself.
- */
-type ArrayElement<ArrayType extends ReadonlyArray<unknown>> = ArrayType extends ReadonlyArray<infer ElementType> ? ElementType : never;
-//#endregion
-//#region src/root/types/CallReturnType.d.ts
-type CallReturnType<Function, Arguments> = Function extends ((arg: Arguments) => infer Return) ? Return : never;
-//#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/DisallowUndefined.d.ts
-/**
- * Resolves to an error message type if the type argument could potentially be undefined.
- *
- * @category Types
- *
- * @template InputType - The type to disallow undefined on.
- */
-type DisallowUndefined<InputType> = undefined extends InputType ? ["Error: Generic type cannot include undefined"] : InputType;
-//#endregion
-//#region src/root/types/IgnoreCase.d.ts
-/**
- * Allows case-insensitive variants of a known string type.
- *
- * @category Types
- *
- * @template StringType - The input string type.
- */
-type IgnoreCase<StringType extends string> = string extends StringType ? string : StringType extends `${infer FirstCharacter}${infer SecondCharacter}${infer Remainder}` ? `${Uppercase<FirstCharacter> | Lowercase<FirstCharacter>}${Uppercase<SecondCharacter> | Lowercase<SecondCharacter>}${IgnoreCase<Remainder>}` : StringType extends `${infer FirstCharacter}${infer Remainder}` ? `${Uppercase<FirstCharacter> | Lowercase<FirstCharacter>}${IgnoreCase<Remainder>}` : "";
-//#endregion
-//#region src/root/types/IsTypeArgumentString.d.ts
-type IsTypeArgumentString<Argument extends string> = Argument;
-//#endregion
-//#region src/root/types/NonUndefined.d.ts
-/**
- * Resolves to `never` if the given type may be undefined.
- *
- * @category Types
- *
- * @template InputType - The type to check.
- */
-type NonUndefined<InputType> = InputType extends undefined ? never : InputType;
-//#endregion
-//#region src/root/types/NullableOnCondition.d.ts
-/**
- * Resolves to the given type if the first type is `true`, otherwise resolves to `null`
- *
- * @category Types
- *
- * @param Condition - The condition to check.
- * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
- */
-type NullableOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | null;
-//#endregion
-//#region src/root/types/OptionalOnCondition.d.ts
-/**
- * Resolves to the given type if the first type is `true`, otherwise resolves to `undefined`
- *
- * @category Types
- *
- * @param Condition - The condition to check.
- * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
- */
-type OptionalOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | undefined;
-//#endregion
 //#region src/root/functions/parsers/parseEnv.d.ts
 /**
  * Represents the three common development environments.
@@ -1111,8 +934,209 @@ declare function normaliseIndents(strings: TemplateStringsArray, ...interpolatio
  */
 declare const normalizeIndents: typeof normaliseIndents;
 //#endregion
+//#region src/root/types/VersionNumber.d.ts
+/**
+ * Options to apply to the stringification of the version number.
+ *
+ * @category Class Options
+ */
+interface FormatOptionsBase {
+  /** Whether you want to omit the "v" prefix or not (defaults to false). */
+  omitPrefix?: boolean;
+}
+interface FormatOptionsIncludeMinor extends FormatOptionsBase {
+  /** Whether you want to omit the minor version or not */
+  omitMinor?: false;
+  /** Whether you want to omit the patch version or not */
+  omitPatch?: boolean;
+}
+interface FormatOptionsOmitMinor extends FormatOptionsBase {
+  /** Whether you want to omit the minor version or not */
+  omitMinor?: true;
+  /** Whether you want to omit the patch version or not */
+  omitPatch?: never;
+}
+type FormatStringOptions = FormatOptionsIncludeMinor | FormatOptionsOmitMinor;
+/**
+ * Represents a software version number, considered to be made up of a major, minor, and patch part.
+ *
+ * @category Types
+ */
+declare class VersionNumber {
+  private static readonly NON_NEGATIVE_TUPLE_ERROR;
+  /** The major number. Increments when a feature is removed or changed in a way that is not backwards-compatible with the previous release. */
+  readonly major: number;
+  /** The minor number. Increments when a new feature is added/deprecated and is expected to be backwards-compatible with the previous release. */
+  readonly minor: number;
+  /** The patch number. Increments when the next release is fixing a bug or doing a small refactor that should not be noticeable in practice. */
+  readonly patch: number;
+  /**
+   * @param input - The input to create a new instance of `VersionNumber` from.
+   */
+  constructor(input: string | [number, number, number] | VersionNumber);
+  /**
+   * Gets the current version type of the current instance of `VersionNumber`.
+   *
+   * @returns Either `"major"`, `"minor"`, or `"patch"`, depending on the version type.
+   */
+  get type(): VersionType;
+  private static formatString;
+  /**
+   * Checks if the provided version numbers have the exact same major, minor, and patch numbers.
+   *
+   * @param firstVersion - The first version number to compare.
+   * @param secondVersion - The second version number to compare.
+   *
+   * @returns `true` if the provided version numbers have exactly the same major, minor, and patch numbers, and returns `false` otherwise.
+   */
+  static isEqual(firstVersion: VersionNumber, secondVersion: VersionNumber): boolean;
+  /**
+   * Get a formatted string representation of the current version number
+   *
+   * @param options - Options to apply to the string formatting.
+   *
+   * @returns A formatted string representation of the current version number with the options applied.
+   */
+  format(options?: FormatStringOptions): string;
+  /**
+   * 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`
+   * - `"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, incrementAmount?: number): 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.
+   *
+   * @returns A stringified representation of the current version number with the prefix.
+   */
+  toString(): string;
+}
+declare const zodVersionNumber: z$1.ZodType<VersionNumber>;
+//#endregion
+//#region src/root/types/ArrayElement.d.ts
+/**
+ * Gets the individual element types from an array type.
+ *
+ * @category Types
+ *
+ * @template ArrayType - The type of the array itself.
+ */
+type ArrayElement<ArrayType extends ReadonlyArray<unknown>> = ArrayType extends ReadonlyArray<infer ElementType> ? ElementType : never;
+//#endregion
+//#region src/root/types/CallReturnType.d.ts
+type CallReturnType<Function, Arguments> = Function extends ((arg: Arguments) => infer Return) ? Return : never;
+//#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/DisallowUndefined.d.ts
+/**
+ * Resolves to an error message type if the type argument could potentially be undefined.
+ *
+ * @category Types
+ *
+ * @template InputType - The type to disallow undefined on.
+ */
+type DisallowUndefined<InputType> = undefined extends InputType ? ["Error: Generic type cannot include undefined"] : InputType;
+//#endregion
+//#region src/root/types/IgnoreCase.d.ts
+/**
+ * Allows case-insensitive variants of a known string type.
+ *
+ * @category Types
+ *
+ * @template StringType - The input string type.
+ */
+type IgnoreCase<StringType extends string> = string extends StringType ? string : StringType extends `${infer FirstCharacter}${infer SecondCharacter}${infer Remainder}` ? `${Uppercase<FirstCharacter> | Lowercase<FirstCharacter>}${Uppercase<SecondCharacter> | Lowercase<SecondCharacter>}${IgnoreCase<Remainder>}` : StringType extends `${infer FirstCharacter}${infer Remainder}` ? `${Uppercase<FirstCharacter> | Lowercase<FirstCharacter>}${IgnoreCase<Remainder>}` : "";
+//#endregion
+//#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
+/**
+ * Removes `undefined` from a type.
+ *
+ * @category Types
+ *
+ * @template InputType - The type to check.
+ */
+type NonUndefined<InputType> = InputType extends undefined ? never : InputType;
+//#endregion
+//#region src/root/types/NullableOnCondition.d.ts
+/**
+ * Resolves to the given type if the first type is `true`, otherwise resolves to `null`
+ *
+ * @category Types
+ *
+ * @param Condition - The condition to check.
+ * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
+ */
+type NullableOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | null;
+//#endregion
+//#region src/root/types/OptionalOnCondition.d.ts
+/**
+ * Resolves to the given type if the first type is `true`, otherwise resolves to `undefined`
+ *
+ * @category Types
+ *
+ * @param Condition - The condition to check.
+ * @param ResolvedTypeIfTrue - The type to resolve to if the condition may be `true`.
+ */
+type OptionalOnCondition<Condition extends boolean, ResolvedTypeIfTrue> = Condition extends true ? ResolvedTypeIfTrue : ResolvedTypeIfTrue | undefined;
+//#endregion
+//#region src/root/errors/assertNotNull.d.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`.
+ */
+declare function assertNotNull<InputType>(input: InputType): asserts input is NonNull<InputType>;
+//#endregion
 //#region src/v6/CodeError.d.ts
-interface ExpectErrorOptions$1<ErrorCode extends string = string> {
+interface ExpectErrorOptions<ErrorCode extends string = string> {
   expectedCode?: ErrorCode;
 }
 /**
@@ -1137,8 +1161,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 +1187,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 +1199,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 +1210,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 +1218,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 +1226,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 +1251,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 +1263,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 +1320,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, assertNotNull, 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 };