feat(API): added TypeScript defintions (#29)

index.d.ts

@@ -0,0 +1,21 @@
+type TimeZoneName = string;
+
+interface RawTimeZone {
+ name: TimeZoneName;
+ alternativeName: string;
+ group: string[];
+ countryName: string;
+ countryCode: string;
+ mainCities: string[];
+ rawOffsetInMinutes: number;
+ rawFormat: string;
+}
+
+interface TimeZone extends RawTimeZone {
+ currentTimeOffsetInMinutes: number;
+ currentTimeFormat: string;
+}
+
+export type rawTimeZones = RawTimeZone[];
+export type timeZonesNames = TimeZoneName[];
+export function getTimeZones(): TimeZone[];

package.json

@@ -20,16 +20,19 @@
  "sideEffects": false,
  "main": "dist/",
  "module": "lib/",
+ "types": "dist/index.d.ts",
  "files": [
  "dist/",
  "lib/",
  "time-zones-names.json",
  "raw-time-zones.json",
  "LICENSE",
- "README.md"
+ "README.md",
+ "index.d.ts"
  ],
  "scripts": {
  "build": "babel lib/ -d dist/ --source-maps --ignore '**/*.test.js' --delete-dir-on-start",
+ "postbuild": "cp index.d.ts dist/",
  "format": "prettier --write '**/*.*' && eslint . --fix",
  "generate": "babel-node generate.js",
  "lint": "prettier --check '**/*.*' && eslint .",