@natch-the-storage/heathershaw-platform-types 1.18.13 → 1.18.14

package/build/validators.d.ts

@@ -83,12 +83,27 @@ export declare function getCurrentIsoTimestamp(): string;
  * @returns
  */
 export declare function formatDate(dateStr?: string | null, toDmy?: boolean): string;
+/**
+ * Formats a date into a readable format
+ * @param date typically in ISO format - (yyyy-mm-ddThh:mm:sszz)
+ * @param time adds the time to the string
+ * @param toDmy format the date as dd/mm/yyyy instead
+ * @returns
+ */
+export declare function formatIsoTimestamp({ date, time, toDmy, }: {
+    date: string;
+    time?: boolean;
+    toDmy?: boolean;
+}): string;
 /**
  * Gets the age in years based on todays date vs the date of birth
  * @param dateOfBirth An isoDate (yyyy-mm-dd) string
  * @returns The age in years
  */
 export declare function getAge(dateOfBirth: string): number;
+/**
+ * Formats an address object into a human readable format
+ */
 export declare function formatAddress(addr: Address): string;
 export interface Address {
     street: string;

package/build/validators.js

@@ -243,6 +243,34 @@ export function formatDate(dateStr, toDmy) {
         year: 'numeric',
     });
 }
+/**
+ * Formats a date into a readable format
+ * @param date typically in ISO format - (yyyy-mm-ddThh:mm:sszz)
+ * @param time adds the time to the string
+ * @param toDmy format the date as dd/mm/yyyy instead
+ * @returns
+ */
+export function formatIsoTimestamp({ date, time, toDmy, }) {
+    const d = new Date(date);
+    if (toDmy) {
+        return d.toLocaleDateString('en-AU', {
+            day: '2-digit',
+            month: '2-digit',
+            year: 'numeric',
+            hour: time ? '2-digit' : undefined,
+            minute: time ? '2-digit' : undefined,
+            timeZone: '+11',
+        });
+    }
+    return d.toLocaleDateString('en-AU', {
+        day: '2-digit',
+        month: 'short',
+        year: 'numeric',
+        hour: time ? '2-digit' : undefined,
+        minute: time ? '2-digit' : undefined,
+        timeZone: '+11',
+    });
+}
 /**
  * Gets the age in years based on todays date vs the date of birth
  * @param dateOfBirth An isoDate (yyyy-mm-dd) string
@@ -258,6 +286,9 @@ export function getAge(dateOfBirth) {
         age -= 1;
     return age;
 }
+/**
+ * Formats an address object into a human readable format
+ */
 export function formatAddress(addr) {
     return `${addr.street}, ${addr.suburb} ${addr.state} ${addr.postcode}`;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@natch-the-storage/heathershaw-platform-types",
-  "version": "1.18.13",
+  "version": "1.18.14",
   "description": "Interfaces and routes to use on the client",
   "license": "ISC",
   "author": "Natch Surana",