timeRange.d.ts 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. /**
  2. * True during (or between) the specified time(s).
  3. *
  4. * Even though the examples don't show it, this parameter may be present in
  5. * each of the different parameter profiles, always as the last parameter.
  6. *
  7. *
  8. * Examples:
  9. *
  10. * ``` js
  11. * timerange(12)
  12. * true from noon to 1pm.
  13. *
  14. * timerange(12, 13)
  15. * same as above.
  16. *
  17. * timerange(12, "GMT")
  18. * true from noon to 1pm, in GMT timezone.
  19. *
  20. * timerange(9, 17)
  21. * true from 9am to 5pm.
  22. *
  23. * timerange(8, 30, 17, 00)
  24. * true from 8:30am to 5:00pm.
  25. *
  26. * timerange(0, 0, 0, 0, 0, 30)
  27. * true between midnight and 30 seconds past midnight.
  28. * ```
  29. *
  30. * timeRange(hour)
  31. * timeRange(hour1, hour2)
  32. * timeRange(hour1, min1, hour2, min2)
  33. * timeRange(hour1, min1, sec1, hour2, min2, sec2)
  34. * timeRange(hour1, min1, sec1, hour2, min2, sec2, gmt)
  35. *
  36. * @param {String} hour is the hour from 0 to 23. (0 is midnight, 23 is 11 pm.)
  37. * @param {String} min minutes from 0 to 59.
  38. * @param {String} sec seconds from 0 to 59.
  39. * @param {String} gmt either the string "GMT" for GMT timezone, or not specified, for local timezone.
  40. * @return {Boolean}
  41. */
  42. export default function timeRange(): boolean;
  43. //# sourceMappingURL=timeRange.d.ts.map