dateRange.js 2.4 KB

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