blob: 359a77440ae5ee22ebf389ef9ae95ce93db168e6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# Date
[[toc]]
## Past
Return date sometime in the past.
::: tip
| Param | Type | Default |
| -------- | ------- | :----------: |
| maxYears | number | `1` |
| refDate | Date | `new Date()` |
:::
```js
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
Return date sometime in the future.
::: tip
| Param | Type | Default |
| ------- | ------- | :----------: |
| years | number | `1` |
| refDate | Date | `new Date()` |
:::
```js
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
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"/> |
:::
```js
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 <Badge text="5.0.0+" type="tip" vertical="middle"/>
Returns some date recent date
::: tip
| Param | Type | Default |
| ------- | ------- | :----------: |
| days | number | `1` |
| refDate | Date | `new Date()` |
:::
```js
faker.date.recent();
```
## Soon <Badge text="5.0.0+" type="tip" vertical="middle"/>
Return date sometime soon.
::: tip
| Param | Type | Default |
| ------- | ------- | :----------: |
| days | number | `1` |
| refDate | Date | `new Date()` |
:::
```js
faker.date.soon();
```
## Month
Return random month name
::: tip
| Param | Type | Default |
| ------ | ------ | :-----------------------------: |
| option | object | `{abbr: false, context: false}` |
:::
```js
faker.date.month();
// December
faker.date.month({ abbr: true });
// Dec
```
## Weekday
Return random weekday name
::: tip
| Param | Type | Default |
| ------ | ------ | :-----------------------------: |
| option | object | `{abbr: false, context: false}` |
:::
```js
faker.date.weekday();
// Sunday
faker.date.weekday({ abbr: true });
// Sun
```
|
