Implement isDate (closes #541, closes #752)

config/karma.js

@@ -128,7 +128,6 @@ function config (config) {
     },
 
     plugins: [
-      'karma-es5-shim',
       'karma-mocha',
       'karma-mocha-reporter',
       'karma-phantomjs-launcher',
@@ -153,7 +152,7 @@ function getFrameworksConfig () {
   if (process.env.TEST_BENCHMARK) {
     return ['benchmark']
   } else {
-    return ['mocha', 'sinon', 'es5-shim']
+    return ['mocha', 'sinon']
   }
 }
 

package.json

@@ -48,7 +48,6 @@
     "karma-benchmark-reporter": "^0.1.1",
     "karma-chrome-launcher": "^2.0.0",
     "karma-cli": "^1.0.1",
-    "karma-es5-shim": "0.0.4",
     "karma-mocha": "^1.3.0",
     "karma-mocha-reporter": "^2.2.1",
     "karma-phantomjs-launcher": "^1.0.4",

src/esm/fp/index.js

@@ -142,6 +142,8 @@ export {default as isAfter} from './isAfter/index.js'
 export {default as isAfterWithOptions} from './isAfterWithOptions/index.js'
 export {default as isBefore} from './isBefore/index.js'
 export {default as isBeforeWithOptions} from './isBeforeWithOptions/index.js'
+export {default as isDate} from './isDate/index.js'
+export {default as isDateWithOptions} from './isDateWithOptions/index.js'
 export {default as isEqual} from './isEqual/index.js'
 export {default as isEqualWithOptions} from './isEqualWithOptions/index.js'
 export {default as isFirstDayOfMonth} from './isFirstDayOfMonth/index.js'

src/esm/index.js

@@ -71,6 +71,7 @@ export {default as getWeeksInMonth} from './getWeeksInMonth/index.js'
 export {default as getYear} from './getYear/index.js'
 export {default as isAfter} from './isAfter/index.js'
 export {default as isBefore} from './isBefore/index.js'
+export {default as isDate} from './isDate/index.js'
 export {default as isEqual} from './isEqual/index.js'
 export {default as isFirstDayOfMonth} from './isFirstDayOfMonth/index.js'
 export {default as isFriday} from './isFriday/index.js'

src/fp/index.js

@@ -143,6 +143,8 @@ module.exports = {
   isAfterWithOptions: require('./isAfterWithOptions/index.js'),
   isBefore: require('./isBefore/index.js'),
   isBeforeWithOptions: require('./isBeforeWithOptions/index.js'),
+  isDate: require('./isDate/index.js'),
+  isDateWithOptions: require('./isDateWithOptions/index.js'),
   isEqual: require('./isEqual/index.js'),
   isEqualWithOptions: require('./isEqualWithOptions/index.js'),
   isFirstDayOfMonth: require('./isFirstDayOfMonth/index.js'),

src/fp/index.js.flow

@@ -203,6 +203,8 @@ declare module.exports: {
   isAfterWithOptions: CurriedFn3<Options, Date | string | number, Date | string | number, boolean>,
   isBefore: CurriedFn2<Date | string | number, Date | string | number, boolean>,
   isBeforeWithOptions: CurriedFn3<Options, Date | string | number, Date | string | number, boolean>,
+  isDate: CurriedFn1<any, boolean>,
+  isDateWithOptions: CurriedFn2<Options, any, boolean>,
   isEqual: CurriedFn2<Date | string | number, Date | string | number, boolean>,
   isEqualWithOptions: CurriedFn3<Options, Date | string | number, Date | string | number, boolean>,
   isFirstDayOfMonth: CurriedFn1<Date | string | number, boolean>,

src/fp/isDate/index.d.ts

@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import {isDate} from 'date-fns/fp'
+export = isDate

src/fp/isDate/index.js

@@ -0,0 +1,8 @@
+// This file is generated automatically by `scripts/build/fp.js`. Please, don't change it.
+
+import fn from '../../isDate/index.js'
+import convertToFP from '../_lib/convertToFP/index.js'
+
+var isDate = convertToFP(fn, 1)
+
+export default isDate

src/fp/isDate/index.js.flow

@@ -0,0 +1,51 @@
+// @flow
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+type Interval = {
+  start: Date | string | number,
+  end: Date | string | number
+}
+
+type Options = {
+  weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+  firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7,
+  additionalDigits?: 0 | 1 | 2,
+  locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
+  unit?: 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year',
+  roundingMethod?: 'floor' | 'ceil' | 'round'
+}
+
+type Locale = {
+  formatDistance: Function,
+  formatRelative: Function,
+  localize: {
+    ordinalNumber: Function,
+    era: Function,
+    quarter: Function,
+    month: Function,
+    day: Function,
+    dayPeriod: Function
+  },
+  formatLong: Object,
+  date: Function,
+  time: Function,
+  dateTime: Function,
+  match: {
+    ordinalNumber: Function,
+    era: Function,
+    quarter: Function,
+    month: Function,
+    day: Function,
+    dayPeriod: Function
+  },
+  options?: {
+    weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+    firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
+  }
+}
+
+type CurriedFn1<A, R> = <A>(a: A) => R
+
+declare module.exports: CurriedFn1<any, boolean>

src/fp/isDateWithOptions/index.d.ts

@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import {isDateWithOptions} from 'date-fns/fp'
+export = isDateWithOptions

src/fp/isDateWithOptions/index.js

@@ -0,0 +1,8 @@
+// This file is generated automatically by `scripts/build/fp.js`. Please, don't change it.
+
+import fn from '../../isDate/index.js'
+import convertToFP from '../_lib/convertToFP/index.js'
+
+var isDateWithOptions = convertToFP(fn, 2)
+
+export default isDateWithOptions

src/fp/isDateWithOptions/index.js.flow

@@ -0,0 +1,54 @@
+// @flow
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+type Interval = {
+  start: Date | string | number,
+  end: Date | string | number
+}
+
+type Options = {
+  weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+  firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7,
+  additionalDigits?: 0 | 1 | 2,
+  locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
+  unit?: 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year',
+  roundingMethod?: 'floor' | 'ceil' | 'round'
+}
+
+type Locale = {
+  formatDistance: Function,
+  formatRelative: Function,
+  localize: {
+    ordinalNumber: Function,
+    era: Function,
+    quarter: Function,
+    month: Function,
+    day: Function,
+    dayPeriod: Function
+  },
+  formatLong: Object,
+  date: Function,
+  time: Function,
+  dateTime: Function,
+  match: {
+    ordinalNumber: Function,
+    era: Function,
+    quarter: Function,
+    month: Function,
+    day: Function,
+    dayPeriod: Function
+  },
+  options?: {
+    weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+    firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
+  }
+}
+
+type CurriedFn1<A, R> = <A>(a: A) => R
+
+type CurriedFn2<A, B, R> = <A>(a: A) => CurriedFn1<B, R>
+  | <A, B>(a: A, b: B) => R
+
+declare module.exports: CurriedFn2<Options, any, boolean>

src/index.js

@@ -72,6 +72,7 @@ module.exports = {
   getYear: require('./getYear/index.js'),
   isAfter: require('./isAfter/index.js'),
   isBefore: require('./isBefore/index.js'),
+  isDate: require('./isDate/index.js'),
   isEqual: require('./isEqual/index.js'),
   isFirstDayOfMonth: require('./isFirstDayOfMonth/index.js'),
   isFriday: require('./isFriday/index.js'),

src/index.js.flow

@@ -441,6 +441,11 @@ declare module.exports: {
     options?: Options
   ) => boolean,
 
+  isDate: (
+    value: any,
+    options?: Options
+  ) => boolean,
+
   isEqual: (
     dateLeft: Date | string | number,
     dateRight: Date | string | number,

src/isDate/index.d.ts

@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import {isDate} from 'date-fns'
+export = isDate

src/isDate/index.js

@@ -0,0 +1,41 @@
+/**
+ * @name isDate
+ * @category Common Helpers
+ * @summary Is the given value a date?
+ *
+ * @description
+ * Returns true if the given value is an instance of Date. The function works for dates transferred across iframes.
+ *
+ * @param {*} value - the value to check
+ * @param {Options} [options] - the object with options. Unused; present for FP submodule compatibility sake. See [Options]{@link https://date-fns.org/docs/Options}
+ * @returns {boolean} true if the given value is a date
+ * @throws {TypeError} 1 arguments required
+ *
+ * @example
+ * // For a valid date:
+ * var result = isDate(new Date())
+ * //=> true
+ *
+ * @example
+ * // For a value
+ * var result = isDate('2014-02-31')
+ * //=> false
+ *
+ * @example
+ * // For a object
+ * var result = isDate({})
+ * //=> false
+ */
+export default function isDate (value) {
+  if (arguments.length < 1) {
+    throw new TypeError(
+      '1 argument required, but only ' + arguments.length + ' present'
+    )
+  }
+
+  return (
+    value instanceof Date ||
+    (typeof value === 'object' &&
+      Object.prototype.toString.call(value) === '[object Date]')
+  )
+}

src/isDate/index.js.flow

@@ -0,0 +1,52 @@
+// @flow
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+type Interval = {
+  start: Date | string | number,
+  end: Date | string | number
+}
+
+type Options = {
+  weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+  firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7,
+  additionalDigits?: 0 | 1 | 2,
+  locale?: Locale,
+  includeSeconds?: boolean,
+  addSuffix?: boolean,
+  unit?: 'second' | 'minute' | 'hour' | 'day' | 'month' | 'year',
+  roundingMethod?: 'floor' | 'ceil' | 'round'
+}
+
+type Locale = {
+  formatDistance: Function,
+  formatRelative: Function,
+  localize: {
+    ordinalNumber: Function,
+    era: Function,
+    quarter: Function,
+    month: Function,
+    day: Function,
+    dayPeriod: Function
+  },
+  formatLong: Object,
+  date: Function,
+  time: Function,
+  dateTime: Function,
+  match: {
+    ordinalNumber: Function,
+    era: Function,
+    quarter: Function,
+    month: Function,
+    day: Function,
+    dayPeriod: Function
+  },
+  options?: {
+    weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+    firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7
+  }
+}
+
+declare module.exports: (
+  value: any,
+  options?: Options
+) => boolean

src/isDate/test.js

@@ -0,0 +1,48 @@
+// @flow
+/* eslint-env mocha */
+
+import assert from 'power-assert'
+import isDate from '.'
+
+describe('isDate', function () {
+  it('returns true if the given value is a date object', function () {
+    assert(isDate(new Date()))
+  })
+
+  context('with date passed from another iframe', function () {
+    afterEach(function () {
+      document.getElementById('iframe').remove()
+    })
+
+    it('returns true for a date passed from another iframe', function (done) {
+      const iframe = document.createElement('iframe')
+      iframe.id = 'iframe'
+      iframe.addEventListener('load', function () {
+        execScript('window.date = new Date()') // eslint-disable-line no-implied-eval
+        assert(isDate(iframe.contentWindow.date))
+        done()
+      })
+      document.body.appendChild(iframe)
+    })
+
+    function execScript (scriptText) {
+      const iframe = document.getElementById('iframe')
+      const doc = iframe.contentDocument
+      const script = doc.createElement('script')
+      script.innerText = scriptText
+      doc.body.append(script)
+    }
+  })
+
+  it('returns false if the given value is not a date object', function () {
+    assert(!isDate(new Date().getTime()))
+    assert(!isDate(new Date().toISOString()))
+    assert(!isDate({}))
+    assert(!isDate(null))
+    assert(!isDate(0))
+  })
+
+  it('throws TypeError exception if passed less than 1 argument', function () {
+    assert.throws(isDate.bind(null), TypeError)
+  })
+})