katanakit-js / useDateBetween

Function: useDateBetween()

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

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

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

Parameters

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

Returns

number

Example

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