Fix examples in differenceInDays and differenceInCalendarDays (#1124)

date-fns · Jun 3, 2019 · 1d5af4d · 1d5af4d
1 parent 4d6ed87
commit 1d5af4d
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 12 deletions.
diff --git a/src/differenceInCalendarDays/index.js b/src/differenceInCalendarDays/index.js
@@ -32,7 +32,7 @@ var MILLISECONDS_IN_DAY = 86400000
  * // How many calendar days are between
  * // 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
  * var result = differenceInCalendarDays(
- *   new Date(2011, 6, 2, 0, 1),
+ *   new Date(2011, 6, 3, 0, 1),
  *   new Date(2011, 6, 2, 23, 59)
  * )
  * //=> 1

diff --git a/src/differenceInDays/index.js b/src/differenceInDays/index.js
@@ -30,7 +30,7 @@ import compareAsc from '../compareAsc/index.js'
  * // How many days are between
  * // 2 July 2011 23:59:00 and 3 July 2011 00:01:00?
  * var result = differenceInDays(
- *   new Date(2011, 6, 2, 0, 1),
+ *   new Date(2011, 6, 3, 0, 1),
  *   new Date(2011, 6, 2, 23, 59)
  * )
  * //=> 0

diff --git a/src/format/index.js.flow b/src/format/index.js.flow
@@ -42,6 +42,7 @@ declare module.exports: (
     weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
     firstWeekContainsDate?: number,
     locale?: Locale,
-    awareOfUnicodeTokens?: boolean
+    useAdditionalWeekYearTokens?: boolean,
+    useAdditionalDayOfYearTokens?: boolean
   }
 ) => string
diff --git a/src/index.js.flow b/src/index.js.flow
@@ -224,7 +224,8 @@ declare module.exports: {
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
       firstWeekContainsDate?: number,
       locale?: Locale,
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean,
+      useAdditionalDayOfYearTokens?: boolean
     }
   ) => string,
 
@@ -437,7 +438,8 @@ declare module.exports: {
       locale?: Locale,
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
       firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7,
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean,
+      useAdditionalDayOfYearTokens?: boolean
     }
   ) => Date,
 

diff --git a/src/parse/index.js.flow b/src/parse/index.js.flow
@@ -43,6 +43,7 @@ declare module.exports: (
     locale?: Locale,
     weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
     firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7,
-    awareOfUnicodeTokens?: boolean
+    useAdditionalWeekYearTokens?: boolean,
+    useAdditionalDayOfYearTokens?: boolean
   }
 ) => Date
diff --git a/typings.d.ts b/typings.d.ts
@@ -408,7 +408,8 @@ declare module 'date-fns' {
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
       firstWeekContainsDate?: number
       locale?: Locale
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean
+      useAdditionalDayOfYearTokens?: boolean
     }
   ): string
   namespace format {
@@ -840,7 +841,8 @@ declare module 'date-fns' {
       locale?: Locale
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
       firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean
+      useAdditionalDayOfYearTokens?: boolean
     }
   ): Date
   namespace parse {
@@ -7409,7 +7411,8 @@ declare module 'date-fns/esm' {
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
       firstWeekContainsDate?: number
       locale?: Locale
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean
+      useAdditionalDayOfYearTokens?: boolean
     }
   ): string
   namespace format {
@@ -7841,7 +7844,8 @@ declare module 'date-fns/esm' {
       locale?: Locale
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
       firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean
+      useAdditionalDayOfYearTokens?: boolean
     }
   ): Date
   namespace parse {
@@ -16367,7 +16371,8 @@ interface dateFns {
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
       firstWeekContainsDate?: number
       locale?: Locale
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean
+      useAdditionalDayOfYearTokens?: boolean
     }
   ): string
 
@@ -16577,7 +16582,8 @@ interface dateFns {
       locale?: Locale
       weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6
       firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
-      awareOfUnicodeTokens?: boolean
+      useAdditionalWeekYearTokens?: boolean
+      useAdditionalDayOfYearTokens?: boolean
     }
   ): Date