Merge pull request #16 from BeeMyDesk/typescript-declaration

Add TypeScript declaration

Author: dzmitry-stramavus

index.d.ts

@@ -0,0 +1,39 @@
+declare module 'react-cloudimage-responsive' {
+
+  type Params = string | Record<string, string>;
+
+  export interface CloudimageProviderConfig {
+    token: string;
+    baseURL?: string;
+    doNotReplaceURL?: boolean;
+    lazyLoading?: boolean;
+    lazyLoadOffset?: number;
+    params?: Params;
+    placeholderBackground?: string;
+    lowQualityPreview?: {
+      minImgWidth: number;
+    }
+    presets?: Record<string, string>;
+    limitFactor?: number;
+    devicePixelRatioList?: number[];
+    delay?: number;
+  }
+
+  class CloudimageProvider extends React.Component<{ config: CloudimageProviderConfig }> { }
+
+  interface ImgProps {
+    src: string;
+    width?: string;
+    height?: string;
+    params?: Params;
+    sizes?: Record<string, any>;
+    ratio?: number;
+    lazyLoading?: boolean;
+    lazyLoadConfig?: Record<string, any>;
+  }
+
+  class BackgroundImg extends React.Component<ImgProps & React.ComponentProps<'img'>> { }
+
+  export default class Img extends React.Component<ImgProps & React.ComponentProps<'img'>> { }
+  
+}

package.json

@@ -31,6 +31,7 @@
     "crop",
     "resize"
   ],
+  "types": "./index.d.ts",
   "scripts": {
     "start-demo": "webpack-dev-server --mode development --config webpack-demo.config.js",
     "dist": "rm -rf dist && babel src -d dist --copy-files",