Fix Calendar.fields return type to match the spec

Port of tc39/proposal-temporal#2056
js-temporal · Feb 18, 2022 · 3145c6c · 3145c6c
1 parent f2e2658
commit 3145c6c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -746,7 +746,7 @@ export namespace Temporal {
       two: Temporal.PlainDate | PlainDateLike | string,
       options?: DifferenceOptions<'year' | 'month' | 'week' | 'day'>
     ): Temporal.Duration;
-    fields(fields: Iterable<string>): Iterable<string>;
+    fields(fields: Iterable<string>): string[];
     mergeFields(fields: Record<string, unknown>, additionalFields: Record<string, unknown>): Record<string, unknown>;
     toString(): string;
     toJSON(): string;
@@ -1340,7 +1340,7 @@ export namespace Temporal {
      * a more ergonomic alternative to this method is
      * `Temporal.Now.zonedDateTimeISO()`.
      *
-     * @param {Temporal.Calendar | string} [calendar] - calendar identifier, or
+     * @param {CalendarLike} [calendar] - calendar identifier, or
      * a `Temporal.Calendar` instance, or an object implementing the calendar
      * protocol.
      * @param {TimeZoneLike} [tzLike] -
@@ -1377,7 +1377,7 @@ export namespace Temporal {
      * `Temporal.Now.zonedDateTimeISO` or `Temporal.Now.zonedDateTime` instead
      * of this function.
      *
-     * @param {Temporal.Calendar | string} [calendar] - calendar identifier, or
+     * @param {CalendarLike} [calendar] - calendar identifier, or
      * a `Temporal.Calendar` instance, or an object implementing the calendar
      * protocol.
      * @param {TimeZoneLike} [tzLike] -

diff --git a/lib/calendar.ts b/lib/calendar.ts
@@ -92,7 +92,7 @@ interface CalendarImpl {
     two: Temporal.PlainDate,
     largestUnit: 'year' | 'month' | 'week' | 'day'
   ): { years: number; months: number; weeks: number; days: number };
-  fields(fields: Iterable<string>): Iterable<string>;
+  fields(fields: string[]): string[];
   mergeFields(fields: Record<string, unknown>, additionalFields: Record<string, unknown>): Record<string, unknown>;
 }