The differenceInDays utility function calculates the number of whole days between two dates. It simplifies date calculations in JavaScript by accepting flexible input types. The first parameter represents the reference date from which the difference is measured, and the second parameter denotes the date to be compared against the reference date. Both parameters accept Date objects, numbers representing milliseconds since the Unix epoch, or strings parseable by the Date constructor.
Calculate the number of whole days between two dates using different input types:
import {differenceInDays} from 'ngx-lift';
// How many whole days are between '2022-09-08' and '2023-09-18'?
console.log(differenceInDays(new Date('2022-09-08'), new Date('2023-09-18'))); // 375
console.log(differenceInDays('2022-09-08', '2023-09-18')); // 375
console.log(differenceInDays('2022-09-08', new Date('2023-09-18'))); // 375Calculate the number of days from today to a specific date:
import {differenceInDays} from 'ngx-lift';
// How many whole days are between today and '2022-09-08'?
const daysAgo = differenceInDays(new Date(), '2022-09-08');
console.log(`That date was ${daysAgo} days ago`);
// Using Date.now() (milliseconds)
const daysAgo2 = differenceInDays(Date.now(), '2022-09-08');
console.log(`That date was ${daysAgo2} days ago`);Calculates the number of whole days between two dates.
differenceInDays(dateLeft: Date | number | string, dateRight: Date | number | string): numberdateLeft: Date | number | string The reference date. Can be a Date object, a number (milliseconds since Unix epoch), or a string parseable by the Date constructor.
dateRight: Date | number | string The date to compare against the reference date. Accepts the same types as dateLeft.
The number of whole days between the two dates. Returns a positive number if dateLeft is later than dateRight, and a negative number if dateLeft is earlier than dateRight.