Allow to pass units to diff method

README.md

@@ -128,7 +128,7 @@ export interface IUtils<TDate> {
 
   isNull(value: TDate | null): boolean;
   isValid(value: any): boolean;
-  getDiff(value: TDate, comparing: TDate | string): number;
+  getDiff(value: TDate, comparing: TDate | string, unit?: Unit): number;
   isEqual(value: any, comparing: any): boolean;
 
   isSameDay(value: TDate, comparing: TDate): boolean;

__tests__/calculations.test.ts

@@ -235,6 +235,23 @@ describe("DateTime calculations", () => {
     expect(utils.getDiff(date, utils.date("2018-10-29T11:44:00.000Z"))).toBe(86400000);
     expect(utils.getDiff(date, utils.date("2018-10-31T11:44:00.000Z"))).toBe(-86400000);
     expect(utils.getDiff(date, "2018-10-31T11:44:00.000Z")).toBe(-86400000);
+    expect(utils.getDiff(date, utils.date("2017-09-29T11:44:00.000Z"), "year")).toBe(1);
+    expect(utils.getDiff(date, utils.date("2018-08-29T11:44:00.000Z"), "month")).toBe(2);
+    expect(utils.getDiff(date, utils.date("2018-05-29T11:44:00.000Z"), "quarter")).toBe(
+      1
+    );
+    expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "day")).toBe(31);
+    expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "week")).toBe(4);
+    expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "hour")).toBe(744);
+    expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "minute")).toBe(
+      44640
+    );
+    expect(utils.getDiff(date, utils.date("2018-10-30T10:44:00.000Z"), "second")).toBe(
+      3600
+    );
+    expect(
+      utils.getDiff(date, utils.date("2018-10-30T10:44:00.000Z"), "millisecond")
+    ).toBe(3600000);
   });
 
   utilsTest("mergeDateAndTime", (date, utils, lib) => {

__tests__/date-fns-jalali.test.ts

@@ -234,6 +234,28 @@ describe("DateFnsJalali", () => {
       expect(utils.getDiff(date, utils.date("2018-10-29T11:44:00.000Z"))).toBe(86400000);
       expect(utils.getDiff(date, utils.date("2018-10-31T11:44:00.000Z"))).toBe(-86400000);
       expect(utils.getDiff(date, "2018-10-31T11:44:00.000Z")).toBe(-86400000);
+      expect(utils.getDiff(date, utils.date("2017-09-29T11:44:00.000Z"), "year")).toBe(1);
+      expect(utils.getDiff(date, utils.date("2018-08-29T11:44:00.000Z"), "month")).toBe(
+        2
+      );
+      expect(utils.getDiff(date, utils.date("2018-05-29T11:44:00.000Z"), "quarter")).toBe(
+        1
+      );
+
+      expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "day")).toBe(31);
+      expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "week")).toBe(4);
+      expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "hour")).toBe(
+        744
+      );
+      expect(utils.getDiff(date, utils.date("2018-09-29T11:44:00.000Z"), "minute")).toBe(
+        44640
+      );
+      expect(utils.getDiff(date, utils.date("2018-10-30T10:44:00.000Z"), "second")).toBe(
+        3600
+      );
+      expect(
+        utils.getDiff(date, utils.date("2018-10-30T10:44:00.000Z"), "millisecond")
+      ).toBe(3600000);
     });
 
     it("DateFnsJalali -- mergeDateAndTime", () => {

packages/core/IUtils.d.ts

@@ -59,6 +59,17 @@ export interface DateIOFormats<TLibFormatToken = string> {
   keyboardDateTime24h: TLibFormatToken;
 }
 
+export type Unit =
+  | "year"
+  | "quarter"
+  | "month"
+  | "week"
+  | "day"
+  | "hour"
+  | "minute"
+  | "second"
+  | "millisecond";
+
 export interface IUtils<TDate> {
   formats: DateIOFormats<any>;
   locale?: any;
@@ -80,7 +91,7 @@ export interface IUtils<TDate> {
 
   isNull(value: TDate | null): boolean;
   isValid(value: any): boolean;
-  getDiff(value: TDate, comparing: TDate | string): number;
+  getDiff(value: TDate, comparing: TDate | string, unit?: Unit): number;
   isEqual(value: any, comparing: any): boolean;
 
   isSameDay(value: TDate, comparing: TDate): boolean;

packages/date-fns-jalali/src/date-fns-jalali-utils.ts

@@ -1,7 +1,15 @@
 import addDays from "date-fns-jalali/addDays";
 import addMonths from "date-fns-jalali/addMonths";
 import addYears from "date-fns-jalali/addYears";
-import differenceInMilliseconds from "date-fns-jalali/differenceInMilliseconds";
+import differenceInYears from "date-fns/differenceInYears";
+import differenceInQuarters from "date-fns/differenceInQuarters";
+import differenceInMonths from "date-fns/differenceInMonths";
+import differenceInWeeks from "date-fns/differenceInWeeks";
+import differenceInDays from "date-fns/differenceInDays";
+import differenceInHours from "date-fns/differenceInHours";
+import differenceInMinutes from "date-fns/differenceInMinutes";
+import differenceInSeconds from "date-fns/differenceInSeconds";
+import differenceInMilliseconds from "date-fns/differenceInMilliseconds";
 import eachDayOfInterval from "date-fns-jalali/eachDayOfInterval";
 import endOfDay from "date-fns-jalali/endOfDay";
 import endOfWeek from "date-fns-jalali/endOfWeek";
@@ -32,7 +40,7 @@ import startOfMonth from "date-fns-jalali/startOfMonth";
 import endOfMonth from "date-fns-jalali/endOfMonth";
 import startOfWeek from "date-fns-jalali/startOfWeek";
 import startOfYear from "date-fns-jalali/startOfYear";
-import { IUtils, DateIOFormats } from "@date-io/core/IUtils";
+import { IUtils, DateIOFormats, Unit } from "@date-io/core/IUtils";
 import isWithinInterval from "date-fns-jalali/isWithinInterval";
 import longFormatters from "date-fns-jalali/_lib/format/longFormatters";
 import defaultLocale from "date-fns-jalali/locale/fa-jalali-IR";
@@ -141,8 +149,27 @@ export default class DateFnsJalaliUtils implements IUtils<Date> {
     return isValid(this.date(value));
   }
 
-  public getDiff(value: Date, comparing: Date | string) {
-    return differenceInMilliseconds(value, this.date(comparing));
+  public getDiff(value: Date, comparing: Date | string, unit?: Unit) {
+    switch (unit) {
+      case "year":
+        return differenceInYears(value, this.date(comparing));
+      case "quarter":
+        return differenceInQuarters(value, this.date(comparing));
+      case "month":
+        return differenceInMonths(value, this.date(comparing));
+      case "week":
+        return differenceInWeeks(value, this.date(comparing));
+      case "day":
+        return differenceInDays(value, this.date(comparing));
+      case "hour":
+        return differenceInHours(value, this.date(comparing));
+      case "minute":
+        return differenceInMinutes(value, this.date(comparing));
+      case "second":
+        return differenceInSeconds(value, this.date(comparing));
+      default:
+        return differenceInMilliseconds(value, this.date(comparing));
+    }
   }
 
   public isAfter(value: Date, comparing: Date) {

packages/date-fns/src/date-fns-utils.ts

@@ -1,6 +1,14 @@
 import addDays from "date-fns/addDays";
 import addMonths from "date-fns/addMonths";
 import addYears from "date-fns/addYears";
+import differenceInYears from "date-fns/differenceInYears";
+import differenceInQuarters from "date-fns/differenceInQuarters";
+import differenceInMonths from "date-fns/differenceInMonths";
+import differenceInWeeks from "date-fns/differenceInWeeks";
+import differenceInDays from "date-fns/differenceInDays";
+import differenceInHours from "date-fns/differenceInHours";
+import differenceInMinutes from "date-fns/differenceInMinutes";
+import differenceInSeconds from "date-fns/differenceInSeconds";
 import differenceInMilliseconds from "date-fns/differenceInMilliseconds";
 import eachDayOfInterval from "date-fns/eachDayOfInterval";
 import endOfDay from "date-fns/endOfDay";
@@ -30,7 +38,7 @@ import startOfMonth from "date-fns/startOfMonth";
 import endOfMonth from "date-fns/endOfMonth";
 import startOfWeek from "date-fns/startOfWeek";
 import startOfYear from "date-fns/startOfYear";
-import { IUtils, DateIOFormats } from "@date-io/core/IUtils";
+import { IUtils, DateIOFormats, Unit } from "@date-io/core/IUtils";
 import isWithinInterval from "date-fns/isWithinInterval";
 import longFormatters from "date-fns/_lib/format/longFormatters";
 import defaultLocale from "date-fns/locale/en-US";
@@ -126,8 +134,27 @@ export default class DateFnsUtils implements IUtils<Date> {
     return isValid(this.date(value));
   }
 
-  public getDiff(value: Date, comparing: Date | string) {
-    return differenceInMilliseconds(value, this.date(comparing));
+  public getDiff(value: Date, comparing: Date | string, unit?: Unit) {
+    switch (unit) {
+      case "year":
+        return differenceInYears(value, this.date(comparing));
+      case "quarter":
+        return differenceInQuarters(value, this.date(comparing));
+      case "month":
+        return differenceInMonths(value, this.date(comparing));
+      case "week":
+        return differenceInWeeks(value, this.date(comparing));
+      case "day":
+        return differenceInDays(value, this.date(comparing));
+      case "hour":
+        return differenceInHours(value, this.date(comparing));
+      case "minute":
+        return differenceInMinutes(value, this.date(comparing));
+      case "second":
+        return differenceInSeconds(value, this.date(comparing));
+      default:
+        return differenceInMilliseconds(value, this.date(comparing));
+    }
   }
 
   public isAfter(value: Date, comparing: Date) {

packages/dayjs/src/dayjs-utils.ts

@@ -2,7 +2,7 @@ import defaultDayjs from "dayjs";
 import customParseFormatPlugin from "dayjs/plugin/customParseFormat";
 import localizedFormatPlugin from "dayjs/plugin/localizedFormat";
 import isBetweenPlugin from "dayjs/plugin/isBetween";
-import { IUtils, DateIOFormats } from "@date-io/core/IUtils";
+import { IUtils, DateIOFormats, Unit } from "@date-io/core/IUtils";
 
 defaultDayjs.extend(customParseFormatPlugin);
 defaultDayjs.extend(localizedFormatPlugin);
@@ -129,7 +129,7 @@ export default class DayjsUtils implements IUtils<defaultDayjs.Dayjs> {
     return date === null;
   }
 
-  public getDiff(date: Dayjs, comparing: Dayjs, units?: any, float?: any) {
+  public getDiff(date: Dayjs, comparing: Dayjs, units?: Unit, float?: any) {
     return date.diff(comparing, units, float);
   }
 

packages/luxon/src/luxon-utils.ts

@@ -1,5 +1,5 @@
 import { DateTime, Settings, Info } from "luxon";
-import { IUtils, DateIOFormats } from "@date-io/core/IUtils";
+import { IUtils, DateIOFormats, Unit } from "@date-io/core/IUtils";
 
 const defaultFormats: DateIOFormats = {
   dayOfMonth: "d",
@@ -176,11 +176,14 @@ export default class LuxonUtils implements IUtils<DateTime> {
     return diff.years! > 0;
   }
 
-  public getDiff(value: DateTime, comparing: DateTime | string) {
+  public getDiff(value: DateTime, comparing: DateTime | string, unit?: Unit) {
     if (typeof comparing === "string") {
       comparing = DateTime.fromJSDate(new Date(comparing));
     }
 
+    if (unit) {
+      return Math.floor(value.diff(comparing).as(unit));
+    }
     return value.diff(comparing).as("millisecond");
   }
 

packages/moment/src/moment-utils.ts

@@ -1,5 +1,5 @@
 import defaultMoment, { LongDateFormatKey } from "moment";
-import { IUtils, DateIOFormats } from "@date-io/core/IUtils";
+import { IUtils, DateIOFormats, Unit } from "@date-io/core/IUtils";
 
 interface Opts {
   locale?: string;
@@ -112,8 +112,8 @@ export default class MomentUtils implements IUtils<defaultMoment.Moment> {
     return date === null;
   }
 
-  public getDiff(date: Moment, comparing: Moment | string) {
-    return date.diff(comparing);
+  public getDiff(date: Moment, comparing: Moment | string, unit?: Unit) {
+    return date.diff(comparing, unit);
   }
 
   public isAfter(date: Moment, value: Moment) {