diff options
Diffstat (limited to 'lib/date.js')
| -rw-r--r-- | lib/date.js | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/lib/date.js b/lib/date.js index 2c53a4e4..e1ce7a48 100644 --- a/lib/date.js +++ b/lib/date.js @@ -1,5 +1,16 @@ +/** + * + * @namespace faker.date + */ var _Date = function (faker) { var self = this; + /** + * past + * + * @method faker.date.past + * @param {number} years + * @param {date} refDate + */ self.past = function (years, refDate) { var date = (refDate) ? new Date(Date.parse(refDate)) : new Date(); var range = { @@ -14,6 +25,13 @@ var _Date = function (faker) { return date; }; + /** + * future + * + * @method faker.date.future + * @param {number} years + * @param {date} refDate + */ self.future = function (years, refDate) { var date = (refDate) ? new Date(Date.parse(refDate)) : new Date(); var range = { @@ -28,6 +46,13 @@ var _Date = function (faker) { return date; }; + /** + * between + * + * @method faker.date.between + * @param {date} from + * @param {date} to + */ self.between = function (from, to) { var fromMilli = Date.parse(from); var dateOffset = faker.random.number(Date.parse(to) - fromMilli); @@ -37,6 +62,12 @@ var _Date = function (faker) { return newDate; }; + /** + * recent + * + * @method faker.date.recent + * @param {number} days + */ self.recent = function (days) { var date = new Date(); var range = { @@ -51,6 +82,12 @@ var _Date = function (faker) { return date; }; + /** + * month + * + * @method faker.date.month + * @param {object} options + */ self.month = function (options) { options = options || {}; @@ -67,6 +104,12 @@ var _Date = function (faker) { return faker.random.arrayElement(source); }; + /** + * weekday + * + * @param {object} options + * @method faker.date.weekday + */ self.weekday = function (options) { options = options || {}; |
