Days Until 📆

Calculate how many days until (or since) any date with friendly, human-readable messages!

Installation

npm i @omar-elb/days-until

Usage

const { daysUntil, nextBirthday, getCountdown } = require("days-until");

// Simple usage
console.log(daysUntil("2025-12-25", "Christmas"));
// Output: "📅 38 days until Christmas"

// Birthday countdown
console.log(nextBirthday("1995-06-15"));
// Output: "📅 7 months until your 30th birthday"

// Detailed countdown
const countdown = getCountdown("2025-12-31");
console.log(countdown);
// { days: 44, isPast: false, isFuture: true, isToday: false, ... }

Features

✅ Human-friendly messages with emojis
✅ Handles past and future dates
✅ Birthday countdowns
✅ Detailed countdown information
✅ Supports weeks, months, and years

API

daysUntil(targetDate, eventName)

Returns a friendly message about the date.

calculateDays(targetDate)

Returns the number of days (positive for future, negative for past).

getCountdown(targetDate)

Returns detailed countdown object.

nextBirthday(birthDate)

Returns message about next birthday.

calculateAge(birthDate)

Returns current age in years.

Examples

daysUntil("2025-11-18", "Exam");
// "⏰ Exam is TOMORROW!"

daysUntil("2025-11-17", "Today");
// "🎉 Today is TODAY!"

daysUntil("2025-11-10", "Meeting");
// "⏮️ Meeting was 7 days ago"