@alextheman/utility 5.24.0 → 5.25.0

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alextheman/utility",
-  "version": "5.24.0",
+  "version": "5.25.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",