feat(isToday): add isToday function (#72)

Add function that tests if a given date is equal to today

Closes #71

Author: Miguel Almeida

src/index.js

@@ -11,6 +11,7 @@ import isArray from './is-array'
 import validateEmail from './validateEmail'
 import hex2rgb from './hex2rgb'
 import isNullOrWhitespace from './is-null-or-whitespace'
+import isToday from './is-today'
 import startsWith from './startsWith'
 import removeDuplicates from './remove-duplicates'
 import add from './add'
@@ -35,6 +36,7 @@ export {
   validateEmail,
   hex2rgb,
   isNullOrWhitespace,
+  isToday,
   startsWith,
   removeDuplicates,
   add,

src/is-today.js

@@ -0,0 +1,17 @@
+export default isToday
+
+/**
+ * This method tests if a given date is today
+ *
+ * @param {Date} date - date to be evaluated
+ * @returns {Boolean} - True if date is today, false otherwise
+ */
+function isToday(date) {
+  if (!(date instanceof Date)) {
+    return false
+  }
+  const today = new Date()
+
+  return today.setHours(0, 0, 0, 0) === date.setHours(0, 0, 0, 0)
+}
+

test/is-today.test.js

@@ -0,0 +1,36 @@
+import test from 'ava'
+import {isToday} from '../src'
+
+test('check today', t => {
+    const expected = true;
+    const actual = isToday(new Date());
+
+    t.is(actual, expected);
+});
+
+test('check previous date', t => {
+    const today = new Date();
+    const yesterday = new Date(today.setDate(today.getDate() - 1));
+
+    const expected = false;
+    const actual = isToday(yesterday);
+
+    t.is(actual, expected);
+});
+
+test('check future date', t => {
+    const today = new Date();
+    const tomorrow = new Date(today.setDate(today.getDate() + 1));
+
+    const expected = false;
+    const actual = isToday(tomorrow);
+
+    t.is(actual, expected);
+});
+
+test('check wrong parameter', t => {
+    const expected = false;
+    const actual = isToday('dummy');
+
+    t.is(actual, expected);
+})