Document argumentless diff

dayjs.diff() calculates the diff to current time.
iamkun · May 27, 2021 · 2476a47 · 2476a47
1 parent 06f88f4
commit 2476a47
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -286,7 +286,9 @@ declare namespace dayjs {
      * const date1 = dayjs('2019-01-25')
      * const date2 = dayjs('2018-06-05')
      * date1.diff(date2) // 20214000000 default milliseconds
+     * date1.diff() // milliseconds to current time
      * ```
+     *
      * To get the difference in another unit of measurement, pass that measurement as the second argument.
      * ```
      * const date1 = dayjs('2019-01-25')
@@ -296,7 +298,7 @@ declare namespace dayjs {
      *
      * Docs: https://day.js.org/docs/en/display/difference
      */
-    diff(date: ConfigType, unit?: QUnitType | OpUnitType, float?: boolean): number
+    diff(date?: ConfigType, unit?: QUnitType | OpUnitType, float?: boolean): number
     /**
      * This returns the number of **milliseconds** since the Unix Epoch of the Day.js object.
      * ```