smoldate
v1.0.0
Published
This date lib is very smol
Downloads
9
Readme
smoldate
This date lib is very smol.
Why?
I didn't want to use moment, and I just needed some very basic date functions.
- Convert a variety of date formats to a variety of other date formats
- Get/check the age of a date
- Adjust a date by days
How?
import smoldate from "smoldate";
// There's a new object in town: YearMonthDay
const nowAsYMD = smoldate.convertDateToYearMonthDay(new Date());
// Get the number of days in a given month (reliant on the year)
const daysInThisMonth = smoldate.daysInMonth(nowAsYMD.year, nowAsYMD.month);
// Convert an accepted date format to a simple YYYY-MM-DD string
const nowAsString = smoldate.convertDateToString(nowAsYMD);
// Adjust the date by days
const twoDaysFromNow = smoldate.adjustDateByDays(nowAsYMD, 2);
// Get the age in years of a date
const howOldIsStarWars = smoldate.getAge("1977-10-19");
// Validate the age is equal or above a minimum age
const canLegallyDrinkAlcohol = smoldate.validateAge("2000-01-01", 21);
Installation
Browser
<script src="//unpkg.com/[email protected]/dist/smoldate.umd.js"></script>
<script>
// window.smoldate should then be available
console.log(smoldate);
</script>
ES Module
npm i smoldate
yarn add smoldate
Then in your source code:
// ES5
const smoldate = require("smoldate").default;
const { convertDateToString } = require("smoldate");
// ES6/TypeScript
import smoldate from "smoldate";
import { convertDateToString } from "smoldate";
Development
To download external dependencies:
npm i
To run tests (using Jest):
npm test
Contribute
Got cool ideas? Have questions or feedback? Found a bug? Post an issue
Added a feature? Fixed a bug? Post a PR