What is date-fns?
The date-fns npm package provides a comprehensive, yet simple and consistent toolset for manipulating JavaScript dates in a browser & Node.js. It offers a variety of functions to parse, validate, manipulate, and format dates.
What are date-fns's main functionalities?
Parsing Dates
Parse strings in ISO format to JavaScript Date objects.
const parseISO = require('date-fns/parseISO');
const result = parseISO('2023-04-12');
Formatting Dates
Format Date objects into strings with a given format.
const format = require('date-fns/format');
const result = format(new Date(2023, 3, 12), 'yyyy-MM-dd');
Comparing Dates
Compare two dates to determine if one comes before the other.
const isBefore = require('date-fns/isBefore');
const result = isBefore(new Date(2023, 3, 12), new Date(2023, 3, 13));
Manipulating Dates
Perform date calculations such as adding or subtracting time spans.
const addDays = require('date-fns/addDays');
const result = addDays(new Date(2023, 3, 12), 10);
Validating Dates
Check if a date is valid.
const isValid = require('date-fns/isValid');
const result = isValid(new Date('2023-04-12'));
Other packages similar to date-fns
moment
Moment.js is a legacy project, now in maintenance mode, which provides similar functionalities for parsing, validating, manipulating, and formatting dates. It's more object-oriented and mutable compared to the functional and immutable design of date-fns.
dayjs
Day.js is a lightweight date library that offers a similar API to Moment.js but with a smaller footprint. It is immutable and chainable, like date-fns, but with a different plugin system for extending functionality.
luxon
Luxon is a powerful, modern, and chainable library for working with dates and times. It offers a rich set of features for parsing, formatting, manipulating, and querying dates. It's built on the Intl API and provides time zone support out of the box, which is more comprehensive than date-fns's approach to time zones.
date-fns
Date helpers in function-per-file style.
Installation
npm install --save date-fns
Usage
var isLastDayOfMonth = require('date-fns/src/is_last_day_of_month')
var date = new Date(2014, 1, 28)
console.log(isLastDayOfMonth(date))
API
Code is fully documented, checkout source for reference.
Common helpers
format
- format date.isFuture
- is passed date future?isPast
- is passed date past?isEqual
- are passed dates equal?isBefore
- is first date before second one?isAfter
- is first date after second one?compareAsc
- compares the two dates and returns -1, 0 or 1.compareDesc
- compares the two dates reverse chronologicaly and returns -1, 0 or 1.max
- returns latest date.min
- returns earliest date.parse
- parse ISO-8601-formatted date.
Range helpers
Milliseconds helpers
Seconds helpers
Minutes helpers
Hours helpers
Day helpers
Week helpers
getISOWeek
- returns ISO week index.setISOWeek
- sets ISO week index.startOfWeek
- returns start of a week for passed date.endOfWeek
- returns end of a week for passed date.lastDayOfWeek
- returns last day of week for passed date.addWeeks
- add specified number of weeks to passed date.subWeeks
- subtract specified number of weeks from passed date.isSameWeek
- returns true if passed dates belongs to the same week.
Month helpers
Quarter helpers
Year helpers
getYear
- returns full year.setYear
- sets full year.getISOYear
- returns ISO week-numbering year.setISOYear
- sets ISO week-numbering year.startOfYear
- returns start of year for passed date.startOfISOYear
- returns start of ISO week-numbering year for passed date.endOfYear
- returns end of year for passed date.lastDayOfYear
- returns last day of year for passed date.addYears
- add specified number of years to passed date.subYears
- subtract specified number of years from passed date.isSameYear
- are passed dates have the same year?isLeapYear
- returns true is passed date is in the leap year.getISOWeeksInYear
- returns number of weeks in ISO week-numbering year.
I18n
TODO