@alextheman/utility 5.1.3 → 5.2.0

package/dist/index.js

@@ -134,6 +134,17 @@ var DataError = class DataError extends Error {
 		Object.defineProperty(this, "message", { enumerable: true });
 		Object.setPrototypeOf(this, new.target.prototype);
 	}
+	static checkCaughtError(error, options) {
+		if (DataError.check(error)) {
+			if (options?.expectedCode && error.code !== options.expectedCode) throw new Error(normaliseIndents`The error code on the thrown error does not match the expected error code.
+            
+            Expected: ${options.expectedCode}
+            Received: ${error.code}
+            `, { cause: error });
+			return error;
+		}
+		throw error;
+	}
 	/**
 	* Checks whether the given input may have been caused by a DataError.
 	*
@@ -146,6 +157,44 @@ var DataError = class DataError extends Error {
 		const data = input;
 		return typeof data === "object" && data !== null && typeof data.message === "string" && typeof data.code === "string" && "data" in data;
 	}
+	/**
+	* 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.
+	* @param options - Extra options to apply.
+	*
+	* @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+	* @throws {Error} If no `DataError` was thrown by the `errorFunction`
+	*
+	* @returns The `DataError` that was thrown by the `errorFunction`
+	*/
+	static expectError(errorFunction, options) {
+		try {
+			errorFunction();
+		} catch (error) {
+			return DataError.checkCaughtError(error, options);
+		}
+		throw new Error("Expected a DataError to be thrown but none was thrown");
+	}
+	/**
+	* 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.
+	*
+	* @param errorFunction - The function expected to throw the error.
+	* @param options - Extra options to apply.
+	*
+	* @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+	* @throws {Error} If no `DataError` was thrown by the `errorFunction`
+	*
+	* @returns The `DataError` that was thrown by the `errorFunction`
+	*/
+	static async expectErrorAsync(errorFunction, options) {
+		try {
+			await errorFunction();
+		} catch (error) {
+			return DataError.checkCaughtError(error, options);
+		}
+		throw new Error("Expected a DataError to be thrown but none was thrown");
+	}
 };
 
 //#endregion
@@ -400,19 +449,27 @@ function randomiseArray(array) {
 * @param stop - The number to stop at (exclusive).
 * @param step - The step size between numbers, defaulting to 1.
 *
-* @throws {Error} If `step` is `0`.
-* @throws {Error} If `step` direction does not match the order of `start` and `stop`.
+* @throws {DataError} If `step` is `0`.
+* @throws {DataError} If `step` direction does not match the order of `start` and `stop`.
 *
 * @returns An array of numbers satisfying the range provided.
 */
 function range(start, stop, step = 1) {
 	const numbers = [];
-	if (step === 0) throw new Error("ZERO_STEP_SIZE_NOT_ALLOWED");
+	if (step === 0) throw new DataError({ step }, "ZERO_STEP_SIZE", "Step size cannot be zero.");
 	else if (step > 0) {
-		if (start > stop) throw new Error("INVALID_BOUNDARIES");
+		if (start > stop) throw new DataError({
+			start,
+			stop,
+			step
+		}, "INVALID_BOUNDARIES", "The starting value cannot be bigger than the final value if step is positive");
 		for (let i = start; i < stop; i += step) numbers.push(i);
 	} else if (step < 0) {
-		if (start < stop) throw new Error("INVALID_BOUNDARIES");
+		if (start < stop) throw new DataError({
+			start,
+			stop,
+			step
+		}, "INVALID_BOUNDARIES", "The final value cannot be bigger than the starting value if step is negative");
 		for (let i = start; i > stop; i += step) numbers.push(i);
 	}
 	return numbers;
@@ -583,25 +640,6 @@ function isMonthlyMultiple(firstDate, secondDate) {
 	return firstDate.getDate() === secondDate.getDate();
 }
 
-//#endregion
-//#region src/internal/getDependenciesFromGroup.ts
-/**
-* Get the dependencies from a given dependency group in `package.json`.
-*
-* @category Miscellaneous
-*
-* @param packageInfo - The data coming from `package.json`.
-* @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
-*
-* @returns A record consisting of the package names and version ranges from the given dependency group.
-*/
-function getDependenciesFromGroup(packageInfo, dependencyGroup) {
-	return {
-		dependencies: parseZodSchema(z.record(z.string(), z.string()), packageInfo.dependencies ?? {}),
-		devDependencies: parseZodSchema(z.record(z.string(), z.string()), packageInfo.devDependencies ?? {})
-	}[dependencyGroup];
-}
-
 //#endregion
 //#region src/root/functions/miscellaneous/convertFileToBase64.ts
 /**
@@ -611,7 +649,7 @@ function getDependenciesFromGroup(packageInfo, dependencyGroup) {
 *
 * @param file - The file to convert.
 *
-* @throws {Error} If the file reader gives an error.
+* @throws {Error | DataError} If the file reader gives an error.
 *
 * @returns A promise that resolves to the encoded base 64 string.
 */
@@ -621,7 +659,7 @@ function convertFileToBase64(file) {
 		reader.readAsDataURL(file);
 		reader.onload = () => {
 			if (reader.result === null) {
-				reject(/* @__PURE__ */ new Error("FILE_CONVERSION_ERROR"));
+				reject(new DataError({ result: reader.result }, "FILE_CONVERSION_ERROR", "Could not convert the given file."));
 				return;
 			}
 			resolve(reader.result);
@@ -637,6 +675,9 @@ function convertFileToBase64(file) {
 function getNullableResolutionStrategy(key, strategy) {
 	return (typeof strategy === "object" ? strategy[key] : strategy) ?? "empty";
 }
+function isPrimitive(item) {
+	return typeof item === "string" || typeof item === "number" || typeof item === "boolean";
+}
 /**
 * Creates FormData from a given object, resolving non-string types as appropriate.
 *
@@ -663,7 +704,7 @@ function createFormData(data, options = {
 				formData.append(String(key), JSON.stringify(value));
 				break;
 			case "omit": break;
-			default: throw new TypeError("SLOPPY_PURE_JAVASCRIPT_USER_ERROR");
+			default: throw resolutionStrategy;
 		}
 	}
 	function resolveNullables(key, value, options) {
@@ -686,10 +727,10 @@ function createFormData(data, options = {
 		if (Array.isArray(value)) {
 			if (value.some((item) => {
 				return item instanceof Blob;
-			}) && (options.arrayResolution === "stringify" || typeof options.arrayResolution === "object" && options.arrayResolution[key] === "stringify")) throw new TypeError("CANNOT_STRINGIFY_BLOB");
+			}) && (options.arrayResolution === "stringify" || typeof options.arrayResolution === "object" && options.arrayResolution[key] === "stringify")) throw new DataError({ value }, "CANNOT_STRINGIFY_BLOB", "Files/blobs cannot be stringified. Please change the resolution option for this item to \"multiple\" instead.");
 			if (options.arrayResolution === "multiple" || typeof options.arrayResolution === "object" && options.arrayResolution[key] === "multiple") {
 				for (const item of value) {
-					if ((typeof item === "object" || !item) && !(item instanceof Blob)) throw new TypeError("NON_PRIMITIVE_ARRAY_ITEMS_FOUND");
+					if (!isPrimitive(item) && !(item instanceof Blob)) throw new DataError({ item }, "NON_PRIMITIVE_ARRAY_ITEMS_FOUND", "Cannot directly add non-primitive data to FormData. Please change the resolution option for this item to \"stringify\" instead.");
 					if (item instanceof Blob) formData.append(String(key), item);
 					else formData.append(String(key), String(item));
 				}
@@ -1431,12 +1472,12 @@ async function encryptWithKey(publicKey, plaintextValue) {
 *
 * @param stringToAppendTo - The string to append a semicolon to.
 *
-* @throws {Error} If the string contains multiple lines.
+* @throws {DataError} If the string contains multiple lines.
 *
 * @returns A string with the semicolon appended.
 */
 function appendSemicolon(stringToAppendTo) {
-	if (stringToAppendTo.includes("\n")) throw new Error("MULTIPLE_LINE_ERROR");
+	if (stringToAppendTo.includes("\n")) throw new DataError({ stringToAppendTo }, "MULTIPLE_LINE_ERROR", "Cannot append semicolon to multi-line string.");
 	const stringWithNoTrailingWhitespace = stringToAppendTo.trimEnd();
 	if (stringWithNoTrailingWhitespace === "") return "";
 	return stringWithNoTrailingWhitespace[stringWithNoTrailingWhitespace.length - 1] === ";" ? stringWithNoTrailingWhitespace : `${stringWithNoTrailingWhitespace};`;
@@ -1488,34 +1529,35 @@ function camelToKebab(string, options = { preserveConsecutiveCapitals: true }) {
 *
 * @category String Helpers
 *
-* @param string - The string to convert.
+* @param input - The string to convert.
 * @param options - Options to apply to the conversion.
 *
 * @returns The string converted to camelCase.
 */
-function kebabToCamel(string, options) {
-	if (string !== string.toLowerCase()) throw new Error("INVALID_KEBAB_CASE_INPUT");
-	if (string.startsWith("-") || string.endsWith("-") || string.includes("--")) throw new Error("INVALID_KEBAB_CASE_INPUT");
+function kebabToCamel(input, options) {
+	if (input !== input.toLowerCase()) throw new DataError({ input }, "UPPERCASE_INPUT", "Kebab-case must be purely lowercase.");
+	if (input.startsWith("-") || input.endsWith("-")) throw new DataError({ input }, "TRAILING_DASHES", "Dashes at the start and/or end are not allowed.");
+	if (input.includes("--")) throw new DataError({ input }, "CONSECUTIVE_DASHES", "Consecutive dashes are not allowed.");
 	let outputString = "";
 	let skip = false;
-	for (const stringIndex in [...string]) {
+	for (const stringIndex in [...input]) {
 		if (skip) {
 			skip = false;
 			continue;
 		}
 		const index = parseIntStrict(stringIndex);
 		if (index === 0 && options?.startWithUpper) {
-			outputString += string[index].toUpperCase();
+			outputString += input[index].toUpperCase();
 			continue;
 		}
-		if (index === string.length - 1) {
-			outputString += string[index];
+		if (index === input.length - 1) {
+			outputString += input[index];
 			break;
 		}
-		if (string[index] === "-" && /^[a-zA-Z]+$/.test(string[index + 1])) {
-			outputString += string[index + 1].toUpperCase();
+		if (input[index] === "-" && /^[a-zA-Z]+$/.test(input[index + 1])) {
+			outputString += input[index + 1].toUpperCase();
 			skip = true;
-		} else outputString += string[index];
+		} else outputString += input[index];
 	}
 	return outputString;
 }
@@ -1537,4 +1579,4 @@ function truncate(stringToTruncate, maxLength = 5) {
 }
 
 //#endregion
-export { APIError, DataError, Env, FILE_PATH_REGEX, NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getDependenciesFromGroup, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };
+export { APIError, DataError, Env, FILE_PATH_REGEX, NAMESPACE_EXPORT_REGEX, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, camelToKebab, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, encryptWithKey, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseVersionType, parseZodSchema, parseZodSchemaAsync, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, stringListToArray, stringifyDotenv, truncate, wait, zodVersionNumber };

package/dist/internal/index.cjs

@@ -118,6 +118,17 @@ var DataError = class DataError extends Error {
 		Object.defineProperty(this, "message", { enumerable: true });
 		Object.setPrototypeOf(this, new.target.prototype);
 	}
+	static checkCaughtError(error, options) {
+		if (DataError.check(error)) {
+			if (options?.expectedCode && error.code !== options.expectedCode) throw new Error(normaliseIndents`The error code on the thrown error does not match the expected error code.
+            
+            Expected: ${options.expectedCode}
+            Received: ${error.code}
+            `, { cause: error });
+			return error;
+		}
+		throw error;
+	}
 	/**
 	* Checks whether the given input may have been caused by a DataError.
 	*
@@ -130,6 +141,44 @@ var DataError = class DataError extends Error {
 		const data = input;
 		return typeof data === "object" && data !== null && typeof data.message === "string" && typeof data.code === "string" && "data" in data;
 	}
+	/**
+	* 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.
+	* @param options - Extra options to apply.
+	*
+	* @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+	* @throws {Error} If no `DataError` was thrown by the `errorFunction`
+	*
+	* @returns The `DataError` that was thrown by the `errorFunction`
+	*/
+	static expectError(errorFunction, options) {
+		try {
+			errorFunction();
+		} catch (error) {
+			return DataError.checkCaughtError(error, options);
+		}
+		throw new Error("Expected a DataError to be thrown but none was thrown");
+	}
+	/**
+	* 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.
+	*
+	* @param errorFunction - The function expected to throw the error.
+	* @param options - Extra options to apply.
+	*
+	* @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+	* @throws {Error} If no `DataError` was thrown by the `errorFunction`
+	*
+	* @returns The `DataError` that was thrown by the `errorFunction`
+	*/
+	static async expectErrorAsync(errorFunction, options) {
+		try {
+			await errorFunction();
+		} catch (error) {
+			return DataError.checkCaughtError(error, options);
+		}
+		throw new Error("Expected a DataError to be thrown but none was thrown");
+	}
 };
 
 //#endregion

package/dist/internal/index.d.cts

@@ -1,18 +1,5 @@
 import { ExecaMethod } from "execa";
 
-//#region src/internal/getDependenciesFromGroup.d.ts
-/**
- * Get the dependencies from a given dependency group in `package.json`.
- *
- * @category Miscellaneous
- *
- * @param packageInfo - The data coming from `package.json`.
- * @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
- *
- * @returns A record consisting of the package names and version ranges from the given dependency group.
- */
-declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>, dependencyGroup: DependencyGroup): Record<string, string>;
-//#endregion
 //#region src/root/types/RecordKey.d.ts
 /**
  * Represents the native Record's possible key type.
@@ -22,6 +9,9 @@ declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>,
 type RecordKey = string | number | symbol;
 //#endregion
 //#region src/root/types/DataError.d.ts
+interface ExpectErrorOptions {
+  expectedCode?: string;
+}
 /**
  * Represents errors you may get that may've been caused by a specific piece of data.
  *
@@ -39,6 +29,7 @@ declare class DataError<DataType extends Record<RecordKey, unknown> = Record<Rec
    * @param options - Extra options to pass to super Error constructor.
    */
   constructor(data: DataType, code?: string, message?: string, options?: ErrorOptions);
+  private static checkCaughtError;
   /**
    * Checks whether the given input may have been caused by a DataError.
    *
@@ -47,6 +38,30 @@ declare class DataError<DataType extends Record<RecordKey, unknown> = Record<Rec
    * @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 Record<RecordKey, unknown> = Record<RecordKey, unknown>>(input: unknown): input is DataError<DataType>;
+  /**
+   * 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.
+   * @param options - Extra options to apply.
+   *
+   * @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+   * @throws {Error} If no `DataError` was thrown by the `errorFunction`
+   *
+   * @returns The `DataError` that was thrown by the `errorFunction`
+   */
+  static expectError(errorFunction: () => unknown, options?: ExpectErrorOptions): 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.
+   *
+   * @param errorFunction - The function expected to throw the error.
+   * @param options - Extra options to apply.
+   *
+   * @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+   * @throws {Error} If no `DataError` was thrown by the `errorFunction`
+   *
+   * @returns The `DataError` that was thrown by the `errorFunction`
+   */
+  static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions): Promise<DataError>;
 }
 //#endregion
 //#region src/root/types/CreateEnumType.d.ts
@@ -79,6 +94,19 @@ declare const DependencyGroup: {
 };
 type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
 //#endregion
+//#region src/internal/getDependenciesFromGroup.d.ts
+/**
+ * Get the dependencies from a given dependency group in `package.json`.
+ *
+ * @category Miscellaneous
+ *
+ * @param packageInfo - The data coming from `package.json`.
+ * @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
+ *
+ * @returns A record consisting of the package names and version ranges from the given dependency group.
+ */
+declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>, dependencyGroup: DependencyGroup): Record<string, string>;
+//#endregion
 //#region src/internal/getExpectedTgzName.d.ts
 declare function getExpectedTgzName(packagePath: string, packageManager: string): Promise<string>;
 //#endregion

package/dist/internal/index.d.ts

@@ -1,19 +1,6 @@
 import z from "zod";
 import { ExecaMethod } from "execa";
 
-//#region src/internal/getDependenciesFromGroup.d.ts
-/**
- * Get the dependencies from a given dependency group in `package.json`.
- *
- * @category Miscellaneous
- *
- * @param packageInfo - The data coming from `package.json`.
- * @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
- *
- * @returns A record consisting of the package names and version ranges from the given dependency group.
- */
-declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>, dependencyGroup: DependencyGroup): Record<string, string>;
-//#endregion
 //#region src/root/types/RecordKey.d.ts
 /**
  * Represents the native Record's possible key type.
@@ -23,6 +10,9 @@ declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>,
 type RecordKey = string | number | symbol;
 //#endregion
 //#region src/root/types/DataError.d.ts
+interface ExpectErrorOptions {
+  expectedCode?: string;
+}
 /**
  * Represents errors you may get that may've been caused by a specific piece of data.
  *
@@ -40,6 +30,7 @@ declare class DataError<DataType extends Record<RecordKey, unknown> = Record<Rec
    * @param options - Extra options to pass to super Error constructor.
    */
   constructor(data: DataType, code?: string, message?: string, options?: ErrorOptions);
+  private static checkCaughtError;
   /**
    * Checks whether the given input may have been caused by a DataError.
    *
@@ -48,6 +39,30 @@ declare class DataError<DataType extends Record<RecordKey, unknown> = Record<Rec
    * @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 Record<RecordKey, unknown> = Record<RecordKey, unknown>>(input: unknown): input is DataError<DataType>;
+  /**
+   * 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.
+   * @param options - Extra options to apply.
+   *
+   * @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+   * @throws {Error} If no `DataError` was thrown by the `errorFunction`
+   *
+   * @returns The `DataError` that was thrown by the `errorFunction`
+   */
+  static expectError(errorFunction: () => unknown, options?: ExpectErrorOptions): 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.
+   *
+   * @param errorFunction - The function expected to throw the error.
+   * @param options - Extra options to apply.
+   *
+   * @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+   * @throws {Error} If no `DataError` was thrown by the `errorFunction`
+   *
+   * @returns The `DataError` that was thrown by the `errorFunction`
+   */
+  static expectErrorAsync(errorFunction: () => Promise<unknown>, options?: ExpectErrorOptions): Promise<DataError>;
 }
 //#endregion
 //#region src/root/types/CreateEnumType.d.ts
@@ -80,6 +95,19 @@ declare const DependencyGroup: {
 };
 type DependencyGroup = CreateEnumType<typeof DependencyGroup>;
 //#endregion
+//#region src/internal/getDependenciesFromGroup.d.ts
+/**
+ * Get the dependencies from a given dependency group in `package.json`.
+ *
+ * @category Miscellaneous
+ *
+ * @param packageInfo - The data coming from `package.json`.
+ * @param dependencyGroup - The group to get dependency information about (can be `dependencies` or `devDependencies`).
+ *
+ * @returns A record consisting of the package names and version ranges from the given dependency group.
+ */
+declare function getDependenciesFromGroup(packageInfo: Record<string, unknown>, dependencyGroup: DependencyGroup): Record<string, string>;
+//#endregion
 //#region src/internal/getExpectedTgzName.d.ts
 declare function getExpectedTgzName(packagePath: string, packageManager: string): Promise<string>;
 //#endregion

package/dist/internal/index.js

@@ -88,6 +88,17 @@ var DataError = class DataError extends Error {
 		Object.defineProperty(this, "message", { enumerable: true });
 		Object.setPrototypeOf(this, new.target.prototype);
 	}
+	static checkCaughtError(error, options) {
+		if (DataError.check(error)) {
+			if (options?.expectedCode && error.code !== options.expectedCode) throw new Error(normaliseIndents`The error code on the thrown error does not match the expected error code.
+            
+            Expected: ${options.expectedCode}
+            Received: ${error.code}
+            `, { cause: error });
+			return error;
+		}
+		throw error;
+	}
 	/**
 	* Checks whether the given input may have been caused by a DataError.
 	*
@@ -100,6 +111,44 @@ var DataError = class DataError extends Error {
 		const data = input;
 		return typeof data === "object" && data !== null && typeof data.message === "string" && typeof data.code === "string" && "data" in data;
 	}
+	/**
+	* 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.
+	* @param options - Extra options to apply.
+	*
+	* @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+	* @throws {Error} If no `DataError` was thrown by the `errorFunction`
+	*
+	* @returns The `DataError` that was thrown by the `errorFunction`
+	*/
+	static expectError(errorFunction, options) {
+		try {
+			errorFunction();
+		} catch (error) {
+			return DataError.checkCaughtError(error, options);
+		}
+		throw new Error("Expected a DataError to be thrown but none was thrown");
+	}
+	/**
+	* 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.
+	*
+	* @param errorFunction - The function expected to throw the error.
+	* @param options - Extra options to apply.
+	*
+	* @throws {Error} Any other errors thrown by the `errorFunction` that are not a `DataError`.
+	* @throws {Error} If no `DataError` was thrown by the `errorFunction`
+	*
+	* @returns The `DataError` that was thrown by the `errorFunction`
+	*/
+	static async expectErrorAsync(errorFunction, options) {
+		try {
+			await errorFunction();
+		} catch (error) {
+			return DataError.checkCaughtError(error, options);
+		}
+		throw new Error("Expected a DataError to be thrown but none was thrown");
+	}
 };
 
 //#endregion