Allow time to be excluded when calling formatDateTime

Author: acelaya

src/util/date-and-time.ts

@@ -247,8 +247,11 @@ export type FormatDateTimeOptions = {
    */
   includeWeekday?: boolean;
 
-  /** Test seam. JS `Intl` API implementation. */
-  Intl?: IntlType;
+  /**
+   * Whether the formatted date should include the time (hours and minutes) or not.
+   * Defaults to `true`.
+   */
+  includeTime?: boolean;
 };
 
 /**
@@ -261,18 +264,20 @@ export type FormatDateTimeOptions = {
  */
 export function formatDateTime(
   date: Date | string,
-  options?: FormatDateTimeOptions,
+  { includeWeekday = false, includeTime = true }: FormatDateTimeOptions = {},
+  /* istanbul ignore next - Test seam. JS `Intl` API implementation. */
+  Intl?: IntlType,
 ): string {
   return format(
     typeof date === 'string' ? new Date(date) : date,
     {
       year: 'numeric',
       month: 'short',
       day: '2-digit',
-      weekday: options?.includeWeekday ? 'long' : undefined,
-      hour: '2-digit',
-      minute: '2-digit',
+      weekday: includeWeekday ? 'long' : undefined,
+      hour: includeTime ? '2-digit' : undefined,
+      minute: includeTime ? '2-digit' : undefined,
     },
-    options?.Intl,
+    Intl,
   );
 }

src/util/test/date-and-time-test.js

@@ -238,28 +238,63 @@ describe('date-and-time', () => {
       {
         locale: 'en-US',
         date: new Date('2020-05-04T23:02:01'),
-        includeWeekday: true,
+        expectedResult: 'May 04, 2020, 11:02 PM',
+      },
+      {
+        locale: 'en-US',
+        date: new Date('2020-05-04T23:02:01'),
+        options: { includeWeekday: true },
         expectedResult: 'Monday, May 04, 2020, 11:02 PM',
       },
       {
         locale: 'de-DE',
         date: new Date('2020-05-04T23:02:01'),
-        includeWeekday: true,
+        options: { includeWeekday: true },
         expectedResult: 'Montag, 04. Mai 2020, 23:02',
       },
       {
         locale: 'en-US',
         date: '2020-05-04T23:02:01',
-        includeWeekday: false,
+        options: { includeWeekday: false },
         expectedResult: 'May 04, 2020, 11:02 PM',
       },
       {
         locale: 'de-DE',
         date: '2020-05-04T23:02:01',
-        includeWeekday: false,
+        options: { includeWeekday: false },
         expectedResult: '04. Mai 2020, 23:02',
       },
-    ].forEach(({ locale, includeWeekday, expectedResult, date }) => {
+      {
+        locale: 'de-DE',
+        date: '2020-05-04T23:02:01',
+        options: { includeTime: false },
+        expectedResult: '04. Mai 2020',
+      },
+      {
+        locale: 'en-US',
+        date: '2020-05-04T23:02:01',
+        options: { includeTime: false },
+        expectedResult: 'May 04, 2020',
+      },
+      {
+        locale: 'de-DE',
+        date: '2020-05-04T23:02:01',
+        options: {
+          includeTime: false,
+          includeWeekday: true,
+        },
+        expectedResult: 'Montag, 04. Mai 2020',
+      },
+      {
+        locale: 'en-US',
+        date: '2020-05-04T23:02:01',
+        options: {
+          includeTime: false,
+          includeWeekday: true,
+        },
+        expectedResult: 'Monday, May 04, 2020',
+      },
+    ].forEach(({ locale, options, expectedResult, date }) => {
       it('returns absolute formatted date', () => {
         const fakeIntl = locale => ({
           DateTimeFormat: function (_, options) {
@@ -268,9 +303,7 @@ describe('date-and-time', () => {
         });
 
         assert.equal(
-          normalizeSpaces(
-            formatDateTime(date, { Intl: fakeIntl(locale), includeWeekday }),
-          ),
+          normalizeSpaces(formatDateTime(date, options, fakeIntl(locale))),
           expectedResult,
         );
       });