v2: arguments conversion (#452)

* Add `dirty` prefix to uncleaned arguments * Convert `parse` arguments * Add missing properties to Options shared doc * Argument conversion in private functions * Add fallbacks to `parse` * Remove `toDate` fallback in `parse` * Make linter happy
date-fns · Mar 8, 2017 · b763deb · b763deb
1 parent 2e4e777
commit b763deb
Show file tree

Hide file tree

Showing 524 changed files with 1,241 additions and 298 deletions.
diff --git a/dist/date_fns_docs.json b/dist/date_fns_docs.json
diff --git a/docs/Options.js b/docs/Options.js
@@ -16,6 +16,10 @@
  * @property {Locale} [locale=enLocale] - the locale object.
  *   Used by `distanceInWords`, `distanceInWordsStrict`, `format` and `parse`.
  *   See [Locale]{@link docs/Locale}
+ * @property {Boolean} [includeSeconds=false] - used by `distanceInWords`.
+ *   If true, distances less than a minute are more detailed
+ * @property {Boolean} [addSuffix=false] - used by `distanceInWords` and `distanceInWordsStrinct`.
+ *   If true, the result will indicate if the second date is earlier or later than the first
  * @property {'s'|'m'|'h'|'d'|'M'|'Y'} [unit] - used by `distanceInWordsStrict`.
  *   If specified, will force a unit
  * @property {'floor'|'ceil'|'round'} [partialMethod='floor'] - used by `distanceInWordsStrict`.

diff --git a/src/addDays/index.js.flow b/src/addDays/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addHours/index.js.flow b/src/addHours/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addISOYears/index.js.flow b/src/addISOYears/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addMilliseconds/index.js.flow b/src/addMilliseconds/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addMinutes/index.js.flow b/src/addMinutes/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addMonths/index.js.flow b/src/addMonths/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addQuarters/index.js.flow b/src/addQuarters/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addSeconds/index.js.flow b/src/addSeconds/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addWeeks/index.js.flow b/src/addWeeks/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/addYears/index.js.flow b/src/addYears/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/areIntervalsOverlapping/index.js b/src/areIntervalsOverlapping/index.js
@@ -30,11 +30,11 @@ import toDate from '../toDate/index.js'
  * )
  * //=> false
  */
-export default function areIntervalsOverlapping (dirtyIntervalLeft, dirtyIntervalRight, options) {
-  var leftStartTime = toDate(dirtyIntervalLeft.start, options).getTime()
-  var leftEndTime = toDate(dirtyIntervalLeft.end, options).getTime()
-  var rightStartTime = toDate(dirtyIntervalRight.start, options).getTime()
-  var rightEndTime = toDate(dirtyIntervalRight.end, options).getTime()
+export default function areIntervalsOverlapping (dirtyIntervalLeft, dirtyIntervalRight, dirtyOptions) {
+  var leftStartTime = toDate(dirtyIntervalLeft.start, dirtyOptions).getTime()
+  var leftEndTime = toDate(dirtyIntervalLeft.end, dirtyOptions).getTime()
+  var rightStartTime = toDate(dirtyIntervalRight.start, dirtyOptions).getTime()
+  var rightEndTime = toDate(dirtyIntervalRight.end, dirtyOptions).getTime()
 
   if (leftStartTime > leftEndTime || rightStartTime > rightEndTime) {
     throw new Error('The start of an interval cannot be after its end')

diff --git a/src/areIntervalsOverlapping/index.js.flow b/src/areIntervalsOverlapping/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/closestIndexTo/index.js b/src/closestIndexTo/index.js
@@ -24,15 +24,15 @@ import toDate from '../toDate/index.js'
  * var result = closestIndexTo(dateToCompare, datesArray)
  * //=> 1
  */
-export default function closestIndexTo (dirtyDateToCompare, dirtyDatesArray, options) {
-  var dateToCompare = toDate(dirtyDateToCompare, options)
+export default function closestIndexTo (dirtyDateToCompare, dirtyDatesArray, dirtyOptions) {
+  var dateToCompare = toDate(dirtyDateToCompare, dirtyOptions)
   var timeToCompare = dateToCompare.getTime()
 
   var result
   var minDistance
 
   dirtyDatesArray.forEach(function (dirtyDate, index) {
-    var currentDate = toDate(dirtyDate, options)
+    var currentDate = toDate(dirtyDate, dirtyOptions)
     var distance = Math.abs(timeToCompare - currentDate.getTime())
     if (result === undefined || distance < minDistance) {
       result = index

diff --git a/src/closestIndexTo/index.js.flow b/src/closestIndexTo/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/closestTo/index.js b/src/closestTo/index.js
@@ -22,15 +22,15 @@ import toDate from '../toDate/index.js'
  * ])
  * //=> Tue Jan 01 2030 00:00:00
  */
-export default function closestTo (dirtyDateToCompare, dirtyDatesArray, options) {
-  var dateToCompare = toDate(dirtyDateToCompare, options)
+export default function closestTo (dirtyDateToCompare, dirtyDatesArray, dirtyOptions) {
+  var dateToCompare = toDate(dirtyDateToCompare, dirtyOptions)
   var timeToCompare = dateToCompare.getTime()
 
   var result
   var minDistance
 
   dirtyDatesArray.forEach(function (dirtyDate) {
-    var currentDate = toDate(dirtyDate, options)
+    var currentDate = toDate(dirtyDate, dirtyOptions)
     var distance = Math.abs(timeToCompare - currentDate.getTime())
     if (result === undefined || distance < minDistance) {
       result = currentDate

diff --git a/src/closestTo/index.js.flow b/src/closestTo/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/compareAsc/index.js b/src/compareAsc/index.js
@@ -35,10 +35,10 @@ import toDate from '../toDate/index.js'
  * //   Sun Jul 02 1995 00:00:00
  * // ]
  */
-export default function compareAsc (dirtyDateLeft, dirtyDateRight, options) {
-  var dateLeft = toDate(dirtyDateLeft, options)
+export default function compareAsc (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var dateLeft = toDate(dirtyDateLeft, dirtyOptions)
   var timeLeft = dateLeft.getTime()
-  var dateRight = toDate(dirtyDateRight, options)
+  var dateRight = toDate(dirtyDateRight, dirtyOptions)
   var timeRight = dateRight.getTime()
 
   if (timeLeft < timeRight) {

diff --git a/src/compareAsc/index.js.flow b/src/compareAsc/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/compareDesc/index.js b/src/compareDesc/index.js
@@ -35,10 +35,10 @@ import toDate from '../toDate/index.js'
  * //   Wed Feb 11 1987 00:00:00
  * // ]
  */
-export default function compareDesc (dirtyDateLeft, dirtyDateRight, options) {
-  var dateLeft = toDate(dirtyDateLeft, options)
+export default function compareDesc (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var dateLeft = toDate(dirtyDateLeft, dirtyOptions)
   var timeLeft = dateLeft.getTime()
-  var dateRight = toDate(dirtyDateRight, options)
+  var dateRight = toDate(dirtyDateRight, dirtyOptions)
   var timeRight = dateRight.getTime()
 
   if (timeLeft > timeRight) {

diff --git a/src/compareDesc/index.js.flow b/src/compareDesc/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInCalendarDays/index.js b/src/differenceInCalendarDays/index.js
@@ -25,9 +25,9 @@ var MILLISECONDS_IN_DAY = 86400000
  * )
  * //=> 366
  */
-export default function differenceInCalendarDays (dirtyDateLeft, dirtyDateRight, options) {
-  var startOfDayLeft = startOfDay(dirtyDateLeft, options)
-  var startOfDayRight = startOfDay(dirtyDateRight, options)
+export default function differenceInCalendarDays (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var startOfDayLeft = startOfDay(dirtyDateLeft, dirtyOptions)
+  var startOfDayRight = startOfDay(dirtyDateRight, dirtyOptions)
 
   var timestampLeft = startOfDayLeft.getTime() -
     startOfDayLeft.getTimezoneOffset() * MILLISECONDS_IN_MINUTE

diff --git a/src/differenceInCalendarDays/index.js.flow b/src/differenceInCalendarDays/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInCalendarISOWeeks/index.js b/src/differenceInCalendarISOWeeks/index.js
@@ -26,9 +26,9 @@ var MILLISECONDS_IN_WEEK = 604800000
  * )
  * //=> 3
  */
-export default function differenceInCalendarISOWeeks (dirtyDateLeft, dirtyDateRight, options) {
-  var startOfISOWeekLeft = startOfISOWeek(dirtyDateLeft, options)
-  var startOfISOWeekRight = startOfISOWeek(dirtyDateRight, options)
+export default function differenceInCalendarISOWeeks (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var startOfISOWeekLeft = startOfISOWeek(dirtyDateLeft, dirtyOptions)
+  var startOfISOWeekRight = startOfISOWeek(dirtyDateRight, dirtyOptions)
 
   var timestampLeft = startOfISOWeekLeft.getTime() -
     startOfISOWeekLeft.getTimezoneOffset() * MILLISECONDS_IN_MINUTE

diff --git a/src/differenceInCalendarISOWeeks/index.js.flow b/src/differenceInCalendarISOWeeks/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInCalendarISOYears/index.js b/src/differenceInCalendarISOYears/index.js
@@ -23,6 +23,6 @@ import getISOYear from '../getISOYear/index.js'
  * )
  * //=> 2
  */
-export default function differenceInCalendarISOYears (dirtyDateLeft, dirtyDateRight, options) {
-  return getISOYear(dirtyDateRight, options) - getISOYear(dirtyDateLeft, options)
+export default function differenceInCalendarISOYears (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  return getISOYear(dirtyDateRight, dirtyOptions) - getISOYear(dirtyDateLeft, dirtyOptions)
 }
diff --git a/src/differenceInCalendarISOYears/index.js.flow b/src/differenceInCalendarISOYears/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInCalendarMonths/index.js b/src/differenceInCalendarMonths/index.js
@@ -21,9 +21,9 @@ import toDate from '../toDate/index.js'
  * )
  * //=> 8
  */
-export default function differenceInCalendarMonths (dirtyDateLeft, dirtyDateRight, options) {
-  var dateLeft = toDate(dirtyDateLeft, options)
-  var dateRight = toDate(dirtyDateRight, options)
+export default function differenceInCalendarMonths (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var dateLeft = toDate(dirtyDateLeft, dirtyOptions)
+  var dateRight = toDate(dirtyDateRight, dirtyOptions)
 
   var yearDiff = dateRight.getFullYear() - dateLeft.getFullYear()
   var monthDiff = dateRight.getMonth() - dateLeft.getMonth()

diff --git a/src/differenceInCalendarMonths/index.js.flow b/src/differenceInCalendarMonths/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInCalendarQuarters/index.js b/src/differenceInCalendarQuarters/index.js
@@ -22,12 +22,12 @@ import toDate from '../toDate/index.js'
  * )
  * //=> 3
  */
-export default function differenceInCalendarQuarters (dirtyDateLeft, dirtyDateRight, options) {
-  var dateLeft = toDate(dirtyDateLeft, options)
-  var dateRight = toDate(dirtyDateRight, options)
+export default function differenceInCalendarQuarters (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var dateLeft = toDate(dirtyDateLeft, dirtyOptions)
+  var dateRight = toDate(dirtyDateRight, dirtyOptions)
 
   var yearDiff = dateRight.getFullYear() - dateLeft.getFullYear()
-  var quarterDiff = getQuarter(dateRight, options) - getQuarter(dateLeft, options)
+  var quarterDiff = getQuarter(dateRight, dirtyOptions) - getQuarter(dateLeft, dirtyOptions)
 
   return yearDiff * 4 + quarterDiff
 }
diff --git a/src/differenceInCalendarQuarters/index.js.flow b/src/differenceInCalendarQuarters/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInCalendarWeeks/index.js.flow b/src/differenceInCalendarWeeks/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInCalendarYears/index.js b/src/differenceInCalendarYears/index.js
@@ -21,9 +21,9 @@ import toDate from '../toDate/index.js'
  * )
  * //=> 2
  */
-export default function differenceInCalendarYears (dirtyDateLeft, dirtyDateRight, options) {
-  var dateLeft = toDate(dirtyDateLeft, options)
-  var dateRight = toDate(dirtyDateRight, options)
+export default function differenceInCalendarYears (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var dateLeft = toDate(dirtyDateLeft, dirtyOptions)
+  var dateRight = toDate(dirtyDateRight, dirtyOptions)
 
   return dateRight.getFullYear() - dateLeft.getFullYear()
 }
diff --git a/src/differenceInCalendarYears/index.js.flow b/src/differenceInCalendarYears/index.js.flow
@@ -10,6 +10,8 @@ type Options = {
   weekStartsOn?: number,
   additionalDigits?: 0 | 1 | 2,
   locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
   unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
   partialMethod?: 'floor' | 'ceil' | 'round'
 }

diff --git a/src/differenceInDays/index.js b/src/differenceInDays/index.js
@@ -24,16 +24,16 @@ import compareDesc from '../compareDesc/index.js'
  * )
  * //=> 365
  */
-export default function differenceInDays (dirtyDateLeft, dirtyDateRight, options) {
-  var dateLeft = toDate(dirtyDateLeft, options)
-  var dateRight = toDate(dirtyDateRight, options)
+export default function differenceInDays (dirtyDateLeft, dirtyDateRight, dirtyOptions) {
+  var dateLeft = toDate(dirtyDateLeft, dirtyOptions)
+  var dateRight = toDate(dirtyDateRight, dirtyOptions)
 
-  var sign = compareDesc(dateLeft, dateRight, options)
-  var difference = Math.abs(differenceInCalendarDays(dateLeft, dateRight, options))
+  var sign = compareDesc(dateLeft, dateRight, dirtyOptions)
+  var difference = Math.abs(differenceInCalendarDays(dateLeft, dateRight, dirtyOptions))
 
   // Math.abs(diff in full days - diff in calendar days) === 1 if last calendar day is not full
   // If so, result must be decreased by 1 in absolute value
   dateRight.setDate(dateRight.getDate() - sign * difference)
-  var isLastDayNotFull = compareDesc(dateLeft, dateRight, options) === -sign
+  var isLastDayNotFull = compareDesc(dateLeft, dateRight, dirtyOptions) === -sign
   return sign * (difference - isLastDayNotFull)
 }