fix: type file first parameter date is optional in isSame(), isBefore…

…(), isAfter() (#2272)
iamkun · Apr 16, 2023 · 4d56f3e · 4d56f3e
1 parent 00c223b
commit 4d56f3e
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 11 deletions.
diff --git a/test/plugin/isSameOrAfter.test.js b/test/plugin/isSameOrAfter.test.js
@@ -49,6 +49,13 @@ test('is same or after without units', () => {
   expect(+m).toEqual(+mCopy, 'isSameOrAfter second should not change moment')
 })
 
+test('is same or after without date', () => {
+  const past = dayjs().subtract(1, 'day')
+  const future = dayjs().add(1, 'day')
+  expect(past.isSameOrAfter()).toBe(false, 'past is before now')
+  expect(future.isSameOrAfter()).toBe(true, 'future is not before now')
+})
+
 test('is same or after month', () => {
   const m = dayjs(new Date(2011, 2, 3, 4, 5, 6, 7))
   const mCopy = dayjs(m)

diff --git a/test/plugin/isSameOrBefore.test.js b/test/plugin/isSameOrBefore.test.js
@@ -34,6 +34,13 @@ test('is same or before without units', () => {
   expect(+m).toEqual(+mCopy, 'isSameOrBefore second should not change moment')
 })
 
+test('is same or before without date', () => {
+  const past = dayjs().subtract(1, 'day')
+  const future = dayjs().add(1, 'day')
+  expect(past.isSameOrBefore()).toBe(true, 'past is before now')
+  expect(future.isSameOrBefore()).toBe(false, 'future is not before now')
+})
+
 test('is same or before year', () => {
   const m = dayjs(new Date(2011, 1, 2, 3, 4, 5, 6))
   const mCopy = dayjs(m)

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -382,7 +382,7 @@ declare namespace dayjs {
      *
      * Docs: https://day.js.org/docs/en/query/is-before
      */
-    isBefore(date: ConfigType, unit?: OpUnitType): boolean
+    isBefore(date?: ConfigType, unit?: OpUnitType): boolean
     /**
      * This indicates whether the Day.js object is the same as the other supplied date-time.
      * ```
@@ -394,7 +394,7 @@ declare namespace dayjs {
      * ```
      * Docs: https://day.js.org/docs/en/query/is-same
      */
-    isSame(date: ConfigType, unit?: OpUnitType): boolean
+    isSame(date?: ConfigType, unit?: OpUnitType): boolean
     /**
      * This indicates whether the Day.js object is after the other supplied date-time.
      * ```
@@ -408,7 +408,7 @@ declare namespace dayjs {
      *
      * Docs: https://day.js.org/docs/en/query/is-after
      */
-    isAfter(date: ConfigType, unit?: OpUnitType): boolean
+    isAfter(date?: ConfigType, unit?: OpUnitType): boolean
 
     locale(): string
 

diff --git a/types/plugin/isSameOrAfter.d.ts b/types/plugin/isSameOrAfter.d.ts
@@ -5,6 +5,6 @@ export = plugin
 
 declare module 'dayjs' {
   interface Dayjs {
-    isSameOrAfter(date: ConfigType, unit?: OpUnitType): boolean
+    isSameOrAfter(date?: ConfigType, unit?: OpUnitType): boolean
   }
 }
diff --git a/types/plugin/isSameOrBefore.d.ts b/types/plugin/isSameOrBefore.d.ts
@@ -5,6 +5,6 @@ export = plugin
 
 declare module 'dayjs' {
   interface Dayjs {
-    isSameOrBefore(date: ConfigType, unit?: OpUnitType): boolean
+    isSameOrBefore(date?: ConfigType, unit?: OpUnitType): boolean
   }
 }
diff --git a/types/plugin/isoWeek.d.ts b/types/plugin/isoWeek.d.ts
@@ -18,10 +18,10 @@ declare module 'dayjs' {
 
     endOf(unit: ISOUnitType): Dayjs
 
-    isSame(date: ConfigType, unit?: ISOUnitType): boolean
+    isSame(date?: ConfigType, unit?: ISOUnitType): boolean
 
-    isBefore(date: ConfigType, unit?: ISOUnitType): boolean
+    isBefore(date?: ConfigType, unit?: ISOUnitType): boolean
 
-    isAfter(date: ConfigType, unit?: ISOUnitType): boolean
+    isAfter(date?: ConfigType, unit?: ISOUnitType): boolean
   }
 }
diff --git a/types/plugin/quarterOfYear.d.ts b/types/plugin/quarterOfYear.d.ts
@@ -17,10 +17,10 @@ declare module 'dayjs' {
 
     endOf(unit: QUnitType | OpUnitType): Dayjs
 
-    isSame(date: ConfigType, unit?: QUnitType): boolean
+    isSame(date?: ConfigType, unit?: QUnitType): boolean
 
-    isBefore(date: ConfigType, unit?: QUnitType): boolean
+    isBefore(date?: ConfigType, unit?: QUnitType): boolean
 
-    isAfter(date: ConfigType, unit?: QUnitType): boolean
+    isAfter(date?: ConfigType, unit?: QUnitType): boolean
   }
 }