UNPKG

4.82 kBJavaScriptView Raw
1"use strict";
2exports.secondsInYear =
3 exports.secondsInWeek =
4 exports.secondsInQuarter =
5 exports.secondsInMonth =
6 exports.secondsInMinute =
7 exports.secondsInHour =
8 exports.secondsInDay =
9 exports.quartersInYear =
10 exports.monthsInYear =
11 exports.monthsInQuarter =
12 exports.minutesInYear =
13 exports.minutesInMonth =
14 exports.minutesInHour =
15 exports.minutesInDay =
16 exports.minTime =
17 exports.millisecondsInWeek =
18 exports.millisecondsInSecond =
19 exports.millisecondsInMinute =
20 exports.millisecondsInHour =
21 exports.millisecondsInDay =
22 exports.maxTime =
23 exports.daysInYear =
24 exports.daysInWeek =
25 void 0; /**
26 * @module constants
27 * @summary Useful constants
28 * @description
29 * Collection of useful date constants.
30 *
31 * The constants could be imported from `date-fns/constants`:
32 *
33 * ```ts
34 * import { maxTime, minTime } from "date-fns/constants";
35 *
36 * function isAllowedTime(time) {
37 * return time <= maxTime && time >= minTime;
38 * }
39 * ```
40 */
41
42/**
43 * @constant
44 * @name daysInWeek
45 * @summary Days in 1 week.
46 */
47const daysInWeek = (exports.daysInWeek = 7);
48
49/**
50 * @constant
51 * @name daysInYear
52 * @summary Days in 1 year.
53 *
54 * @description
55 * How many days in a year.
56 *
57 * One years equals 365.2425 days according to the formula:
58 *
59 * > Leap year occures every 4 years, except for years that are divisable by 100 and not divisable by 400.
60 * > 1 mean year = (365+1/4-1/100+1/400) days = 365.2425 days
61 */
62const daysInYear = (exports.daysInYear = 365.2425);
63
64/**
65 * @constant
66 * @name maxTime
67 * @summary Maximum allowed time.
68 *
69 * @example
70 * import { maxTime } from "date-fns/constants";
71 *
72 * const isValid = 8640000000000001 <= maxTime;
73 * //=> false
74 *
75 * new Date(8640000000000001);
76 * //=> Invalid Date
77 */
78const maxTime = (exports.maxTime = Math.pow(10, 8) * 24 * 60 * 60 * 1000);
79
80/**
81 * @constant
82 * @name minTime
83 * @summary Minimum allowed time.
84 *
85 * @example
86 * import { minTime } from "date-fns/constants";
87 *
88 * const isValid = -8640000000000001 >= minTime;
89 * //=> false
90 *
91 * new Date(-8640000000000001)
92 * //=> Invalid Date
93 */
94const minTime = (exports.minTime = -maxTime);
95
96/**
97 * @constant
98 * @name millisecondsInWeek
99 * @summary Milliseconds in 1 week.
100 */
101const millisecondsInWeek = (exports.millisecondsInWeek = 604800000);
102
103/**
104 * @constant
105 * @name millisecondsInDay
106 * @summary Milliseconds in 1 day.
107 */
108const millisecondsInDay = (exports.millisecondsInDay = 86400000);
109
110/**
111 * @constant
112 * @name millisecondsInMinute
113 * @summary Milliseconds in 1 minute
114 */
115const millisecondsInMinute = (exports.millisecondsInMinute = 60000);
116
117/**
118 * @constant
119 * @name millisecondsInHour
120 * @summary Milliseconds in 1 hour
121 */
122const millisecondsInHour = (exports.millisecondsInHour = 3600000);
123
124/**
125 * @constant
126 * @name millisecondsInSecond
127 * @summary Milliseconds in 1 second
128 */
129const millisecondsInSecond = (exports.millisecondsInSecond = 1000);
130
131/**
132 * @constant
133 * @name minutesInYear
134 * @summary Minutes in 1 year.
135 */
136const minutesInYear = (exports.minutesInYear = 525600);
137
138/**
139 * @constant
140 * @name minutesInMonth
141 * @summary Minutes in 1 month.
142 */
143const minutesInMonth = (exports.minutesInMonth = 43200);
144
145/**
146 * @constant
147 * @name minutesInDay
148 * @summary Minutes in 1 day.
149 */
150const minutesInDay = (exports.minutesInDay = 1440);
151
152/**
153 * @constant
154 * @name minutesInHour
155 * @summary Minutes in 1 hour.
156 */
157const minutesInHour = (exports.minutesInHour = 60);
158
159/**
160 * @constant
161 * @name monthsInQuarter
162 * @summary Months in 1 quarter.
163 */
164const monthsInQuarter = (exports.monthsInQuarter = 3);
165
166/**
167 * @constant
168 * @name monthsInYear
169 * @summary Months in 1 year.
170 */
171const monthsInYear = (exports.monthsInYear = 12);
172
173/**
174 * @constant
175 * @name quartersInYear
176 * @summary Quarters in 1 year
177 */
178const quartersInYear = (exports.quartersInYear = 4);
179
180/**
181 * @constant
182 * @name secondsInHour
183 * @summary Seconds in 1 hour.
184 */
185const secondsInHour = (exports.secondsInHour = 3600);
186
187/**
188 * @constant
189 * @name secondsInMinute
190 * @summary Seconds in 1 minute.
191 */
192const secondsInMinute = (exports.secondsInMinute = 60);
193
194/**
195 * @constant
196 * @name secondsInDay
197 * @summary Seconds in 1 day.
198 */
199const secondsInDay = (exports.secondsInDay = secondsInHour * 24);
200
201/**
202 * @constant
203 * @name secondsInWeek
204 * @summary Seconds in 1 week.
205 */
206const secondsInWeek = (exports.secondsInWeek = secondsInDay * 7);
207
208/**
209 * @constant
210 * @name secondsInYear
211 * @summary Seconds in 1 year.
212 */
213const secondsInYear = (exports.secondsInYear = secondsInDay * daysInYear);
214
215/**
216 * @constant
217 * @name secondsInMonth
218 * @summary Seconds in 1 month
219 */
220const secondsInMonth = (exports.secondsInMonth = secondsInYear / 12);
221
222/**
223 * @constant
224 * @name secondsInQuarter
225 * @summary Seconds in 1 quarter.
226 */
227const secondsInQuarter = (exports.secondsInQuarter = secondsInMonth * 3);