43 lines
1.1 KiB
TypeScript
43 lines
1.1 KiB
TypeScript
|
/**
|
||
|
|
* True during (or between) the specified time(s).
|
||
|
|
*
|
||
|
|
* Even though the examples don't show it, this parameter may be present in
|
||
|
|
* each of the different parameter profiles, always as the last parameter.
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* Examples:
|
||
|
|
*
|
||
|
|
* ``` js
|
||
|
|
* timerange(12)
|
||
|
|
* true from noon to 1pm.
|
||
|
|
*
|
||
|
|
* timerange(12, 13)
|
||
|
|
* same as above.
|
||
|
|
*
|
||
|
|
* timerange(12, "GMT")
|
||
|
|
* true from noon to 1pm, in GMT timezone.
|
||
|
|
*
|
||
|
|
* timerange(9, 17)
|
||
|
|
* true from 9am to 5pm.
|
||
|
|
*
|
||
|
|
* timerange(8, 30, 17, 00)
|
||
|
|
* true from 8:30am to 5:00pm.
|
||
|
|
*
|
||
|
|
* timerange(0, 0, 0, 0, 0, 30)
|
||
|
|
* true between midnight and 30 seconds past midnight.
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* timeRange(hour)
|
||
|
|
* timeRange(hour1, hour2)
|
||
|
|
* timeRange(hour1, min1, hour2, min2)
|
||
|
|
* timeRange(hour1, min1, sec1, hour2, min2, sec2)
|
||
|
|
* timeRange(hour1, min1, sec1, hour2, min2, sec2, gmt)
|
||
|
|
*
|
||
|
|
* @param {String} hour is the hour from 0 to 23. (0 is midnight, 23 is 11 pm.)
|
||
|
|
* @param {String} min minutes from 0 to 59.
|
||
|
|
* @param {String} sec seconds from 0 to 59.
|
||
|
|
* @param {String} gmt either the string "GMT" for GMT timezone, or not specified, for local timezone.
|
||
|
|
* @return {Boolean}
|
||
|
|
*/
|
||
|
|
export default function timeRange(): boolean;
|