constants.cjs 5.3 KB

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