Clean argument using toDate in isValid (closes #440) (#455)

* Clean argument using `toDate` in `isValid`

* `isValid` changelog entry

* Regenerate typings

CHANGELOG.md

@@ -292,6 +292,27 @@ This change log follows the format documented in [Keep a CHANGELOG].
 - **BREAKING**: now `closestTo` and `closestIndexTo` don't throw an exception
   when the second argument is not an instance of array.
 
+- **BREAKING**: now `isValid` doesn't throw an exception
+  if the first argument is not an instance of Date.
+  Instead, argument is converted beforehand using `toDate`.
+
+  Examples:
+  | `isValid` argument        | Before v2.0.0 | v2.0.0 onward |
+  |---------------------------|---------------|---------------|
+  | `new Date()`              | `true`        | `true`        |
+  | `new Date('2016-01-01')`  | `true`        | `true`        |
+  | `new Date('')`            | `false`       | `false`       |
+  | `new Date(1488370835081)` | `true`        | `true`        |
+  | `new Date(NaN)`           | `false`       | `false`       |
+  | `'2016-01-01'`            | `TypeError`   | `true`        |
+  | `''`                      | `TypeError`   | `false`       |
+  | `1488370835081`           | `TypeError`   | `true`        |
+  | `NaN`                     | `TypeError`   | `false`       |
+
+  We introduce this change to make *date-fns* consistent with ECMAScript behavior
+  that try to coerce arguments to the expected type
+  (which is also the case with other *date-fns* functions). 
+
 - Every function now has `options` as the last argument which is passed to all its dependencies
   for consistency and future features.
   See [docs/Options.js](https://github.com/date-fns/date-fns/blob/master/docs/Options.js)

src/fp/isValid/index.js.flow

@@ -45,4 +45,4 @@ type CurriedFn4<A, B, C, D, R> = <A>(a: A) => CurriedFn3<B, C, D, R>
   | <A,B,C>(a: A, b: B, c: C) => CurriedFn1<D, R>
   | <A,B,C,D>(a: A, b: B, c: C, d: D) => R
 
-declare module.exports: CurriedFn1<Date, boolean>
+declare module.exports: CurriedFn1<Date | string | number, boolean>

src/fp/isValidWithOptions/index.js.flow

@@ -45,4 +45,4 @@ type CurriedFn4<A, B, C, D, R> = <A>(a: A) => CurriedFn3<B, C, D, R>
   | <A,B,C>(a: A, b: B, c: C) => CurriedFn1<D, R>
   | <A,B,C,D>(a: A, b: B, c: C, d: D) => R
 
-declare module.exports: CurriedFn2<Options, Date, boolean>
+declare module.exports: CurriedFn2<Options, Date | string | number, boolean>

src/isValid/index.js

@@ -1,4 +1,4 @@
-import isDate from '../isDate/index.js'
+import toDate from '../toDate/index.js'
 
 /**
  * @name isValid
@@ -7,29 +7,31 @@ import isDate from '../isDate/index.js'
  *
  * @description
  * Returns false if argument is Invalid Date and true otherwise.
+ * Argument is converted to Date using `toDate`. See [toDate]{@link docs/toDate}
  * Invalid Date is a Date, whose time value is NaN.
  *
  * Time value of Date: http://es5.github.io/#x15.9.1.1
  *
- * @param {Date} date - the date to check
+ * @param {Date|String|Number} date - the date to check
  * @param {Options} [options] - the object with options. See [Options]{@link docs/Options}
  * @returns {Boolean} the date is valid
- * @throws {TypeError} argument must be an instance of Date
  *
  * @example
  * // For the valid date:
  * var result = isValid(new Date(2014, 1, 31))
  * //=> true
  *
  * @example
+ * // For the value, convertable into a date:
+ * var result = isValid('2014-02-31')
+ * //=> true
+ *
+ * @example
  * // For the invalid date:
  * var result = isValid(new Date(''))
  * //=> false
  */
 export default function isValid (dirtyDate, dirtyOptions) {
-  if (isDate(dirtyDate, dirtyOptions)) {
-    return !isNaN(dirtyDate)
-  } else {
-    throw new TypeError(toString.call(dirtyDate) + ' is not an instance of Date')
-  }
+  var date = toDate(dirtyDate, dirtyOptions)
+  return !isNaN(date)
 }

src/isValid/index.js.flow

@@ -32,6 +32,6 @@ type Locale = {
 }
 
 declare module.exports: (
-  date: Date,
+  date: Date | string | number,
   options?: Options
 ) => boolean

src/isValid/test.js

@@ -15,9 +15,13 @@ describe('isValid', function () {
     assert(result === false)
   })
 
-  it('throws an exception if the argument is not an instance of Date', function () {
-    // $ExpectedMistake
-    var block = isValid.bind(null, '')
-    assert.throws(block, TypeError, '[object String] is not an instance of Date')
+  it('accepts a string', function () {
+    assert(isValid(new Date(2014, 6 /* Jul */, 8).toString()) === true)
+    assert(isValid('') === false)
+  })
+
+  it('accepts a timestamp', function () {
+    assert(isValid(new Date(2014, 1 /* Feb */, 11).getTime()) === true)
+    assert(isValid(NaN) === false)
   })
 })

typings.d.ts

@@ -631,7 +631,7 @@ declare module 'date-fns' {
   namespace isTuesday {}
 
   function isValid (
-    date: Date,
+    date: Date | string | number,
     options?: Options
   ): boolean
   namespace isValid {}
@@ -3213,7 +3213,7 @@ declare module 'date-fns/fp' {
   let isTuesday: CurriedFn1<Date | string | number, boolean>
   namespace isTuesday {}
 
-  let isValid: CurriedFn1<Date, boolean>
+  let isValid: CurriedFn1<Date | string | number, boolean>
   namespace isValid {}
 
   let isWednesday: CurriedFn1<Date | string | number, boolean>
@@ -3615,7 +3615,7 @@ declare module 'date-fns/fp' {
   let isTuesdayWithOptions: CurriedFn2<Options, Date | string | number, boolean>
   namespace isTuesdayWithOptions {}
 
-  let isValidWithOptions: CurriedFn2<Options, Date, boolean>
+  let isValidWithOptions: CurriedFn2<Options, Date | string | number, boolean>
   namespace isValidWithOptions {}
 
   let isWednesdayWithOptions: CurriedFn2<Options, Date | string | number, boolean>
@@ -8352,7 +8352,7 @@ declare module 'date-fns/esm' {
   namespace isTuesday {}
 
   function isValid (
-    date: Date,
+    date: Date | string | number,
     options?: Options
   ): boolean
   namespace isValid {}
@@ -10934,7 +10934,7 @@ declare module 'date-fns/esm/fp' {
   let isTuesday: CurriedFn1<Date | string | number, boolean>
   namespace isTuesday {}
 
-  let isValid: CurriedFn1<Date, boolean>
+  let isValid: CurriedFn1<Date | string | number, boolean>
   namespace isValid {}
 
   let isWednesday: CurriedFn1<Date | string | number, boolean>
@@ -11336,7 +11336,7 @@ declare module 'date-fns/esm/fp' {
   let isTuesdayWithOptions: CurriedFn2<Options, Date | string | number, boolean>
   namespace isTuesdayWithOptions {}
 
-  let isValidWithOptions: CurriedFn2<Options, Date, boolean>
+  let isValidWithOptions: CurriedFn2<Options, Date | string | number, boolean>
   namespace isValidWithOptions {}
 
   let isWednesdayWithOptions: CurriedFn2<Options, Date | string | number, boolean>