feat: add support for long format in multi unit string (#500)

* feat: add support for long format in multi unit string

Author: arjunlalb

projects/common/src/time/time-duration.test.ts

@@ -1,4 +1,4 @@
-import { TimeDuration } from './time-duration';
+import { TimeDuration, UnitStringType } from './time-duration';
 import { TimeUnit } from './time-unit.type';
 
 describe('Time duration', () => {
@@ -13,6 +13,13 @@ describe('Time duration', () => {
         TimeUnit.Minute
       )
     ).toBe('4h3m');
+    expect(
+      new TimeDuration(4 * 60 * 60 * 1000 + 3 * 60 * 1000 + 5 * 1000 + 689, TimeUnit.Millisecond).toMultiUnitString(
+        TimeUnit.Minute,
+        false,
+        UnitStringType.Long
+      )
+    ).toBe('4 hours 3 minutes');
     expect(
       new TimeDuration(4 * 60 * 60 * 1000 + 5 * 1000 + 689, TimeUnit.Millisecond).toMultiUnitString(TimeUnit.Second)
     ).toBe('4h5s');

projects/common/src/time/time-duration.ts

@@ -16,20 +16,30 @@ export class TimeDuration {
     return this.toMillis() / this.unitInMillis(unit);
   }
 
-  public toMultiUnitString(smallestUnit: ConvertibleTimeUnit = TimeUnit.Second, displayZero: boolean = true): string {
+  public toMultiUnitString(
+    smallestUnit: ConvertibleTimeUnit = TimeUnit.Second,
+    displayZero: boolean = true,
+    unitStringType: UnitStringType = UnitStringType.Short
+  ): string {
     const mostSignificantPortion = this.getMostSignificantUnitOnly();
     const remainingMillis = this.millis - mostSignificantPortion.toMillis();
     if (mostSignificantPortion.getAmountForUnit(smallestUnit) < 1) {
-      return displayZero ? new TimeDuration(0, smallestUnit).toString() : '';
+      return displayZero ? new TimeDuration(0, smallestUnit).toFormattedString(unitStringType) : '';
     }
     if (mostSignificantPortion.unit === smallestUnit || remainingMillis === 0) {
-      return mostSignificantPortion.toString();
+      return mostSignificantPortion.toFormattedString(unitStringType);
     }
 
-    return `${mostSignificantPortion.toString()}${new TimeDuration(
-      remainingMillis,
-      TimeUnit.Millisecond
-    ).toMultiUnitString(smallestUnit, false)}`;
+    const joiningStr = unitStringType === UnitStringType.Long ? ' ' : '';
+
+    return [
+      mostSignificantPortion.toFormattedString(unitStringType),
+      new TimeDuration(remainingMillis, TimeUnit.Millisecond).toMultiUnitString(smallestUnit, false, unitStringType)
+    ].join(joiningStr);
+  }
+
+  private toFormattedString(unitStringType: UnitStringType = UnitStringType.Short): string {
+    return unitStringType === UnitStringType.Short ? this.toString() : this.toLongString();
   }
 
   public getMostSignificantUnitOnly(): TimeDuration {
@@ -141,3 +151,8 @@ type ConvertibleTimeUnit =
   | TimeUnit.Minute
   | TimeUnit.Second
   | TimeUnit.Millisecond;
+
+export enum UnitStringType {
+  Long = 'long',
+  Short = 'short'
+}