agozilla
v1.5.0
Published
Human-friendly date and time formatting for JavaScript. Zero dependencies, locale support and TypeScript ready.
Maintainers
Readme
🦖 Agozilla
Human-friendly date & time formatting for JavaScript.
A lightweight JavaScript library for formatting dates into natural, human-readable expressions.
No dependencies. Fast. TypeScript ready.
📦 Installation
npm install agozilla
🚀 Quick Start
const agozilla = require("agozilla");
console.log(agozilla("2024-01-01"));
// 2 years ago
console.log(agozilla.fromNow("2024-01-01"));
// 2 years ago
console.log(
agozilla.duration(
"2020-01-01",
"2025-01-01"
)
);
// 5 years
console.log(
agozilla.until("2030-01-01")
);
// in 3 years
console.log(
agozilla.smart(new Date())
);
// Today
✨ Features
⚡ Zero dependencies
🌍 Locale support
📦 TypeScript definitions
⏱ Relative time formatting
📅 Human-friendly dates
🧪 Jest tested
✅ GitHub Actions CI
📦 CommonJS & ESM support
🌐 Browser and modern bundler compatible
📚 API
fromNow()
agozilla.fromNow(date);
Returns:
2 years ago
duration()
agozilla.duration(start, end);
Returns:
5 years 3 months
until()
agozilla.until(date);
Returns:
in 2 months
smart()
agozilla.smart(date);
Returns:
Today
Yesterday
Tomorrow
5 years ago
calendar()
Get human-friendly calendar descriptions for dates.
agozilla.calendar(new Date());
// Today
agozilla.calendar(yesterday);
// Yesterday
agozilla.calendar(tomorrow);
// Tomorrow
For nearby dates:
agozilla.calendar(date);
// Last Monday
agozilla.calendar(date);
// Next Friday
For older dates, Agozilla returns a formatted calendar date:
agozilla.calendar("2024-01-01");
// January 1, 2024
ESM
Agozilla supports modern ES modules:
import agozilla from "agozilla";
agozilla(new Date(Date.now() - 3600000));
// 1 hour ago
agozilla.calendar(new Date());
// Today
🌍 Locales
agozilla.fromNow(date, {
locale: "en"
});
agozilla.fromNow(date, {
locale: "es"
});
agozilla.fromNow(date, {
locale: "fr"
});
🗺 Roadmap
✅ fromNow()
✅ duration()
✅ until()
✅ smart()
✅ calendar()
⏳ live()
✅ browser bundle
⏳ React package
🤝 Contributing
Contributions, feature requests and bug reports are welcome.
If you'd like to contribute, feel free to open an issue or submit a pull request.
📄 License
MIT © Prathvik Mehra
### Important
This version keeps your existing README information while updating it for **v1.5.0**:
- ✅ ESM documented correctly
- ✅ ESM code block properly closed
- ✅ Browser/bundler support documented
- ✅ TypeScript support documented
- ✅ `calendar()` correctly marked as completed
- ✅ No `countdown()` documentation added
- ✅ Roadmap corrected
- ✅ CommonJS usage remains documented