feat(typings): add FormatTimeZoneOptions extended of FormatOptions (#6)

Set FormatTimeZoneOptions in formatToTimeZone
prantlf · Jul 3, 2019 · eeaeeb6 · eeaeeb6
1 parent 260fc26
commit eeaeeb6
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/src/formatToTimeZone.d.ts b/src/formatToTimeZone.d.ts
@@ -1,8 +1,11 @@
 type DateInput = string | number | Date
-interface TimeZoneOptions {
+interface FormatOptions {
+  locale?: Object
+}
+interface FormatTimeZoneOptions extends FormatOptions {
   timeZone: string
 }
 
-declare function formatToTimeZone (dateInput: DateInput, format: string, options: TimeZoneOptions): string
+declare function formatToTimeZone (dateInput: DateInput, format: string, options: FormatTimeZoneOptions): string
 
 export { formatToTimeZone }
diff --git a/src/index.d.ts b/src/index.d.ts
@@ -2,6 +2,12 @@ type DateInput = string | number | Date
 interface TimeZoneOptions {
   timeZone: string
 }
+interface FormatOptions {
+  locale?: Object
+}
+interface FormatTimeZoneOptions extends FormatOptions {
+  timeZone: string
+}
 
 declare function convertToLocalTime (dateInput: DateInput, options: TimeZoneOptions): Date
 declare function convertToTimeZone (dateInput: DateInput, options: TimeZoneOptions): Date
@@ -10,7 +16,7 @@ declare function parseFromString (dateString: string, format: string): Date
 declare function parseFromTimeZone (dateString: string, format: string, options: TimeZoneOptions): Date
 declare function parseFromTimeZone (dateString: string, options: TimeZoneOptions): Date
 
-declare function formatToTimeZone (dateInput: DateInput, format: string, options: TimeZoneOptions): string
+declare function formatToTimeZone (dateInput: DateInput, format: string, options: FormatTimeZoneOptions): string
 
 export {
   convertToLocalTime, convertToTimeZone, parseFromString, parseFromTimeZone, formatToTimeZone