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 the function-per-file style.
Installation
npm
npm install date-fns --save
Bower
bower install 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, check the source for the reference.
Common helpers
format
- format the date.isFuture
- is the given date in the future?isPast
- is the given date in the past?isEqual
- are the given dates equal?isBefore
- is the first date before the second one?isAfter
- is the first date after the second one?compareAsc
- compare the two dates and return -1, 0 or 1.compareDesc
- compare the two dates reverse chronologically and return -1, 0 or 1.max
- return the latest of the given dates.min
- return the earliest of the given dates.closestTo
- return a date from the array closest to the given date.parse
- parse the ISO-8601-formatted date.isValid
- is the given date valid?
Range helpers
Milliseconds helpers
Seconds helpers
Minutes helpers
Hours helpers
getHours
- get the hours.setHours
- set the hours.startOfHour
- return the start of an hour for the given date.endOfHour
- return the end of an hour for the given date.addHours
- add hours to the given date.subHours
- subtract hours from the given date.isSameHour
- are the given dates in the same hour?isThisHour
- is the given date in the same hour as the current date?
Day helpers
getDate
- get the day of the month.setDate
- set the day of the month.getDay
- get the day of the week.setDay
- set the day of the week.getDayOfYear
- get the day of the year.setDayOfYear
- set the day of the year.startOfDay
- return the start of a day for the given date.endOfDay
- return the end of a day for the given date.addDays
- add the specified number of days to the given date.subDays
- subtract the specified number of days from the given date.isSameDay
- are the given dates in the same day?isWeekend
- is the given date in a weekend?isYesterday
- is the given date yesterday?isToday
- is the given date today?isTomorrow
- is the given date tomorrow?eachDay
- return the array of dates within the specified range.differenceInDays
- return the number of full days between the given dates.
Week helpers
startOfWeek
- return the start of a week for the given date.endOfWeek
- return the end of a week for the given date.lastDayOfWeek
- return the last day of a week for the given date.addWeeks
- add specified number of weeks to the given date.subWeeks
- subtract specified number of weeks from the given date.isSameWeek
- are the given dates in the same week?isThisWeek
- is the given date in the same week as the current date?
Month helpers
Quarter helpers
getQuarter
- get the year quarter.setQuarter
- set the year quarter.startOfQuarter
- return the start of a year quarter for the given date.endOfQuarter
- return the end of a year quarter for the given date.lastDayOfQuarter
- return the last day of a year quarter for the given date.addQuarters
- add the specified number of year quarters to the given date.subQuarters
- subtract the specified number of year quarters from the given date.isSameQuarter
- are the given dates in the same year quarter?isThisQuarter
- is the given date in the same quarter as the current date?
Year helpers
getYear
- get the year.setYear
- set the year.startOfYear
- return the start of a year for the given date.endOfYear
- return the end of a year for the given date.lastDayOfYear
- return the last day of a year for the given date.addYears
- add the specified number of years to the given date.subYears
- subtract the specified number of years from the given date.isSameYear
- are the given dates in the same year?isThisYear
- is the given date in the same year as the current date?isLeapYear
- is the given date in the leap year?getDaysInYear
- get the number of days in a year of the given date.
getISOYear
- get the ISO week-numbering year.setISOYear
- set the ISO week-numbering year.startOfISOYear
- return the start of an ISO week-numbering year for the given date.endOfISOYear
- return the end of an ISO week-numbering year for the given date.lastDayOfISOYear
- return the last day of an ISO week-numbering year for the given date.addISOYears
- add the specified number of ISO week-numbering years to the given date.subISOYears
- subtract the specified number of ISO week-numbering years from the given date.isSameISOYear
- are the given dates in the same ISO week-numbering year?isThisISOYear
- is the given date in the same ISO week-numbering year as the current date?getISOWeeksInYear
- get the number of weeks in the ISO week-numbering year.
I18n
TODO
Tests
Kudos to BrowserStack for the provided
Automate API. Thereby we run cross-browser tests on every push!