google-img-scrap 1.0.4 → 1.0.5

package/CHANGELOG.md

@@ -1,8 +1,11 @@
 # Changelog
 
+### 1.0.5
+- Added types (by christophe77)
+
 ### v1.0.4
 
-- New option ```urlMatch```. You know get image when an url match a string (example: "cdn")
+- New option ```urlMatch```. You now get image when an url match a string (example: "cdn")
 - New option ```filterByTitles```. Filter images by titles
 
 ### v1.0.3

package/package.json

@@ -1,41 +1,45 @@
-{
-  "name": "google-img-scrap",
-  "version": "1.0.4",
-  "description": "Scrap images from google images with a lot of options",
-  "main": "./src/google-img-scrap.js",
-  "directories": {
-    "test": "test"
-  },
-  "scripts": {
-    "test": "node ./test/test.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/yoannchb-pro/google-img-scrap.git"
-  },
-  "keywords": [
-    "google",
-    "image",
-    "scrap",
-    "options",
-    "query",
-    "powerfull",
-    "easy",
-    "type",
-    "color",
-    "extension",
-    "filter",
-    "date",
-    "licence"
-  ],
-  "author": "yoannchb",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/yoannchb-pro/google-img-scrap/issues"
-  },
-  "homepage": "https://github.com/yoannchb-pro/google-img-scrap#readme",
-  "dependencies": {
-    "fast-html-dom-parser": "^1.0.5",
-    "got": "^11.0.0"
-  }
-}
+{
+  "name": "google-img-scrap",
+  "version": "1.0.5",
+  "description": "Scrap images from google images with a lot of options",
+  "main": "./src/google-img-scrap.js",
+  "types": "./types/index.d.ts",
+  "directories": {
+    "test": "test"
+  },
+  "scripts": {
+    "test": "node ./test/test.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/yoannchb-pro/google-img-scrap.git"
+  },
+  "keywords": [
+    "google",
+    "image",
+    "scrap",
+    "options",
+    "query",
+    "powerfull",
+    "easy",
+    "type",
+    "color",
+    "extension",
+    "filter",
+    "date",
+    "licence"
+  ],
+  "author": "yoannchb",
+  "contributors": [
+    {"name":"christophe77","url":"https://github.com/christophe77"}
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/yoannchb-pro/google-img-scrap/issues"
+  },
+  "homepage": "https://github.com/yoannchb-pro/google-img-scrap#readme",
+  "dependencies": {
+    "fast-html-dom-parser": "^1.0.5",
+    "got": "^11.0.0"
+  }
+}

package/types/index.d.ts

@@ -0,0 +1,95 @@
+type Config = {
+  search: string;
+  query?: {
+    TYPE?: string;
+    DATE?: string;
+    COLOR?: string;
+    SIZE?: string;
+    LICENCE?: string;
+    EXTENSION?: string;
+  };
+  domains?: string[];
+  excludeWords?: string[];
+  custom?: string;
+  safeSearch?: boolean;
+  excludeDomains?: string[];
+  execute?: (element: FinalResult) => FinalResult;
+  filterByTitles: [string[]];
+};
+type FinalResult = {
+  url: string;
+  height: string;
+  width: string;
+};
+type Results = {
+  url: string;
+  result: FinalResult[];
+};
+type GoogleQuery = {
+  SIZE: {
+    LARGE: string;
+    MEDIUM: string;
+    ICON: string;
+  };
+
+  COLOR: {
+    BLACK_AND_WHITE: string;
+    TRANSPARENT: string;
+    RED: string;
+    BLUE: string;
+    PURPLE: string;
+    ORANGE: string;
+    YELLOW: string;
+    GREEN: string;
+    TEAL: string;
+    PINK: string;
+    WHITE: string;
+    GRAY: string;
+    BLACK: string;
+    BROWN: string;
+  };
+
+  TYPE: {
+    CLIPART: string;
+    DRAW: string;
+    GIF: string;
+  };
+
+  EXTENSION: {
+    JPG: "jpg";
+    GIF: "gif";
+    BMP: "bmp";
+    PNG: "png";
+    SVG: "svg";
+    WEBP: "webp";
+    ICO: "ico";
+    RAW: "raw";
+  };
+
+  DATE: {
+    DAY: string;
+    WEEK: string;
+    MONTH: string;
+    YEAR: string;
+  };
+
+  LICENCE: {
+    CREATIVE_COMMONS: string;
+    COMMERCIAL_AND_OTHER: string;
+  };
+};
+
+/**
+ * GOOGLE_IMG_SCRAP
+ *
+ * @param {Config} config
+ * @returns {Results}
+ */
+export declare function GOOGLE_IMG_SCRAP(config: Config): Results;
+
+/**
+ * GOOGLE_QUERY
+ *
+ * @returns {GoogleQuery}
+ */
+export declare const GOOGLE_QUERY: GoogleQuery;