getHoursUntil()function
getHoursUntil(target: PossibleDate, current?: PossibleDate, caller: AnyCaller = getHoursUntil): number
| Param | Type | |
|---|---|---|
target | PossibleDate | Date to count up to. required |
current | PossibleDate | Date to count from (defaults to now). |
caller | AnyCaller | Function to attribute a thrown error to (defaults to getHoursUntil itself). Defaults to getHoursUntil |
| Return | |
|---|---|
number | Number of whole hours from current to target (negative if target is in the past). |
| Throws | |
|---|---|
RequiredError | If target or current cannot be converted to a valid date. |
Count the whole hours until a date.
- Rounds to the nearest whole hour, i.e.
1 hour 29 minutesreturns1
Examples
getHoursUntil(target) // 3