getDaysAgo()function
getDaysAgo(target: PossibleDate, current?: PossibleDate, caller: AnyCaller = getDaysAgo): number
| Param | Type | |
|---|---|---|
target | PossibleDate | Date to count back from. required |
current | PossibleDate | Date to count to (defaults to now). |
caller | AnyCaller | Function to attribute a thrown error to (defaults to getDaysAgo itself). Defaults to getDaysAgo |
| Return | |
|---|---|
number | Number of calendar days from target to current (negative if target is in the future). |
| Throws | |
|---|---|
RequiredError | If target or current cannot be converted to a valid date. |
Count the calendar days since a date.
- Rounds to the nearest whole days.
Examples
getDaysAgo(target) // 13