update package

.npmignore

@@ -0,0 +1,9 @@
+node_modules
+.nyc_output
+coverage
+dist
+tsconfig.json
+.nycrc.json
+package-lock.json
+.eslintrc
+src

README.md

@@ -2,16 +2,26 @@
 
 ## This package helps to validate images on the DOM.
 
-A small and simple utility package that can validate any kind of image, 
+A small and simple utility package that can validate any kind of image,
+
 - It can check and detect corrupt image files.
-- it can check and detect files whose extensions have been renamed to look like images.
+- It can check and detect files whose extensions have been renamed to look like images.
+- It can check and detect remote or local image urls
 
 It supports actual image files(from input), or any string image url (could be a data url, local url or a remote url on a server).
 
-## Examples
+## Installation
+
+```
+npm install image-validator
+```
+
+## Examples & Usage
+
+### ES6
 
 ```typescript
-import { validateImage } from "../src/index";
+import { validateImage } from "image-validator";
 
 // To validate a file
 const fileValidation = async (file: File) => {
@@ -29,9 +39,44 @@ const urlValidation = async (url: string) => {
 
 // We can ensure a throw for bad images by passing a second argument
 const urlValidationThatThrowsOnError = async (url: string) => {
-  const isValidImage = await validateImage(url, { throw: true });
-  console.log(isValidImage);
-  // expected output ==> true (for valid images)
-  // expected output ==> Error (for invalid images)
+  try {
+    const isValidImage = await validateImage(url, { throw: true });
+    console.log(isValidImage);
+    // expected output ==> true (for valid images)
+  } catch (error) {
+    console.log(error);
+    // expected output ==> "The media resource is either invalid, corrupt or unsuitable" (for invalid images)
+  }
+};
+```
+
+### ES5
+
+```javascript
+const validateImage = require("./index").validateImage;
+
+// To validate a file
+const fileValidation = (file: File) => {
+  validateImage(file).then((validationResult) => console.log(validationResult));
+  // expected output ==> true or false
+};
+
+// To validate a url, can be a remote url on a server or a local url on system
+const urlValidation = async (url: string) => {
+  validateImage(url).then((validationResult) => console.log(validationResult));
+  // expected output ==> true or false
+};
+
+// We can ensure a throw for bad images by passing a second argument
+const urlValidationThatThrowsOnError = async (url: string) => {
+  validateImage(url, { throw: true })
+    .then((validationResult) => {
+      console.log(validationResult);
+      // expected output ==> true (for valid images)
+    })
+    .catch((error) => {
+      console.log(isValidImage);
+      // expected output ==> "The media resource is either invalid, corrupt or unsuitable" (for invalid images)
+    });
 };
 ```

dist/index.js → index.js

@@ -23,7 +23,7 @@ const validateImage = (src, config) => {
     image.setAttribute("crossOrigin", "anonymous");
     return new Promise((resolve, reject) => {
         image.addEventListener("error", () => (config === null || config === void 0 ? void 0 : config.throw)
-            ? reject("The selected media resource is unsuitable")
+            ? reject("The media resource is either invalid, corrupt or unsuitable")
             : resolve(false));
         image.addEventListener("load", () => resolve(true), false);
     });

src/index.ts

@@ -28,7 +28,7 @@ export const validateImage = (
   return new Promise((resolve, reject) => {
     image.addEventListener("error", () =>
       config?.throw
-        ? reject("The selected media resource is unsuitable")
+        ? reject("The media resource is either invalid, corrupt or unsuitable")
         : resolve(false)
     );
 

tests/index.ts

@@ -1,6 +1,5 @@
-import { validateImage } from "../src/index";
-import { expect } from "chai";
-
 describe("validateImage unit tests", () => {
-  it("Should return false when an invalid image url is supplied", async () => {});
+  it("Should return false when an invalid image url is supplied", async () => {
+    // 
+  });
 });

tsconfig.json

@@ -4,7 +4,7 @@
     "module": "commonjs",
     "strict": true,
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "./"
   },
-  "exclude": ["tests", "dist", "node_modules"]
+  "exclude": ["tests", "dist", "node_modules", "index.d.ts"]
 }