@alextheman/utility 5.11.3 → 5.12.0

package/dist/index.cjs

@@ -784,83 +784,6 @@ function isOrdered(array) {
 	return true;
 }
 //#endregion
-//#region src/root/functions/recursive/deepFreeze.ts
-/**
-* Deeply freezes an object or array such that all child objects/arrays are also frozen.
-*
-* Note that this will also freeze the input itself as well.
-* If the intent is to create a newly frozen object with a different reference in memory, pass your object through deepCopy first before passing to deepFreeze.
-*
-* @category Recursive
-*
-* @template ObjectType - The type of the input object.
-*
-* @param object - The object to freeze. May also be an array.
-*
-* @returns The input object completely frozen.
-*/
-function deepFreeze(object) {
-	for (const value of Object.values(object)) {
-		if (typeof value === "function") continue;
-		if (value && typeof value === "object") deepFreeze(value);
-	}
-	return Object.freeze(object);
-}
-//#endregion
-//#region src/root/functions/taggedTemplate/createTemplateStringsArray.ts
-/**
-* Creates a template strings array given a regular array of strings
-*
-* @category Tagged Template
-*
-* @param strings - The array of strings.
-*
-* @returns A template strings array that can be passed as the first argument of any tagged template function.
-*/
-function createTemplateStringsArray(strings) {
-	return deepFreeze(Object.assign([...strings], { raw: [...strings] }));
-}
-//#endregion
-//#region src/root/functions/taggedTemplate/getStringsAndInterpolations.ts
-/**
-*
-* Gets the strings and interpolations separately from a template string.
-* You can pass a template string directly by doing:
-*
-* ```typescript
-* getStringsAndInterpolations`Template string here`;
-* ```
-*
-* @category Tagged Template
-*
-* @template InterpolationsType - The type of the interpolations.
-*
-* @param strings - The strings from the template to process.
-* @param interpolations - An array of all interpolations from the template.
-*
-* @returns A tuple where the first item is the strings from the template, and the remaining items are the interpolations.
-*
-* The return of this function may also be spread into any other tagged template function in the following way:
-*
-* ```typescript
-* import { interpolate } from "@alextheman/utility"; // Example function
-*
-* const packageName = "@alextheman/utility";
-* const packageManager = getPackageManager(packageName);
-*
-* interpolate(...getStringsAndInterpolations`The package ${packageName} uses the ${packageManager} package manager.`);
-* ```
-*/
-function getStringsAndInterpolations(strings, ...interpolations) {
-	if (strings.length !== interpolations.length + 1) throw new DataError({
-		stringsLength: strings.length,
-		interpolationsLength: interpolations.length,
-		strings,
-		interpolations
-	}, "INVALID_STRINGS_AND_INTERPOLATIONS_LENGTH", "The length of the strings must be exactly one more than the length of the interpolations.");
-	return [createTemplateStringsArray(strings), ...interpolations];
-}
-//#endregion
 //#region src/root/functions/taggedTemplate/interpolate.ts
 /**
 * Returns the result of interpolating a template string when given the strings and interpolations separately.
@@ -888,48 +811,6 @@ function interpolate(strings, ...interpolations) {
 	return result;
 }
 //#endregion
-//#region src/root/functions/taggedTemplate/interpolateObjects.ts
-/**
-* Returns the result of interpolating a template string, also stringifying objects.
-*
-* You can pass a template string directly by doing:
-*
-* ```typescript
-* interpolateObjects`Template string here ${{ my: "object" }}`;
-* ```
-*
-* @category Tagged Template
-*
-* @template InterpolationsType - The type of the interpolations.
-*
-* @param strings - The strings from the template to process.
-* @param interpolations - An array of all interpolations from the template.
-*
-* @returns A new string with the strings and interpolations from the template applied, with objects stringified.
-*/
-function interpolateObjects(strings, ...interpolations) {
-	let result = "";
-	for (let i = 0; i < strings.length; i++) {
-		result += strings[i];
-		if (i !== strings.length - 1) result += interpolations[i] && typeof interpolations[i] === "object" ? JSON.stringify(interpolations[i]) : interpolations[i];
-	}
-	return result;
-}
-//#endregion
-//#region src/root/functions/taggedTemplate/isTemplateStringsArray.ts
-/**
-* Determines whether or not the input is a valid `TemplateStringsArray`.
-*
-* @category Tagged Template
-*
-* @param input - The input to check
-*
-* @returns `true` if the input is a valid `TemplateStringsArray`, and false otherwise. The type of the input will also be narrowed down to `TemplateStringsArray` if `true`.
-*/
-function isTemplateStringsArray(input) {
-	return typeof input === "object" && input !== null && "raw" in input;
-}
-//#endregion
 //#region src/root/functions/taggedTemplate/normaliseIndents.ts
 function calculateTabSize(line, whitespaceLength) {
 	const potentialWhitespacePart = line.slice(0, whitespaceLength);
@@ -1462,6 +1343,29 @@ function deepCopy(object) {
 	return clonedObject;
 }
 //#endregion
+//#region src/root/functions/recursive/deepFreeze.ts
+/**
+* Deeply freezes an object or array such that all child objects/arrays are also frozen.
+*
+* Note that this will also freeze the input itself as well.
+* If the intent is to create a newly frozen object with a different reference in memory, pass your object through deepCopy first before passing to deepFreeze.
+*
+* @category Recursive
+*
+* @template ObjectType - The type of the input object.
+*
+* @param object - The object to freeze. May also be an array.
+*
+* @returns The input object completely frozen.
+*/
+function deepFreeze(object) {
+	for (const value of Object.values(object)) {
+		if (typeof value === "function") continue;
+		if (value && typeof value === "object") deepFreeze(value);
+	}
+	return Object.freeze(object);
+}
+//#endregion
 //#region src/root/functions/stringHelpers/appendSemicolon.ts
 /**
 * Appends a semicolon to the end of a string, trimming where necessary first.
@@ -1613,6 +1517,102 @@ function truncate(stringToTruncate, maxLength = 5) {
 	return stringToTruncate.length > maxLength ? `${stringToTruncate.slice(0, maxLength)}...` : stringToTruncate;
 }
 //#endregion
+//#region src/root/functions/taggedTemplate/createTemplateStringsArray.ts
+/**
+* Creates a template strings array given a regular array of strings
+*
+* @category Tagged Template
+*
+* @param strings - The array of strings.
+*
+* @returns A template strings array that can be passed as the first argument of any tagged template function.
+*/
+function createTemplateStringsArray(strings) {
+	return deepFreeze(Object.assign([...strings], { raw: [...strings] }));
+}
+//#endregion
+//#region src/root/functions/taggedTemplate/getStringsAndInterpolations.ts
+/**
+*
+* Gets the strings and interpolations separately from a template string.
+* You can pass a template string directly by doing:
+*
+* ```typescript
+* getStringsAndInterpolations`Template string here`;
+* ```
+*
+* @category Tagged Template
+*
+* @template InterpolationsType - The type of the interpolations.
+*
+* @param strings - The strings from the template to process.
+* @param interpolations - An array of all interpolations from the template.
+*
+* @returns A tuple where the first item is the strings from the template, and the remaining items are the interpolations.
+*
+* The return of this function may also be spread into any other tagged template function in the following way:
+*
+* ```typescript
+* import { interpolate } from "@alextheman/utility"; // Example function
+*
+* const packageName = "@alextheman/utility";
+* const packageManager = getPackageManager(packageName);
+*
+* interpolate(...getStringsAndInterpolations`The package ${packageName} uses the ${packageManager} package manager.`);
+* ```
+*/
+function getStringsAndInterpolations(strings, ...interpolations) {
+	if (strings.length !== interpolations.length + 1) throw new DataError({
+		stringsLength: strings.length,
+		interpolationsLength: interpolations.length,
+		strings,
+		interpolations
+	}, "INVALID_STRINGS_AND_INTERPOLATIONS_LENGTH", "The length of the strings must be exactly one more than the length of the interpolations.");
+	return [createTemplateStringsArray(strings), ...interpolations];
+}
+//#endregion
+//#region src/root/functions/taggedTemplate/interpolateObjects.ts
+/**
+* Returns the result of interpolating a template string, also stringifying objects.
+*
+* You can pass a template string directly by doing:
+*
+* ```typescript
+* interpolateObjects`Template string here ${{ my: "object" }}`;
+* ```
+*
+* @category Tagged Template
+*
+* @template InterpolationsType - The type of the interpolations.
+*
+* @param strings - The strings from the template to process.
+* @param interpolations - An array of all interpolations from the template.
+*
+* @returns A new string with the strings and interpolations from the template applied, with objects stringified.
+*/
+function interpolateObjects(strings, ...interpolations) {
+	let result = "";
+	for (let i = 0; i < strings.length; i++) {
+		result += strings[i];
+		if (i !== strings.length - 1) result += interpolations[i] && typeof interpolations[i] === "object" ? JSON.stringify(interpolations[i]) : interpolations[i];
+	}
+	return result;
+}
+//#endregion
+//#region src/root/functions/taggedTemplate/isTemplateStringsArray.ts
+/**
+* Determines whether or not the input is a valid `TemplateStringsArray`.
+*
+* @category Tagged Template
+*
+* @param input - The input to check
+*
+* @returns `true` if the input is a valid `TemplateStringsArray`, and false otherwise. The type of the input will also be narrowed down to `TemplateStringsArray` if `true`.
+*/
+function isTemplateStringsArray(input) {
+	return typeof input === "object" && input !== null && "raw" in input;
+}
+//#endregion
 exports.APIError = APIError;
 exports.DataError = DataError;
 exports.Env = Env;

package/dist/index.js

@@ -760,83 +760,6 @@ function isOrdered(array) {
 	return true;
 }
 //#endregion
-//#region src/root/functions/recursive/deepFreeze.ts
-/**
-* Deeply freezes an object or array such that all child objects/arrays are also frozen.
-*
-* Note that this will also freeze the input itself as well.
-* If the intent is to create a newly frozen object with a different reference in memory, pass your object through deepCopy first before passing to deepFreeze.
-*
-* @category Recursive
-*
-* @template ObjectType - The type of the input object.
-*
-* @param object - The object to freeze. May also be an array.
-*
-* @returns The input object completely frozen.
-*/
-function deepFreeze(object) {
-	for (const value of Object.values(object)) {
-		if (typeof value === "function") continue;
-		if (value && typeof value === "object") deepFreeze(value);
-	}
-	return Object.freeze(object);
-}
-//#endregion
-//#region src/root/functions/taggedTemplate/createTemplateStringsArray.ts
-/**
-* Creates a template strings array given a regular array of strings
-*
-* @category Tagged Template
-*
-* @param strings - The array of strings.
-*
-* @returns A template strings array that can be passed as the first argument of any tagged template function.
-*/
-function createTemplateStringsArray(strings) {
-	return deepFreeze(Object.assign([...strings], { raw: [...strings] }));
-}
-//#endregion
-//#region src/root/functions/taggedTemplate/getStringsAndInterpolations.ts
-/**
-*
-* Gets the strings and interpolations separately from a template string.
-* You can pass a template string directly by doing:
-*
-* ```typescript
-* getStringsAndInterpolations`Template string here`;
-* ```
-*
-* @category Tagged Template
-*
-* @template InterpolationsType - The type of the interpolations.
-*
-* @param strings - The strings from the template to process.
-* @param interpolations - An array of all interpolations from the template.
-*
-* @returns A tuple where the first item is the strings from the template, and the remaining items are the interpolations.
-*
-* The return of this function may also be spread into any other tagged template function in the following way:
-*
-* ```typescript
-* import { interpolate } from "@alextheman/utility"; // Example function
-*
-* const packageName = "@alextheman/utility";
-* const packageManager = getPackageManager(packageName);
-*
-* interpolate(...getStringsAndInterpolations`The package ${packageName} uses the ${packageManager} package manager.`);
-* ```
-*/
-function getStringsAndInterpolations(strings, ...interpolations) {
-	if (strings.length !== interpolations.length + 1) throw new DataError({
-		stringsLength: strings.length,
-		interpolationsLength: interpolations.length,
-		strings,
-		interpolations
-	}, "INVALID_STRINGS_AND_INTERPOLATIONS_LENGTH", "The length of the strings must be exactly one more than the length of the interpolations.");
-	return [createTemplateStringsArray(strings), ...interpolations];
-}
-//#endregion
 //#region src/root/functions/taggedTemplate/interpolate.ts
 /**
 * Returns the result of interpolating a template string when given the strings and interpolations separately.
@@ -864,48 +787,6 @@ function interpolate(strings, ...interpolations) {
 	return result;
 }
 //#endregion
-//#region src/root/functions/taggedTemplate/interpolateObjects.ts
-/**
-* Returns the result of interpolating a template string, also stringifying objects.
-*
-* You can pass a template string directly by doing:
-*
-* ```typescript
-* interpolateObjects`Template string here ${{ my: "object" }}`;
-* ```
-*
-* @category Tagged Template
-*
-* @template InterpolationsType - The type of the interpolations.
-*
-* @param strings - The strings from the template to process.
-* @param interpolations - An array of all interpolations from the template.
-*
-* @returns A new string with the strings and interpolations from the template applied, with objects stringified.
-*/
-function interpolateObjects(strings, ...interpolations) {
-	let result = "";
-	for (let i = 0; i < strings.length; i++) {
-		result += strings[i];
-		if (i !== strings.length - 1) result += interpolations[i] && typeof interpolations[i] === "object" ? JSON.stringify(interpolations[i]) : interpolations[i];
-	}
-	return result;
-}
-//#endregion
-//#region src/root/functions/taggedTemplate/isTemplateStringsArray.ts
-/**
-* Determines whether or not the input is a valid `TemplateStringsArray`.
-*
-* @category Tagged Template
-*
-* @param input - The input to check
-*
-* @returns `true` if the input is a valid `TemplateStringsArray`, and false otherwise. The type of the input will also be narrowed down to `TemplateStringsArray` if `true`.
-*/
-function isTemplateStringsArray(input) {
-	return typeof input === "object" && input !== null && "raw" in input;
-}
-//#endregion
 //#region src/root/functions/taggedTemplate/normaliseIndents.ts
 function calculateTabSize(line, whitespaceLength) {
 	const potentialWhitespacePart = line.slice(0, whitespaceLength);
@@ -1438,6 +1319,29 @@ function deepCopy(object) {
 	return clonedObject;
 }
 //#endregion
+//#region src/root/functions/recursive/deepFreeze.ts
+/**
+* Deeply freezes an object or array such that all child objects/arrays are also frozen.
+*
+* Note that this will also freeze the input itself as well.
+* If the intent is to create a newly frozen object with a different reference in memory, pass your object through deepCopy first before passing to deepFreeze.
+*
+* @category Recursive
+*
+* @template ObjectType - The type of the input object.
+*
+* @param object - The object to freeze. May also be an array.
+*
+* @returns The input object completely frozen.
+*/
+function deepFreeze(object) {
+	for (const value of Object.values(object)) {
+		if (typeof value === "function") continue;
+		if (value && typeof value === "object") deepFreeze(value);
+	}
+	return Object.freeze(object);
+}
+//#endregion
 //#region src/root/functions/stringHelpers/appendSemicolon.ts
 /**
 * Appends a semicolon to the end of a string, trimming where necessary first.
@@ -1589,4 +1493,100 @@ function truncate(stringToTruncate, maxLength = 5) {
 	return stringToTruncate.length > maxLength ? `${stringToTruncate.slice(0, maxLength)}...` : stringToTruncate;
 }
 //#endregion
+//#region src/root/functions/taggedTemplate/createTemplateStringsArray.ts
+/**
+* Creates a template strings array given a regular array of strings
+*
+* @category Tagged Template
+*
+* @param strings - The array of strings.
+*
+* @returns A template strings array that can be passed as the first argument of any tagged template function.
+*/
+function createTemplateStringsArray(strings) {
+	return deepFreeze(Object.assign([...strings], { raw: [...strings] }));
+}
+//#endregion
+//#region src/root/functions/taggedTemplate/getStringsAndInterpolations.ts
+/**
+*
+* Gets the strings and interpolations separately from a template string.
+* You can pass a template string directly by doing:
+*
+* ```typescript
+* getStringsAndInterpolations`Template string here`;
+* ```
+*
+* @category Tagged Template
+*
+* @template InterpolationsType - The type of the interpolations.
+*
+* @param strings - The strings from the template to process.
+* @param interpolations - An array of all interpolations from the template.
+*
+* @returns A tuple where the first item is the strings from the template, and the remaining items are the interpolations.
+*
+* The return of this function may also be spread into any other tagged template function in the following way:
+*
+* ```typescript
+* import { interpolate } from "@alextheman/utility"; // Example function
+*
+* const packageName = "@alextheman/utility";
+* const packageManager = getPackageManager(packageName);
+*
+* interpolate(...getStringsAndInterpolations`The package ${packageName} uses the ${packageManager} package manager.`);
+* ```
+*/
+function getStringsAndInterpolations(strings, ...interpolations) {
+	if (strings.length !== interpolations.length + 1) throw new DataError({
+		stringsLength: strings.length,
+		interpolationsLength: interpolations.length,
+		strings,
+		interpolations
+	}, "INVALID_STRINGS_AND_INTERPOLATIONS_LENGTH", "The length of the strings must be exactly one more than the length of the interpolations.");
+	return [createTemplateStringsArray(strings), ...interpolations];
+}
+//#endregion
+//#region src/root/functions/taggedTemplate/interpolateObjects.ts
+/**
+* Returns the result of interpolating a template string, also stringifying objects.
+*
+* You can pass a template string directly by doing:
+*
+* ```typescript
+* interpolateObjects`Template string here ${{ my: "object" }}`;
+* ```
+*
+* @category Tagged Template
+*
+* @template InterpolationsType - The type of the interpolations.
+*
+* @param strings - The strings from the template to process.
+* @param interpolations - An array of all interpolations from the template.
+*
+* @returns A new string with the strings and interpolations from the template applied, with objects stringified.
+*/
+function interpolateObjects(strings, ...interpolations) {
+	let result = "";
+	for (let i = 0; i < strings.length; i++) {
+		result += strings[i];
+		if (i !== strings.length - 1) result += interpolations[i] && typeof interpolations[i] === "object" ? JSON.stringify(interpolations[i]) : interpolations[i];
+	}
+	return result;
+}
+//#endregion
+//#region src/root/functions/taggedTemplate/isTemplateStringsArray.ts
+/**
+* Determines whether or not the input is a valid `TemplateStringsArray`.
+*
+* @category Tagged Template
+*
+* @param input - The input to check
+*
+* @returns `true` if the input is a valid `TemplateStringsArray`, and false otherwise. The type of the input will also be narrowed down to `TemplateStringsArray` if `true`.
+*/
+function isTemplateStringsArray(input) {
+	return typeof input === "object" && input !== null && "raw" in input;
+}
+//#endregion
 export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, ONE_DAY_IN_MILLISECONDS, UUID_PATTERN, UUID_REGEX, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VersionNumber, VersionType, addDaysToDate, appendSemicolon, 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 };