Merge pull request #43 from nshiab/42-month-day-format-for-dates

adding Month options to formatDateLocal and formatData

Author: nshiab

src/format/formatDate.ts

@@ -19,7 +19,8 @@ export default function formatDate(
         | "YYYY-MM-DD"
         | "Month Day, YYYY"
         | "Month Day, YYYY, at HH:MM period"
-        | "DayName",
+        | "DayName"
+        | "Month",
     options: {
         style?: "cbc" | "rc"
         abbreviations?: boolean
@@ -57,6 +58,8 @@ export default function formatDate(
         dateFormatted = dateToString(date, representations[mergedOptions.style])
     } else if (format === "DayName") {
         dateFormatted = dateToString(date, "%A")
+    } else if (format === "Month") {
+        dateFormatted = dateToString(date, "%B")
     } else {
         throw new Error("Unknown format")
     }

src/format/formatDateLocal.ts

@@ -19,7 +19,8 @@ export default function formatDateLocal(
         | "YYYY-MM-DD"
         | "Month Day, YYYY"
         | "Month Day, YYYY, at HH:MM period"
-        | "DayName",
+        | "DayName"
+        | "Month",
     options: {
         style?: "cbc" | "rc"
         abbreviations?: boolean
@@ -57,6 +58,8 @@ export default function formatDateLocal(
         dateFormatted = dateToString(date, representations[mergedOptions.style])
     } else if (format === "DayName") {
         dateFormatted = dateToString(date, "%A")
+    } else if (format === "Month") {
+        dateFormatted = dateToString(date, "%B")
     } else {
         throw new Error("Unknown format")
     }

test/format/formatDate.test.ts

@@ -56,6 +56,16 @@ describe("formatDate", () => {
         })
         assert.strictEqual(formattedDate, "Sun.")
     })
+    it("should return the full month name", () => {
+        const formattedDate = formatDate(date, "Month")
+        assert.strictEqual(formattedDate, "January")
+    })
+    it("should return the abbreviated month name", () => {
+        const formattedDate = formatDate(date, "Month", {
+            abbreviations: true,
+        })
+        assert.strictEqual(formattedDate, "Jan.")
+    })
 
     // Radio-Canada style
 
@@ -111,4 +121,17 @@ describe("formatDate", () => {
         })
         assert.strictEqual(formattedDate, "Dim.")
     })
+    it("should return the full month name with RC style", () => {
+        const formattedDate = formatDate(date, "Month", {
+            style: "rc",
+        })
+        assert.strictEqual(formattedDate, "janvier")
+    })
+    it("should return the abbreviated month name with RC style", () => {
+        const formattedDate = formatDate(dateNoMinutes, "Month", {
+            style: "rc",
+            abbreviations: true,
+        })
+        assert.strictEqual(formattedDate, "janv.")
+    })
 })

test/format/formatDateLocal.test.ts

@@ -68,6 +68,16 @@ describe("formatDateLocal", () => {
         })
         assert.strictEqual(formattedDate, "Sun.")
     })
+    it("should return the full month name", () => {
+        const formattedDate = formatDateLocal(date, "Month")
+        assert.strictEqual(formattedDate, "January")
+    })
+    it("should return the abbreviated month name", () => {
+        const formattedDate = formatDateLocal(date, "Month", {
+            abbreviations: true,
+        })
+        assert.strictEqual(formattedDate, "Jan.")
+    })
 
     // Radio-Canada style
 
@@ -131,4 +141,17 @@ describe("formatDateLocal", () => {
         })
         assert.strictEqual(formattedDate, "Dim.")
     })
+    it("should return the full month name with RC style", () => {
+        const formattedDate = formatDateLocal(date, "Month", {
+            style: "rc",
+        })
+        assert.strictEqual(formattedDate, "janvier")
+    })
+    it("should return the abbreviated month name with RC style", () => {
+        const formattedDate = formatDateLocal(dateNoMinutes, "Month", {
+            style: "rc",
+            abbreviations: true,
+        })
+        assert.strictEqual(formattedDate, "janv.")
+    })
 })