fix: accept dates as params for Date methods

docs/api/date.md

@@ -10,7 +10,7 @@ Return date sometime in the past.
 | Param | Type | Default |
 | -------- | ------- | :----------: |
 | maxYears | number | `1` |
-| refDate | Date | `new Date()` |
+| refDate | string \| Date | `new Date()` |
 :::
 
 ```js
@@ -32,7 +32,7 @@ Return date sometime in the future.
 | Param | Type | Default |
 | ------- | ------- | :----------: |
 | years | number | `1` |
-| refDate | Date | `new Date()` |
+| refDate | string \| Date | `new Date()` |
 :::
 
 ```js
@@ -53,8 +53,8 @@ Return date sometime in the future.
 ::: tip
 | Param | Type | Default |
 | ----- | ---- | :------------------------------------------------: |
-| from | Date | <Badge text="N/A" type="error" vertical="middle"/> |
-| to | Date | <Badge text="N/A" type="error" vertical="middle"/> |
+| from | string \| Date | <Badge text="N/A" type="error" vertical="middle"/> |
+| to | string \| Date | <Badge text="N/A" type="error" vertical="middle"/> |
 :::
 
 ```js
@@ -70,7 +70,7 @@ Returns some date recent date
 | Param | Type | Default |
 | ------- | ------- | :----------: |
 | days | number | `1` |
-| refDate | Date | `new Date()` |
+| refDate | string \| Date | `new Date()` |
 :::
 
 ```js
@@ -85,7 +85,7 @@ Return date sometime soon.
 | Param | Type | Default |
 | ------- | ------- | :----------: |
 | days | number | `1` |
-| refDate | Date | `new Date()` |
+| refDate | string \| Date | `new Date()` |
 :::
 
 ```js

src/date.ts

@@ -18,12 +18,8 @@ export class _Date {
    * @param years
    * @param refDate
    */
-  past(years?: number, refDate?: string): Date {
-    let date = new Date();
-    if (typeof refDate !== 'undefined') {
-      date = new Date(Date.parse(refDate));
-    }
-
+  past(years?: number, refDate?: string | Date): Date {
+    const date = this.createDate(refDate);
     const range = {
       min: 1000,
       max: (years || 1) * 365 * 24 * 3600 * 1000,
@@ -43,12 +39,8 @@ export class _Date {
    * @param years
    * @param refDate
    */
-  future(years?: number, refDate?: string): Date {
-    let date = new Date();
-    if (typeof refDate !== 'undefined') {
-      date = new Date(Date.parse(refDate));
-    }
-
+  future(years?: number, refDate?: string | Date): Date {
+    const date = this.createDate(refDate);
     const range = {
       min: 1000,
       max: (years || 1) * 365 * 24 * 3600 * 1000,
@@ -68,13 +60,12 @@ export class _Date {
    * @param from
    * @param to
    */
-  between(from: string, to: string): Date {
-    const fromMilli = Date.parse(from);
-    const dateOffset = this.faker.datatype.number(Date.parse(to) - fromMilli);
+  between(from: string | Date, to: string | Date): Date {
+    const fromMilli = from instanceof Date ? from.getTime() : Date.parse(from);
+    const toMilli = to instanceof Date ? to.getTime() : Date.parse(to);
+    const dateOffset = this.faker.datatype.number(toMilli - fromMilli);
 
-    const newDate = new Date(fromMilli + dateOffset);
-
-    return newDate;
+    return new Date(fromMilli + dateOffset);
   }
 
   /**
@@ -85,18 +76,18 @@ export class _Date {
    * @param to
    * @param num
    */
-  betweens(from: string, to: string, num?: number): Date[] {
+  betweens(from: string | Date, to: string | Date, num?: number): Date[] {
     if (typeof num == 'undefined') {
       num = 3;
     }
     const newDates: Date[] = [];
-    let fromMilli = Date.parse(from);
-    const dateOffset = (Date.parse(to) - fromMilli) / (num + 1);
-    let lastDate: string | Date = from;
+    const toMilli = to instanceof Date ? to.getTime() : Date.parse(to);
+    let fromMilli = from instanceof Date ? from.getTime() : Date.parse(from);
+    const dateOffset = (toMilli - fromMilli) / (num + 1);
+    let lastDate =
+      from instanceof Date ? new Date(from) : new Date(Date.parse(from));
     for (let i = 0; i < num; i++) {
-      // TODO @Shinigami92 2022-01-11: It may be a bug that `lastDate` is passed to parse if it's a `Date` not a `string`
-      // @ts-expect-error
-      fromMilli = Date.parse(lastDate);
+      fromMilli = lastDate.getTime();
       lastDate = new Date(fromMilli + dateOffset);
       newDates.push(lastDate);
     }
@@ -110,12 +101,8 @@ export class _Date {
    * @param days
    * @param refDate
    */
-  recent(days?: number, refDate?: string): Date {
-    let date = new Date();
-    if (typeof refDate !== 'undefined') {
-      date = new Date(Date.parse(refDate));
-    }
-
+  recent(days?: number, refDate?: string | Date): Date {
+    const date = this.createDate(refDate);
     const range = {
       min: 1000,
       max: (days || 1) * 24 * 3600 * 1000,
@@ -135,12 +122,8 @@ export class _Date {
    * @param days
    * @param refDate
    */
-  soon(days?: number, refDate?: string): Date {
-    let date = new Date();
-    if (typeof refDate !== 'undefined') {
-      date = new Date(Date.parse(refDate));
-    }
-
+  soon(days?: number, refDate?: string | Date): Date {
+    const date = this.createDate(refDate);
     const range = {
       min: 1000,
       max: (days || 1) * 24 * 3600 * 1000,
@@ -204,4 +187,12 @@ export class _Date {
 
     return this.faker.random.arrayElement(source);
   }
+
+  private createDate(date: string | Date) {
+    if (typeof date !== 'undefined') {
+      return new Date(date instanceof Date ? date : Date.parse(date));
+    }
+
+    return new Date();
+  }
 }

src/helpers.ts

@@ -388,8 +388,6 @@ export class Helpers {
       email: this.faker.internet.email(userName),
       dob: this.faker.date.past(
         50,
-        // TODO @Shinigami92 2022-01-14: We may need to convert this to a string
-        // @ts-expect-error
         new Date('Sat Sep 20 1992 21:35:02 GMT+0200 (CEST)')
       ),
       phone: this.faker.phone.phoneNumber(),

test/date.unit.js

@@ -8,6 +8,7 @@ describe('date.js', function () {
   describe('past()', function () {
     it('returns a date N years into the past', function () {
       var date = faker.date.past(75);
+
       assert.ok(date < new Date());
     });
 
@@ -20,11 +21,17 @@ describe('date.js', function () {
 
     it('returns a date N years before the date given', function () {
       var refDate = new Date(2120, 11, 9, 10, 0, 0, 0); // set the date beyond the usual calculation (to make sure this is working correctly)
-
       var date = faker.date.past(75, refDate.toJSON());
 
       assert.ok(date < refDate && date > new Date()); // date should be before date given but after the current time
     });
+
+    it('accepts reference date given as Date object', function () {
+      var refDate = new Date();
+      var date = faker.date.past(0, refDate);
+
+      assert.ok(date < refDate); // date should be before the date given
+    });
   });
 
   describe('future()', function () {
@@ -43,11 +50,17 @@ describe('date.js', function () {
 
     it('returns a date N years after the date given', function () {
       var refDate = new Date(1880, 11, 9, 10, 0, 0, 0); // set the date beyond the usual calculation (to make sure this is working correctly)
-
       var date = faker.date.future(75, refDate.toJSON());
 
       assert.ok(date > refDate && date < new Date()); // date should be after the date given, but before the current time
     });
+
+    it('accepts reference date given as Date object', function () {
+      var refDate = new Date();
+      var date = faker.date.future(0, refDate);
+
+      assert.ok(date > refDate); // date should be after the date given
+    });
   });
 
   describe('recent()', function () {
@@ -61,6 +74,24 @@ describe('date.js', function () {
       var days = 30;
       var refDate = new Date(2120, 11, 9, 10, 0, 0, 0); // set the date beyond the usual calculation (to make sure this is working correctly)
 
+      var date = faker.date.recent(days, refDate.toJSON());
+
+      var lowerBound = new Date(refDate.getTime() - days * 24 * 60 * 60 * 1000);
+
+      assert.ok(
+        lowerBound <= date,
+        '`recent()` date should not be further back than `n` days ago'
+      );
+      assert.ok(
+        date <= refDate,
+        '`recent()` date should not be ahead of the starting date reference'
+      );
+    });
+
+    it('accepts reference date given as Date object', function () {
+      var days = 30;
+      var refDate = new Date(2120, 11, 9, 10, 0, 0, 0); // set the date beyond the usual calculation (to make sure this is working correctly)
+
       var date = faker.date.recent(days, refDate);
 
       var lowerBound = new Date(refDate.getTime() - days * 24 * 60 * 60 * 1000);
@@ -87,6 +118,24 @@ describe('date.js', function () {
       var days = 30;
       var refDate = new Date(1880, 11, 9, 10, 0, 0, 0); // set the date beyond the usual calculation (to make sure this is working correctly)
 
+      var date = faker.date.soon(days, refDate.toJSON());
+
+      var upperBound = new Date(refDate.getTime() + days * 24 * 60 * 60 * 1000);
+
+      assert.ok(
+        date <= upperBound,
+        '`soon()` date should not be further ahead than `n` days ago'
+      );
+      assert.ok(
+        refDate <= date,
+        '`soon()` date should not be behind the starting date reference'
+      );
+    });
+
+    it('accepts reference date given as Date object', function () {
+      var days = 30;
+      var refDate = new Date(1880, 11, 9, 10, 0, 0, 0); // set the date beyond the usual calculation (to make sure this is working correctly)
+
       var date = faker.date.soon(days, refDate);
 
       var upperBound = new Date(refDate.getTime() + days * 24 * 60 * 60 * 1000);
@@ -107,6 +156,15 @@ describe('date.js', function () {
       var from = new Date(1990, 5, 7, 9, 11, 0, 0);
       var to = new Date(2000, 6, 8, 10, 12, 0, 0);
 
+      var date = faker.date.between(from.toJSON(), to.toJSON());
+
+      assert.ok(date > from && date < to);
+    });
+
+    it('accepts reference dates given as Date objects', function () {
+      var from = new Date(1990, 5, 7, 9, 11, 0, 0);
+      var to = new Date(2000, 6, 8, 10, 12, 0, 0);
+
       var date = faker.date.between(from, to);
 
       assert.ok(date > from && date < to);
@@ -118,6 +176,16 @@ describe('date.js', function () {
       var from = new Date(1990, 5, 7, 9, 11, 0, 0);
       var to = new Date(2000, 6, 8, 10, 12, 0, 0);
 
+      var dates = faker.date.betweens(from.toJSON(), to.toJSON());
+
+      assert.ok(dates[0] > from && dates[0] < to);
+      assert.ok(dates[1] > dates[0] && dates[2] > dates[1]);
+    });
+
+    it('accepts reference dates given as Date objects', function () {
+      var from = new Date(1990, 5, 7, 9, 11, 0, 0);
+      var to = new Date(2000, 6, 8, 10, 12, 0, 0);
+
       var dates = faker.date.betweens(from, to);
 
       assert.ok(dates[0] > from && dates[0] < to);