Skip to content

UseDateBetween

katanakit-js / useDateBetween

function useDateBetween(
start,
end,
unit?
): number;

Defined in: core/services/dates.service.ts:517

Returns the whole number of units between two dates. Signed, never fractional, and defaulting to days.

Parameter Type Default value
start TemporalInput undefined
end TemporalInput undefined
unit? "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" "days"

number

useDateBetween("2020-01-01", "2022-04-16"); // 836
useDateBetween("2020-01-01", "2022-04-16", "months"); // 27
useDateBetween(issued, useNow(), "days"); // age in days