Fix Options typings (#433)

* Fix max, min and parse typings * Fix typing generation * Regenerate stuff
date-fns · Feb 13, 2017 · bfcf14d · bfcf14d
1 parent 3a225d6
commit bfcf14d
Show file tree

Hide file tree

Showing 18 changed files with 49 additions and 125 deletions.
diff --git a/dist/date_fns_docs.json b/dist/date_fns_docs.json
diff --git a/scripts/build_typings.js b/scripts/build_typings.js
@@ -89,7 +89,7 @@ function getType (types, {props = [], forceArray = false, indent = 1} = {}) {
       return `${correctTypeCase(arrayType)}[]`
     }
 
-    if (props.length > 0) {
+    if (type === 'Object' && props.length > 0) {
       return getParams(props, {indent: indent + 1})
     }
 

diff --git a/src/difference_in_calendar_weeks/index.js.flow b/src/difference_in_calendar_weeks/index.js.flow
@@ -32,7 +32,5 @@ type Locale = {
 declare module.exports: (
   dateLeft: Date | string | number,
   dateRight: Date | string | number,
-  options?: {
-    weekStartsOn?: number
-  }
+  options?: Options
 ) => number
diff --git a/src/distance_in_words/index.js.flow b/src/distance_in_words/index.js.flow
@@ -32,9 +32,5 @@ type Locale = {
 declare module.exports: (
   dateToCompare: Date | string | number,
   date: Date | string | number,
-  options?: {
-    includeSeconds?: boolean,
-    addSuffix?: boolean,
-    locale?: Locale
-  }
+  options?: Options
 ) => string
diff --git a/src/distance_in_words_strict/index.js.flow b/src/distance_in_words_strict/index.js.flow
@@ -32,10 +32,5 @@ type Locale = {
 declare module.exports: (
   dateToCompare: Date | string | number,
   date: Date | string | number,
-  options?: {
-    addSuffix?: boolean,
-    unit?: 's' | 'm' | 'h' | 'd' | 'M' | 'Y',
-    partialMethod?: 'floor' | 'ceil' | 'round',
-    locale?: Locale
-  }
+  options?: Options
 ) => string
diff --git a/src/end_of_week/index.js.flow b/src/end_of_week/index.js.flow
@@ -31,7 +31,5 @@ type Locale = {
 
 declare module.exports: (
   date: Date | string | number,
-  options?: {
-    weekStartsOn?: number
-  }
+  options?: Options
 ) => Date
diff --git a/src/format/index.js.flow b/src/format/index.js.flow
@@ -32,7 +32,5 @@ type Locale = {
 declare module.exports: (
   date: Date | string | number,
   format: string,
-  options?: {
-    locale?: Locale
-  }
+  options?: Options
 ) => string
diff --git a/src/is_same_week/index.js.flow b/src/is_same_week/index.js.flow
@@ -32,7 +32,5 @@ type Locale = {
 declare module.exports: (
   dateLeft: Date | string | number,
   dateRight: Date | string | number,
-  options?: {
-    weekStartsOn?: number
-  }
+  options?: Options
 ) => boolean
diff --git a/src/last_day_of_week/index.js.flow b/src/last_day_of_week/index.js.flow
@@ -31,7 +31,5 @@ type Locale = {
 
 declare module.exports: (
   date: Date | string | number,
-  options?: {
-    weekStartsOn?: number
-  }
+  options?: Options
 ) => Date
diff --git a/src/max/index.js b/src/max/index.js
@@ -9,6 +9,7 @@ import toDate from '../to_date/index.js'
  * Return the latest of the given dates.
  *
  * @param {Date[]|String[]|Number[]} datesArray - the dates to compare
+ * @param {Options} [options] - the object with options. See [Options]{@link docs/Options}
  * @returns {Date} the latest of the dates
  *
  * @example

diff --git a/src/max/index.js.flow b/src/max/index.js.flow
@@ -30,5 +30,6 @@ type Locale = {
 }
 
 declare module.exports: (
-  datesArray: (Date | string | number)[]
+  datesArray: (Date | string | number)[],
+  options?: Options
 ) => Date
diff --git a/src/min/index.js b/src/min/index.js
@@ -9,6 +9,7 @@ import toDate from '../to_date/index.js'
  * Return the earliest of the given dates.
  *
  * @param {Date[]|String[]|Number[]} datesArray - the dates to compare
+ * @param {Options} [options] - the object with options. See [Options]{@link docs/Options}
  * @returns {Date} the earliest of the dates
  *
  * @example

diff --git a/src/min/index.js.flow b/src/min/index.js.flow
@@ -30,5 +30,6 @@ type Locale = {
 }
 
 declare module.exports: (
-  datesArray: (Date | string | number)[]
+  datesArray: (Date | string | number)[],
+  options?: Options
 ) => Date
diff --git a/src/parse/index.js.flow b/src/parse/index.js.flow
@@ -33,8 +33,5 @@ declare module.exports: (
   dateString: string,
   formatString: string,
   baseDate: Date | string | number,
-  options?: {
-    locale?: Locale,
-    weekStartsOn?: number
-  }
+  options?: Options
 ) => Date
diff --git a/src/set_day/index.js.flow b/src/set_day/index.js.flow
@@ -32,7 +32,5 @@ type Locale = {
 declare module.exports: (
   date: Date | string | number,
   day: number,
-  options?: {
-    weekStartsOn?: number
-  }
+  options?: Options
 ) => Date
diff --git a/src/start_of_week/index.js.flow b/src/start_of_week/index.js.flow
@@ -31,7 +31,5 @@ type Locale = {
 
 declare module.exports: (
   date: Date | string | number,
-  options?: {
-    weekStartsOn?: number
-  }
+  options?: Options
 ) => Date
diff --git a/src/to_date/index.js.flow b/src/to_date/index.js.flow
@@ -31,7 +31,5 @@ type Locale = {
 
 declare module.exports: (
   argument: Date | string | number,
-  options?: {
-    additionalDigits?: 0 | 1 | 2
-  }
+  options?: Options
 ) => Date