date-fns / date-fns Goto Github PK

View Code? Open in Web Editor NEW

33.7K 209.0 1.7K 21.43 MB

⏳ Modern JavaScript date utility library ⌛️

Home Page: https://date-fns.org

License: MIT License

JavaScript 0.44% Shell 0.56% TypeScript 98.99%

javascript date modules utilities nodejs time date-fns hacktoberfest

date-fns's Introduction

🎉️ NEW: date-fns v3 is out!

date-fns provides the most comprehensive, yet simple and consistent toolset for manipulating JavaScript dates in a browser & Node.js

👉 Documentation

👉 Blog

It's like Lodash for dates

It has 200+ functions for all occasions.
Modular: Pick what you need. Works with webpack, Browserify, or Rollup and also supports tree-shaking.
Native dates: Uses existing native type. It doesn't extend core objects for safety's sake.
Immutable & Pure: Built using pure functions and always returns a new date instance.
TypeScript: The library is 100% TypeScript with brand-new handcrafted types.
I18n: Dozens of locales. Include only what you need.
and many more benefits

import { compareAsc, format } from "date-fns";

format(new Date(2014, 1, 11), "yyyy-MM-dd");
//=> '2014-02-11'

const dates = [
  new Date(1995, 6, 2),
  new Date(1987, 1, 11),
  new Date(1989, 6, 10),
];
dates.sort(compareAsc);
//=> [
//   Wed Feb 11 1987 00:00:00,
//   Mon Jul 10 1989 00:00:00,
//   Sun Jul 02 1995 00:00:00
// ]

The library is available as an npm package. To install the package run:

npm install date-fns --save

Docs

See date-fns.org for more details, API, and other docs.

License

MIT © Sasha Koss

date-fns's People

Contributors

Stargazers

Watchers

Forkers

dolbyzerr radanskoric chrome lzhao18 mkaschenko mattjohnsonpint mikkelwf digideskio johnydays wesavetheworld kavallo pandahisham sidonath johnulist jayvi cybernetics alexlaforge zzh-a jethrolarson sambou janjachacz kingmario hinablue demuu p0deje strml mattlewis92 juanangosto anilprasad techscientist moonlight-dev amilajack jtangelder izeau tpai starhun tngamemo raerpo hanse ertrzyiks piotrd 19test asia-t fabiokandrade alexgorbatchev rbudiharso yunkou clauderic guigrpa tuananh mihirk fengweijp ejulen vedadsose dfreire backupmanager webeli resfront feusebio sudhirkenguva claus angdev vinayasathyanarayana riandelacruz alpcanaydin kelvinmijaya teoulas redbadger andersbiha feathers88 oria27 asos webpapaya dimonka83 derekblank it247pro ukyo athivvat archer-christ fsdn pyppe qkevinto davidrus adioslabs vlahupetar ravins aparedes piamancini jacekjarzab rubenstolk oneofthetwentythousand jkuri nishaangroup nodtem66 bentinata orangemug justrag berdof gausie liangklfang

date-fns's Issues

Add documentation to each format in `format` function

isAfter is isBefore?

WTF https://github.com/js-fns/date-fns/blob/master/src/is_after.js

isAfter function

`getDaysInYear` function

Remove DST fix in `eachDay`

Seems like this part

    /**
     * add additional 5 hours to get next day,
     * because of possible troubles with daylight savings dates
     */
    tmpDate = new Date(curDate.setTime(curDate.getTime() + 5 * 60 * 60 * 1000))
    tmpDate = new Date(tmpDate.setHours(0, 0, 0, 0))

is not necessary

Add missing ISO year and ISO week helpers

ISO year helpers:

endOfISOYear
lastDayOfISOYear
addISOYears
subISOYears
isSameISOYear

ISO week helpers:

startOfISOWeek
endOfISOWeek
lastDayOfISOWeek
isSameISOWeek

In documentation, insert the blank line after description in all functions

/**
 * Add the specified number of milliseconds to the given date.
 * @param {Date|String|Number} dirtyDate - the date to be changed
 * @param {Number} amount of milliseconds to be added
 * @returns {Date} new date with the milliseconds added
 */

➡️

/**
 * Add the specified number of milliseconds to the given date.
 *
 * @param {Date|String|Number} dirtyDate - the date to be changed
 * @param {Number} amount of milliseconds to be added
 * @returns {Date} new date with the milliseconds added
 */

`isYesterday` and `isTomorrow` functions

addHours & subHours functions

isBefore function

Add missing tokens to `format`

ISO week of year, timezones, timestamps
http://momentjs.com/docs/#/displaying/format/

Check documentation and README.md for errors

isWithinRange function

isWithinRange(new Date(2014, 0, 3), new Date(2014, 0, 1), new Date(2014, 0, 7));
//=> true

isWithinRange(new Date(2014, 0, 10), new Date(2014, 0, 1), new Date(2014, 0, 7));
//=> false

`is[Weekday]` functions for each weekday

compareDesc function

Opposite to #13

Make JSDoc arguments friendlier (dirtyDate -> date, dirtyStartDate -> startRangeDate)

Update functions list in README

Currently links to few new functions are missing in README. We need to update it and keep it synced in the future.

Remove `getTimeSinceMidnight` function

Add timestamps to tests

All the functions should be able to accept:

Date string,
String instance,
Timestamp

Tests must reflect this ability.

Create bower package

isEqual

`isValid` function

isThis[Unit]

isThisUnit(date) == isSameUnit(date, new Date())

distanceOfTimeInWords function

http://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-distance_of_time_in_words

Support for ISO 8601 expanded year representation (±YYYYY) in `parse` function

https://en.wikipedia.org/wiki/ISO_8601#Years

Fix scripts/generate_index.js so it correctly handles ISO week functions

getIsoYear should be getISOYear
See also the discussion in #78

Rename ISO weeks and ISO years functions to make them strictly camelCase

getISOYear -> getIsoYear

timeAgoInWords function

http://api.rubyonrails.org/classes/ActionView/Helpers/DateHelper.html#method-i-time_ago_in_words

endOfHour function

Fix 'E' format token in `format` function

If I am not mistaken, it should return 1 for monday and 7 for sunday

Use p.m. and a.m. instead of am pm

Source: "The Yahoo! Style Guide: The Ultimate Sourcebook for Writing"

See:

parse function

Fix grammar in tests

Fix wrong parsing of dates between 1AD and 100AD by `parse` function

> parse('0095-07-02')
Sun Jul 02 1995 00:00:00 GMT+0700 (OMSST)

subMinutes function

isSameDay function

Add descriptive comments to DST-related code

isValidDateValues

Add `closestTo` function

Returns closest date from array to the given date

compareAsc function

Compare function for sort:

dates.sort(function(dateA, dateB) {
  return dateA.getTime() < dateB.getTime() ? -1 : 1;
});

→

dates.sort(compareAsc);

Poor Antarctica!

We two failing tests for setISOYear function in Antarctica's time zone:

FAILED TESTS:
  setISOYear
    ✖ allows to pass string
      PhantomJS 1.9.8 (Linux 0.0.0)
    AssertionError:   # set_iso_year_test.js:12

      assert.deepEqual(result, new Date(2005, 0, 1))
                       |       |                    
                       |       new Date("2004-12-31T17:00:00.000Z")
                       new Date("2004-12-30T17:00:00.000Z")

        at /var/lib/buildkite-agent/builds/date-fns-agent-1/date-fns/date-fns/tmp/tests.js:1533 <- webpack:///~/power-assert/~/empower/lib/decorator.js:66:0
        at decoratedAssert (/var/lib/buildkite-agent/builds/date-fns-agent-1/date-fns/date-fns/tmp/tests.js:9129 <- webpack:///~/power-assert/~/empower/lib/decorate.js:42:0)
        at /var/lib/buildkite-agent/builds/date-fns-agent-1/date-fns/date-fns/tmp/tests.js:26536 <- webpack:///src/__tests__/set_iso_year_test.js:12:29

    ✖ allows to pass timestamp
      PhantomJS 1.9.8 (Linux 0.0.0)
    AssertionError:   # set_iso_year_test.js:17

      assert.deepEqual(result, new Date(2005, 0, 1))
                       |       |                    
                       |       new Date("2004-12-31T17:00:00.000Z")
                       new Date("2004-12-30T17:00:00.000Z")

        at /var/lib/buildkite-agent/builds/date-fns-agent-1/date-fns/date-fns/tmp/tests.js:1533 <- webpack:///~/power-assert/~/empower/lib/decorator.js:66:0
        at decoratedAssert (/var/lib/buildkite-agent/builds/date-fns-agent-1/date-fns/date-fns/tmp/tests.js:9129 <- webpack:///~/power-assert/~/empower/lib/decorate.js:42:0)
        at /var/lib/buildkite-agent/builds/date-fns-agent-1/date-fns/date-fns/tmp/tests.js:26548 <- webpack:///src/__tests__/set_iso_year_test.js:17:29

Remove unused variables in isFirstDayOfMonth and setISOYear

src/is_first_day_of_month.js
    startOfDay - on line 2
    startOfMonth - on line 3
src/set_iso_year.js
    MILLISECONDS_IN_DAY - on line 5

Make `isLeapYear` faster

new Date(year, 1, 29).getMonth() == 1 may be a cool hack but traditional arithmetic solution is faster 😏

startOfHour function

startOfToday

Add `differenceIn[Units]` function for each time unit

Result should be rounded to largest previous integer (Math.floor)

differenceInYears
differenceInISOYears
differenceInQuarters
differenceInMonths
differenceInWeeks
differenceInDays
differenceInHours
differenceInMinutes
differenceInSeconds
differenceInMilliseconds

addMinutes function

bug in addMonths

dateFns.addMonths((29 january), 1) == (1 march), but should be (28 february)

/cc @paraboom @kossnocorp @dolbyzerr

Add a check in `eachDay` function if end date is before start date

Throw exception in:

eachDay
isWithinRange

Add differenceInCalendar[Units] for units greater or equal than day

differenceInCalendarYears
differenceInCalendarISOYears
differenceInCalendarQuarters
differenceInCalendarMonths
differenceInCalendarWeeks
differenceInCalendarISOWeeks
differenceInCalendarDays