@alextheman/utility 5.24.0 → 5.26.0

package/dist/index.cjs

@@ -858,6 +858,27 @@ function isOrdered(array) {
 	return true;
 }
 //#endregion
+//#region src/root/functions/miscellaneous/memoizeAsync.ts
+/**
+* Memoizes the Promise returned by an asynchronous callback.
+*
+* Note that the callback is invoked at most once. Arguments supplied to subsequent calls are ignored because the Promise from the first invocation is always returned.
+*
+* @template ArgsType - The type of the function arguments.
+* @template ResolvedType - The type of the Promise when resolved.
+*
+* @param callback - The function to memoize.
+*
+* @returns A callback with the Promise memoized. Multiple calls of this function should always point to the same Promise.
+*/
+function memoizeAsync(callback) {
+	let promise;
+	return (...args) => {
+		promise ??= callback(...args);
+		return promise;
+	};
+}
+//#endregion
 //#region src/root/functions/miscellaneous/sayHello.ts
 /**
 * Returns a string representing the lyrics to the package's theme song, Commit To You
@@ -2103,6 +2124,7 @@ exports.isOrdered = isOrdered;
 exports.isSameDate = isSameDate;
 exports.isTemplateStringsArray = isTemplateStringsArray;
 exports.kebabToCamel = kebabToCamel;
+exports.memoizeAsync = memoizeAsync;
 exports.normaliseIndents = normaliseIndents;
 exports.normalizeIndents = normalizeIndents;
 exports.objectContainsKeys = objectContainsKeys;

package/dist/index.d.cts

@@ -1,6 +1,5 @@
 import z, { ZodCoercedDate, ZodCoercedNumber, ZodError, ZodType, z as z$1 } from "zod";
 import { DotenvParseOutput } from "dotenv";
-
 //#region src/root/constants/FILE_PATH_REGEX.d.ts
 declare const FILE_PATH_REGEX_PATTERN: string;
 declare const FILE_PATH_REGEX: RegExp;
@@ -438,6 +437,22 @@ declare function identity<InputType>(input: InputType): InputType;
  */
 declare function isOrdered(array: ReadonlyArray<number>): boolean;
 //#endregion
+//#region src/root/functions/miscellaneous/memoizeAsync.d.ts
+type Callback<ArgsType extends ReadonlyArray<unknown>, ResolvedType> = (...args: ArgsType) => Promise<ResolvedType>;
+/**
+ * Memoizes the Promise returned by an asynchronous callback.
+ *
+ * Note that the callback is invoked at most once. Arguments supplied to subsequent calls are ignored because the Promise from the first invocation is always returned.
+ *
+ * @template ArgsType - The type of the function arguments.
+ * @template ResolvedType - The type of the Promise when resolved.
+ *
+ * @param callback - The function to memoize.
+ *
+ * @returns A callback with the Promise memoized. Multiple calls of this function should always point to the same Promise.
+ */
+declare function memoizeAsync<ArgsType extends ReadonlyArray<unknown>, ResolvedType>(callback: Callback<ArgsType, ResolvedType>): Callback<ArgsType, ResolvedType>;
+//#endregion
 //#region src/root/functions/miscellaneous/sayHello.d.ts
 /**
  * Returns a string representing the lyrics to the package's theme song, Commit To You
@@ -697,10 +712,7 @@ interface StringListToArrayOptions {
  *
  * @returns A new array with each item being an item from the given list.
  */
-declare function stringListToArray(stringList: string, {
-  separator,
-  trimWhitespace
-}?: StringListToArrayOptions): Array<string>;
+declare function stringListToArray(stringList: string, { separator, trimWhitespace }?: StringListToArrayOptions): Array<string>;
 //#endregion
 //#region src/root/functions/miscellaneous/wait.d.ts
 /**
@@ -761,7 +773,7 @@ declare function omitProperties<ObjectType extends object, KeysToOmit extends ke
 declare function pickProperties<ObjectType extends object, KeysToPick extends keyof ObjectType>(object: ObjectType, keysToPick: KeysToPick | ReadonlyArray<KeysToPick>): Pick<ObjectType, KeysToPick>;
 //#endregion
 //#region src/root/functions/objectHelpers/removeUndefinedFromObject.d.ts
-type RemoveUndefined<RecordType extends Record<PropertyKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined> };
+type RemoveUndefined<RecordType extends Record<PropertyKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined>; };
 /**
  * Removes entries whose values are `undefined` from a given object (not including null etc.).
  *
@@ -1499,4 +1511,4 @@ interface ZodParsingErrorData {
   issues: Array<z.core.$ZodIssue>;
 }
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FILE_PATH_REGEX_PATTERN, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FILE_PATH_REGEX_PATTERN, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, memoizeAsync, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import z, { ZodCoercedDate, ZodCoercedNumber, ZodError, ZodType, z as z$1 } from "zod";
 import { DotenvParseOutput } from "dotenv";
-
 //#region src/root/constants/FILE_PATH_REGEX.d.ts
 declare const FILE_PATH_REGEX_PATTERN: string;
 declare const FILE_PATH_REGEX: RegExp;
@@ -438,6 +437,22 @@ declare function identity<InputType>(input: InputType): InputType;
  */
 declare function isOrdered(array: ReadonlyArray<number>): boolean;
 //#endregion
+//#region src/root/functions/miscellaneous/memoizeAsync.d.ts
+type Callback<ArgsType extends ReadonlyArray<unknown>, ResolvedType> = (...args: ArgsType) => Promise<ResolvedType>;
+/**
+ * Memoizes the Promise returned by an asynchronous callback.
+ *
+ * Note that the callback is invoked at most once. Arguments supplied to subsequent calls are ignored because the Promise from the first invocation is always returned.
+ *
+ * @template ArgsType - The type of the function arguments.
+ * @template ResolvedType - The type of the Promise when resolved.
+ *
+ * @param callback - The function to memoize.
+ *
+ * @returns A callback with the Promise memoized. Multiple calls of this function should always point to the same Promise.
+ */
+declare function memoizeAsync<ArgsType extends ReadonlyArray<unknown>, ResolvedType>(callback: Callback<ArgsType, ResolvedType>): Callback<ArgsType, ResolvedType>;
+//#endregion
 //#region src/root/functions/miscellaneous/sayHello.d.ts
 /**
  * Returns a string representing the lyrics to the package's theme song, Commit To You
@@ -697,10 +712,7 @@ interface StringListToArrayOptions {
  *
  * @returns A new array with each item being an item from the given list.
  */
-declare function stringListToArray(stringList: string, {
-  separator,
-  trimWhitespace
-}?: StringListToArrayOptions): Array<string>;
+declare function stringListToArray(stringList: string, { separator, trimWhitespace }?: StringListToArrayOptions): Array<string>;
 //#endregion
 //#region src/root/functions/miscellaneous/wait.d.ts
 /**
@@ -761,7 +773,7 @@ declare function omitProperties<ObjectType extends object, KeysToOmit extends ke
 declare function pickProperties<ObjectType extends object, KeysToPick extends keyof ObjectType>(object: ObjectType, keysToPick: KeysToPick | ReadonlyArray<KeysToPick>): Pick<ObjectType, KeysToPick>;
 //#endregion
 //#region src/root/functions/objectHelpers/removeUndefinedFromObject.d.ts
-type RemoveUndefined<RecordType extends Record<PropertyKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined> };
+type RemoveUndefined<RecordType extends Record<PropertyKey, unknown>> = { [Key in keyof RecordType]: Exclude<RecordType[Key], undefined>; };
 /**
  * Removes entries whose values are `undefined` from a given object (not including null etc.).
  *
@@ -1499,4 +1511,4 @@ interface ZodParsingErrorData {
   issues: Array<z.core.$ZodIssue>;
 }
 //#endregion
-export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FILE_PATH_REGEX_PATTERN, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, type ArrayElement, type CallReturnType, type CamelToKebabOptions, type CreateEnumType, type CreateFormDataOptions, type CreateFormDataOptionsNullableResolution, type CreateFormDataOptionsUndefinedOrNullResolution, DataError, type DisallowUndefined, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FILE_PATH_REGEX_PATTERN, type FormDataArrayResolutionStrategy, type FormDataNullableResolutionStrategy, type HTTPErrorCode, type IgnoreCase, type IsTypeArgumentString, type KebabToCamelOptions, type NonNull, type NonUndefined, type NormaliseIndentsFunction, type NormaliseIndentsOptions, type NormalizeIndentsFunction, type NormalizeIndentsOptions, type NullableOnCondition, ONE_DAY_IN_MILLISECONDS, type OptionalOnCondition, type ParallelTuple, type RecordKey, type RemoveUndefined, SortDirection, type StringListToArrayOptions, type ToTitleCaseOptions, UUID_PATTERN, UUID_REGEX, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, VersionNumber, type FormatOptionsBase as VersionNumberToStringOptions, VersionType, type ZodParsingErrorData, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, memoizeAsync, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/index.js

@@ -834,6 +834,27 @@ function isOrdered(array) {
 	return true;
 }
 //#endregion
+//#region src/root/functions/miscellaneous/memoizeAsync.ts
+/**
+* Memoizes the Promise returned by an asynchronous callback.
+*
+* Note that the callback is invoked at most once. Arguments supplied to subsequent calls are ignored because the Promise from the first invocation is always returned.
+*
+* @template ArgsType - The type of the function arguments.
+* @template ResolvedType - The type of the Promise when resolved.
+*
+* @param callback - The function to memoize.
+*
+* @returns A callback with the Promise memoized. Multiple calls of this function should always point to the same Promise.
+*/
+function memoizeAsync(callback) {
+	let promise;
+	return (...args) => {
+		promise ??= callback(...args);
+		return promise;
+	};
+}
+//#endregion
 //#region src/root/functions/miscellaneous/sayHello.ts
 /**
 * Returns a string representing the lyrics to the package's theme song, Commit To You
@@ -2030,4 +2051,4 @@ const UUID_PATTERN = UUID_REGEX_PATTERN;
 /** @deprecated This has been renamed to `VERSION_NUMBER_REGEX_PATTERN`. */
 const VERSION_NUMBER_PATTERN = String.raw`^(?:v)?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$`;
 //#endregion
-export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FILE_PATH_REGEX_PATTERN, ONE_DAY_IN_MILLISECONDS, SortDirection, UUID_PATTERN, UUID_REGEX, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, VersionNumber, VersionType, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };
+export { APIError, DataError, Env, FILE_PATH_PATTERN, FILE_PATH_REGEX, FILE_PATH_REGEX_PATTERN, ONE_DAY_IN_MILLISECONDS, SortDirection, UUID_PATTERN, UUID_REGEX, UUID_REGEX_PATTERN, VERSION_NUMBER_PATTERN, VERSION_NUMBER_REGEX, VERSION_NUMBER_REGEX_PATTERN, VersionNumber, VersionType, addDaysToDate, appendSemicolon, assertNotNull, assertNotNullable, assertNotUndefined, az, calculateMonthlyDifference, camelToKebab, containsKeys, convertFileToBase64, createFormData, createTemplateStringsArray, deepCopy, deepFreeze, escapeHTML, escapeRegexPattern, fillArray, formatDateAndTime, getRandomNumber, getRecordKeys, getStringsAndInterpolations, httpErrorCodeLookup, identity, interpolate, interpolateObjects, isAnniversary, isLeapYear, isMonthlyMultiple, isNonNullableObject, isOrdered, isSameDate, isTemplateStringsArray, kebabToCamel, memoizeAsync, normaliseIndents, normalizeIndents, objectContainsKeys, omitProperties, paralleliseArrays, parseBoolean, parseEnv, parseFormData, parseIntStrict, parseUUID, parseVersionType, parseZodSchema, parseZodSchemaAsync, pickProperties, randomiseArray, range, removeDuplicates, removeUndefinedFromObject, sayHello, sortBy, stringListToArray, stringifyDotenv, toTitleCase, truncate, wait, zodVersionNumber };

package/dist/internal/index.d.cts

@@ -1,5 +1,6 @@
+import "zod";
+import "dotenv";
 import { ExecaMethod } from "execa";
-
 //#region src/root/types/CreateEnumType.d.ts
 /**
  * Get the value types from a const object so the object can behave similarly to an enum.

package/dist/internal/index.d.ts

@@ -1,5 +1,6 @@
 import z from "zod";
 import { ExecaMethod } from "execa";
+import "dotenv";
 //#region src/root/types/CreateEnumType.d.ts
 /**
  * Get the value types from a const object so the object can behave similarly to an enum.

package/dist/node/index.d.cts

@@ -1,3 +1,5 @@
+import "zod";
+import "dotenv";
 //#region src/node/functions/normalizeImportPath.d.ts
 /**
  * Normalizes an import path meant for use in an import statement in JavaScript.

package/dist/node/index.d.ts

@@ -1,3 +1,5 @@
+import "zod";
+import "dotenv";
 //#region src/node/functions/normalizeImportPath.d.ts
 /**
  * Normalizes an import path meant for use in an import statement in JavaScript.

package/dist/temporal/index.cjs

@@ -0,0 +1,35 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/temporal/formatRelativeDateAndTime.ts
+/**
+* Creates a human-readable string describing the input date relative to the reference date.
+*
+* If no reference date is provided, the current local date and time is used as the reference.
+*
+* @category Temporal
+*
+* @param input - The date and time to format.
+* @param reference - The date and time to compare the input against.
+*
+* @returns A human-readable string describing the input date relative to the reference date.
+*
+* - If the date given is today, the output will be something like `Today at HH:MM`
+* - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+* - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+*/
+function formatRelativeDateAndTime(input, reference = Temporal.Now.plainDateTimeISO()) {
+	const inputPlainDate = input.toPlainDate();
+	const referencePlainDate = reference.toPlainDate();
+	const formattedTime = input.toLocaleString("en-GB", {
+		hour: "2-digit",
+		minute: "2-digit"
+	});
+	if (inputPlainDate.equals(referencePlainDate.subtract({ days: 1 }))) return `Yesterday at ${formattedTime}`;
+	if (inputPlainDate.equals(referencePlainDate)) return `Today at ${formattedTime}`;
+	return `${input.toLocaleString("en-GB", {
+		day: "2-digit",
+		month: "2-digit",
+		year: "numeric"
+	})}, ${formattedTime}`;
+}
+//#endregion
+exports.formatRelativeDateAndTime = formatRelativeDateAndTime;

package/dist/temporal/index.d.cts

@@ -0,0 +1,20 @@
+//#region src/temporal/formatRelativeDateAndTime.d.ts
+/**
+ * Creates a human-readable string describing the input date relative to the reference date.
+ *
+ * If no reference date is provided, the current local date and time is used as the reference.
+ *
+ * @category Temporal
+ *
+ * @param input - The date and time to format.
+ * @param reference - The date and time to compare the input against.
+ *
+ * @returns A human-readable string describing the input date relative to the reference date.
+ *
+ * - If the date given is today, the output will be something like `Today at HH:MM`
+ * - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+ * - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+ */
+declare function formatRelativeDateAndTime(input: Temporal.PlainDateTime | Temporal.ZonedDateTime, reference?: Temporal.PlainDateTime | Temporal.ZonedDateTime): string;
+//#endregion
+export { formatRelativeDateAndTime };

package/dist/temporal/index.d.ts

@@ -0,0 +1,20 @@
+//#region src/temporal/formatRelativeDateAndTime.d.ts
+/**
+ * Creates a human-readable string describing the input date relative to the reference date.
+ *
+ * If no reference date is provided, the current local date and time is used as the reference.
+ *
+ * @category Temporal
+ *
+ * @param input - The date and time to format.
+ * @param reference - The date and time to compare the input against.
+ *
+ * @returns A human-readable string describing the input date relative to the reference date.
+ *
+ * - If the date given is today, the output will be something like `Today at HH:MM`
+ * - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+ * - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+ */
+declare function formatRelativeDateAndTime(input: Temporal.PlainDateTime | Temporal.ZonedDateTime, reference?: Temporal.PlainDateTime | Temporal.ZonedDateTime): string;
+//#endregion
+export { formatRelativeDateAndTime };

package/dist/temporal/index.js

@@ -0,0 +1,34 @@
+//#region src/temporal/formatRelativeDateAndTime.ts
+/**
+* Creates a human-readable string describing the input date relative to the reference date.
+*
+* If no reference date is provided, the current local date and time is used as the reference.
+*
+* @category Temporal
+*
+* @param input - The date and time to format.
+* @param reference - The date and time to compare the input against.
+*
+* @returns A human-readable string describing the input date relative to the reference date.
+*
+* - If the date given is today, the output will be something like `Today at HH:MM`
+* - If the date given happened yesterday, the output will be something like `Yesterday at HH:MM`
+* - For any other date, the output will be something like `DD/MM/YYYY, HH:MM`
+*/
+function formatRelativeDateAndTime(input, reference = Temporal.Now.plainDateTimeISO()) {
+	const inputPlainDate = input.toPlainDate();
+	const referencePlainDate = reference.toPlainDate();
+	const formattedTime = input.toLocaleString("en-GB", {
+		hour: "2-digit",
+		minute: "2-digit"
+	});
+	if (inputPlainDate.equals(referencePlainDate.subtract({ days: 1 }))) return `Yesterday at ${formattedTime}`;
+	if (inputPlainDate.equals(referencePlainDate)) return `Today at ${formattedTime}`;
+	return `${input.toLocaleString("en-GB", {
+		day: "2-digit",
+		month: "2-digit",
+		year: "numeric"
+	})}, ${formattedTime}`;
+}
+//#endregion
+export { formatRelativeDateAndTime };

package/dist/v6/index.d.cts

@@ -1,3 +1,5 @@
+import "zod";
+import "dotenv";
 //#region src/root/types/CreateEnumType.d.ts
 /**
  * Get the value types from a const object so the object can behave similarly to an enum.

package/dist/v6/index.d.ts

@@ -1,3 +1,5 @@
+import "zod";
+import "dotenv";
 //#region src/root/types/CreateEnumType.d.ts
 /**
  * Get the value types from a const object so the object can behave similarly to an enum.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.24.0",
+  "version": "5.26.0",
   "description": "Helpful utility functions.",
   "repository": {
     "type": "git",
@@ -26,6 +26,11 @@
       "import": "./dist/node/index.js",
       "require": "./dist/node/index.cjs"
     },
+    "./temporal": {
+      "types": "./dist/temporal/index.d.ts",
+      "import": "./dist/temporal/index.js",
+      "require": "./dist/temporal/index.cjs"
+    },
     "./v6": {
       "types": "./dist/v6/index.d.ts",
       "import": "./dist/v6/index.js",
@@ -41,8 +46,8 @@
   },
   "devDependencies": {
     "@alextheman/eslint-plugin": "5.18.0",
-    "@types/node": "26.1.0",
-    "alex-c-line": "2.11.3",
+    "@types/node": "26.1.1",
+    "alex-c-line": "2.12.4",
     "cross-env": "10.1.0",
     "dotenv-cli": "11.0.0",
     "eslint": "10.6.0",
@@ -50,17 +55,17 @@
     "husky": "9.1.7",
     "jsdom": "29.1.1",
     "markdownlint-cli2": "0.23.0",
-    "prettier": "3.9.4",
+    "prettier": "3.9.5",
     "tempy": "3.2.0",
-    "tsdown": "0.22.3",
+    "tsdown": "0.22.4",
     "tsx": "4.23.0",
-    "typedoc": "0.28.19",
+    "typedoc": "0.28.20",
     "typedoc-plugin-markdown": "4.12.0",
     "typedoc-rhineai-theme": "1.2.0",
     "typescript": "6.0.3",
-    "typescript-eslint": "8.62.1",
-    "vite": "8.1.3",
-    "vitest": "4.1.9",
+    "typescript-eslint": "8.63.0",
+    "vite": "8.1.4",
+    "vitest": "4.1.10",
     "zod": "4.4.3"
   },
   "engines": {