daysBetween

A utility function to calculate the number of days between two given dates.
> daysBetween(date1: Date, date2: Date): number
Parameters
  • date1: The first date to compare.
  • date2: The second date to compare.
  • Returns: The number of days between the two dates as a positive integer. If either of the dates is invalid, it returns `0`.

Example

import { daysBetween } from "@explita/daily-toolset";

// Calculate the number of days between two dates
const date1 = new Date("2023-01-01");
const date2 = new Date("2023-01-10");
console.log(daysBetween(date1, date2)); // 9

// Check with the same date
const sameDate = new Date("2023-01-01");
console.log(daysBetween(sameDate, sameDate)); // 0

// Check with an invalid date
const invalidDate = new Date("invalid date string");
console.log(daysBetween(date1, invalidDate)); // 0

Use Cases

  • Calculating the duration between two dates in days.
  • Tracking the time remaining until a specific event or deadline.
  • Determining the number of days elapsed between two historical events.