dateRange.d.ts 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. /**
  2. * If only a single value is specified (from each category: day, month, year), the
  3. * function returns a true value only on days that match that specification. If
  4. * both values are specified, the result is true between those times, including
  5. * bounds.
  6. *
  7. * Even though the examples don't show, the "GMT" parameter can be specified
  8. * in any of the 9 different call profiles, always as the last parameter.
  9. *
  10. * Examples:
  11. *
  12. * ``` js
  13. * dateRange(1)
  14. * true on the first day of each month, local timezone.
  15. *
  16. * dateRange(1, "GMT")
  17. * true on the first day of each month, GMT timezone.
  18. *
  19. * dateRange(1, 15)
  20. * true on the first half of each month.
  21. *
  22. * dateRange(24, "DEC")
  23. * true on 24th of December each year.
  24. *
  25. * dateRange(24, "DEC", 1995)
  26. * true on 24th of December, 1995.
  27. *
  28. * dateRange("JAN", "MAR")
  29. * true on the first quarter of the year.
  30. *
  31. * dateRange(1, "JUN", 15, "AUG")
  32. * true from June 1st until August 15th, each year (including June 1st and August
  33. * 15th).
  34. *
  35. * dateRange(1, "JUN", 15, 1995, "AUG", 1995)
  36. * true from June 1st, 1995, until August 15th, same year.
  37. *
  38. * dateRange("OCT", 1995, "MAR", 1996)
  39. * true from October 1995 until March 1996 (including the entire month of October
  40. * 1995 and March 1996).
  41. *
  42. * dateRange(1995)
  43. * true during the entire year 1995.
  44. *
  45. * dateRange(1995, 1997)
  46. * true from beginning of year 1995 until the end of year 1997.
  47. * ```
  48. *
  49. * dateRange(day)
  50. * dateRange(day1, day2)
  51. * dateRange(mon)
  52. * dateRange(month1, month2)
  53. * dateRange(year)
  54. * dateRange(year1, year2)
  55. * dateRange(day1, month1, day2, month2)
  56. * dateRange(month1, year1, month2, year2)
  57. * dateRange(day1, month1, year1, day2, month2, year2)
  58. * dateRange(day1, month1, year1, day2, month2, year2, gmt)
  59. *
  60. * @param {String} day is the day of month between 1 and 31 (as an integer).
  61. * @param {String} month is one of the month strings: JAN FEB MAR APR MAY JUN JUL AUG SEP OCT NOV DEC
  62. * @param {String} year is the full year number, for example 1995 (but not 95). Integer.
  63. * @param {String} gmt is either the string "GMT", which makes time comparison occur in GMT timezone; if left unspecified, times are taken to be in the local timezone.
  64. * @return {Boolean}
  65. */
  66. export default function dateRange(): boolean;
  67. //# sourceMappingURL=dateRange.d.ts.map