Merge pull request #487 from atorkhov/patch-2

[api] Added faker.date.soon
murindwaz · Sep 8, 2017 · 4adcc92 · 4adcc92
2 parents af953d8 + 4ff0461
commit 4adcc92
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 1 deletion.
diff --git a/Readme.md b/Readme.md
@@ -112,6 +112,7 @@ This will interpolate the format string with the value of methods `name.lastName
   * future
   * between
   * recent
+  * soon
   * month
   * weekday
 * fake

diff --git a/lib/date.js b/lib/date.js
@@ -82,6 +82,26 @@ var _Date = function (faker) {
       return date;
   };
 
+  /**
+   * soon
+   *
+   * @method faker.date.soon
+   * @param {number} days
+   */
+  self.soon = function (days) {
+      var date = new Date();
+      var range = {
+        min: 1000,
+        max: (days || 1) * 24 * 3600 * 1000
+      };
+
+      var future = date.getTime();
+      future += faker.random.number(range); // some time from now to N days later, in milliseconds
+      date.setTime(future);
+
+      return date;
+  };
+
   /**
    * month
    *
@@ -130,4 +150,4 @@ var _Date = function (faker) {
 
 };
 
-module['exports'] = _Date;
+module['exports'] = _Date;
diff --git a/test/date.unit.js b/test/date.unit.js
@@ -67,6 +67,16 @@ describe("date.js", function () {
 
     });
 
+    describe("soon()", function () {
+        it("returns a date N days into the future", function () {
+
+            var date = faker.date.soon(30);
+
+            assert.ok(date >= new Date());
+        });
+
+    });
+
     describe("between()", function () {
         it("returns a random date between the dates given", function () {