# date
# past([maxYears, refDate])
Return date sometime in the past.
TIP
Param | Type | Default |
---|---|---|
maxYears | number | 1 |
refDate | Date | new Date() |
faker.date.past();
// Sat Oct 20 2018 04:19:38 GMT-0700 (Pacific Daylight Time)
faker.date.past(100);
// Tue Jul 27 1971 21:08:49 GMT-0700 (Pacific Daylight Time)
faker.date.past(100, new Date(-3000));
// Wed Dec 07 1881 05:04:18 GMT-0752 (Pacific Standard Time)
# future([years, refDate])
Return date sometime in the future.
TIP
Param | Type | Default |
---|---|---|
years | number | 1 |
refDate | Date | new Date() |
faker.date.future();
// Mon Sep 02 2019 21:08:33 GMT-0700 (Pacific Daylight Time)
faker.date.future(100);
// Fri Nov 23 2068 10:43:15 GMT-0800 (Pacific Standard Time)
faker.date.future(100, new Date(-3000));
// Mon Jun 26 2051 01:50:51 GMT-0700 (Pacific Daylight Time)
# between(from, to)
Return date sometime in the future.
TIP
Param | Type | Default |
---|---|---|
from | Date | N/A |
to | Date | N/A |
faker.date.between(new Date(0), new Date(365 * 24 * 3600 * 1000));
// Mon Oct 19 1970 14:12:01 GMT-0700 (Pacific Daylight Time)
# recent([days, refDate]) 5.0.0+
Returns some date recent date
TIP
Param | Type | Default |
---|---|---|
days | number | 1 |
refDate | Date | new Date() |
faker.date.recent();
# soon([days, refDate]) 5.0.0+
Return date sometime soon.
TIP
Param | Type | Default |
---|---|---|
days | number | 1 |
refDate | Date | new Date() |
faker.date.soon();
# month([options])
Return random month name
TIP
Param | Type | Default |
---|---|---|
option | object | {abbr: false, context: false} |
faker.date.month();
// December
faker.date.month({abbr: true});
// Dec
# weekday([options])
Return random weekday name
TIP
Param | Type | Default |
---|---|---|
option | object | {abbr: false, context: false} |
faker.date.weekday();
// Sunday
faker.date.weekday({abbr: true});
// Sun