chore: add type definition

2020-05-06 23:05:24 +02:00
parent 147e0f5242
commit b4b84d8d6b
3 changed files with 47 additions and 4 deletions
@@ -0,0 +1,43 @@
+namespace DottedMapLib {
+  interface Settings {
+    height?: number;
+    width?: number;
+    countries?: string[];
+    region?: { lat: { min: number; max: number }; lng: { min: number; max: number } };
+    grid?: 'vertical' | 'diagonal';
+  }
+
+  interface SvgOptions {
+    color?: string;
+    radius?: number;
+  }
+
+  interface Pin {
+    lat: number;
+    lng: number;
+    data?: any;
+    svgOptions?: SvgOptions;
+  }
+
+  interface SvgSettings {
+    shape?: 'circle' | 'hexagon';
+    color?: string;
+    backgroundColor?: string;
+    radius?: number;
+  }
+
+  type Point = {
+    x: number;
+    y: number;
+    data?: any;
+    svgOptions?: SvgOptions;
+  };
+}
+
+export default class DottedMap {
+  constructor(settings: DottedMapLib.Settings);
+
+  addPin(pin: DottedMapLib.Pin): void;
+  getPoints(): DottedMapLib.Point[];
+  getSVG(settings: DottedMapLib.SvgSettings): string;
+}