formatAgo()function

formatAgo(target: PossibleDate, current?: PossibleDate, options?: UnitFormatOptions, caller: AnyCaller = formatAgo): string
ParamType
targetPossibleDate
Date to count back from. required
currentPossibleDate
Date to count to (defaults to now).
optionsUnitFormatOptions
Formatting options for the chosen duration unit.
    .onestring
String for one of this thing, e.g. product or item or sheep
- Used for unitDisplay: "long" formatting.
- Defaults to unit reference, e.g. "minute" readonly
    .manystring
String for several of this thing, e.g. products or items or sheep
- Used for unitDisplay: "long" formatting.
- Defaults to one + "s" readonly
    .abbrstring
Abbreviation for this thing, e.g. products or items or sheep (defaults to one + "s").
- Used for unitDisplay: "narrow" formatting.
- Defaults to unit reference, e.g. "minute" readonly
callerAnyCaller
Function to attribute a thrown error to (defaults to formatAgo itself). Defaults to formatAgo
Return
string
Compact string like 10d or 2h (negative if target is in the future).
Throws
RequiredError
If target or current cannot be converted to a valid date.

Format a compact best-fit description of how long since a date, e.g. 10d or 2h or -1w

Examples

formatAgo("2000-01-01") // "26y"