fix: more readable error message when no valid fields specified (#30)

fullcalendar · Mar 1, 2024 · 51f2c40 · 51f2c40
1 parent fb59cdb
commit 51f2c40
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 v0.2.3 (2024-02-29)
 -------------------
 
+- fix: more readable error message when no valid fields specified (#30)
 - fix: non-iso/gregory calendars dayOfYear/weekOfYear off-by-one
 - conformance to latest spec
   - yearOfWeek/weekOfYear should return undefined for non-iso/gregory calendars

diff --git a/packages/temporal-polyfill/src/impl.test.ts b/packages/temporal-polyfill/src/impl.test.ts
@@ -7,6 +7,33 @@ describe('Temporal.Duration', () => {
     const s = d.toLocaleString(d)
     expect(s).toBeTruthy()
   })
+
+  it('gives readable error message when no valid field', () => {
+    let error: TypeError | undefined
+
+    try {
+      const d = Temporal.Duration.from({ day: 5 })
+      expect(d).toBeTruthy() // won't reach
+    } catch (e: any) {
+      error = e
+    }
+
+    expect(error).toBeInstanceOf(TypeError)
+    expect(error!.toString()).toMatch(
+      [
+        'days',
+        'hours',
+        'microseconds',
+        'milliseconds',
+        'minutes',
+        'months',
+        'nanoseconds',
+        'seconds',
+        'weeks',
+        'years',
+      ].join(','),
+    )
+  })
 })
 
 describe('Intl.DateTimeFormat', () => {

diff --git a/packages/temporal-polyfill/src/internal/bagRefine.ts b/packages/temporal-polyfill/src/internal/bagRefine.ts
@@ -421,7 +421,7 @@ function refineFields(
   // only check zero fields during .with() calls
   // for .from() calls, empty-bag-checking will happen within the CalendarImpl
   if (disallowEmpty && !anyMatching) {
-    throw new TypeError(errorMessages.noValidFields)
+    throw new TypeError(errorMessages.noValidFields(validFieldNames))
   }
 
   return res

diff --git a/packages/temporal-polyfill/src/internal/errorMessages.ts b/packages/temporal-polyfill/src/internal/errorMessages.ts
@@ -26,7 +26,8 @@ export const forbiddenField = (fieldName: string) =>
   `Invalid field ${fieldName}`
 export const duplicateFields = (fieldName: string) =>
   `Duplicate field ${fieldName}`
-export const noValidFields = 'No valid fields'
+export const noValidFields = (validFields: string[]) =>
+  'No valid fields: ' + validFields.join()
 export const invalidBag = 'Invalid bag'
 
 // Class-related

diff --git a/packages/temporal-polyfill/src/internal/isoParse.ts b/packages/temporal-polyfill/src/internal/isoParse.ts
@@ -595,7 +595,7 @@ function organizeDurationParts(parts: string[]): DurationFields {
   } as DurationFields
 
   if (!hasAny) {
-    throw new RangeError(errorMessages.noValidFields)
+    throw new RangeError(errorMessages.noValidFields(durationFieldNamesAsc))
   }
 
   if (parseSign(parts[1]) < 0) {