update types

Author: Donaldcwl

README.md

@@ -59,13 +59,13 @@ imageCompression(file: File, options): Promise<File | Blob>
 ### Helper function ###
 - for advanced user only, most user won't need to use the helper functions
 ```javascript
-imageCompression.getDataUrlFromFile(file: File): Promise<base64 encoded string>
+imageCompression.getDataUrlFromFile(file: File | Blob): Promise<base64 encoded string>
 imageCompression.getFilefromDataUrl(dataUrl: string, filename: string, lastModified?: number): Promise<File>
 imageCompression.loadImage(url: string): Promise<HTMLImageElement>
 imageCompression.drawImageInCanvas(img: HTMLImageElement): HTMLCanvasElement | OffscreenCanvas
-imageCompression.drawFileInCanvas(file: File): Promise<[ImageBitmap | HTMLImageElement, HTMLCanvasElement | OffscreenCanvas]>
+imageCompression.drawFileInCanvas(file: File| Blob): Promise<[ImageBitmap | HTMLImageElement, HTMLCanvasElement | OffscreenCanvas]>
 imageCompression.canvasToFile(canvas: HTMLCanvasElement | OffscreenCanvas, fileType: string, fileName: string, fileLastModified: number, quality?: number): Promise<File | Blob>
-imageCompression.getExifOrientation(file: File): Promise<number> // based on https://stackoverflow.com/a/32490603/10395024
+imageCompression.getExifOrientation(file: File| Blob): Promise<number> // based on https://stackoverflow.com/a/32490603/10395024
 ```
 
 ## Usage ##

lib/index.d.ts

@@ -20,16 +20,16 @@ interface Options {
     fileType?: string;
 }
 
-declare function imageCompression (image: File | Blob, options: Options): Promise<File | Blob>;
+declare function imageCompression(image: File | Blob, options: Options): Promise<File | Blob>;
 
 declare namespace imageCompression {
-    export function getDataUrlFromFile (file: File): Promise<string>
-    export function getFilefromDataUrl (dataurl: string, filename: string, lastModified?: number): Promise<File | Blob>
-    export function loadImage (src: string): Promise<HTMLImageElement>
-    export function drawImageInCanvas (img: HTMLImageElement): HTMLCanvasElement | OffscreenCanvas
-    export function drawFileInCanvas (file: File): Promise<[ImageBitmap | HTMLImageElement, HTMLCanvasElement | OffscreenCanvas]>
-    export function canvasToFile (canvas: HTMLCanvasElement | OffscreenCanvas, fileType: string, fileName: string, fileLastModified: number, quality?: number): Promise<File | Blob>
-    export function getExifOrientation (file: File): Promise<number>
+    function getDataUrlFromFile(file: File | Blob): Promise<string>;
+    function getFilefromDataUrl(dataUrl: string, filename: string, lastModified?: number): Promise<File | Blob>;
+    function loadImage(src: string): Promise<HTMLImageElement>;
+    function drawImageInCanvas(img: HTMLImageElement): HTMLCanvasElement;
+    function drawFileInCanvas(file: File | Blob): Promise<[ImageBitmap | HTMLImageElement, HTMLCanvasElement]>;
+    function canvasToFile(canvas: HTMLCanvasElement, fileType: string, fileName: string, fileLastModified: number, quality?: number): Promise<File | Blob>;
+    function getExifOrientation(file: File | Blob): Promise<number>;
 }
 
 export as namespace imageCompression;

lib/utils.js

@@ -8,7 +8,7 @@ export const CustomFileReader = isBrowser && ((moduleMapper && moduleMapper.getO
 /**
  * getDataUrlFromFile
  *
- * @param {File} file
+ * @param {File | Blob} file
  * @returns {Promise<string>}
  */
 export function getDataUrlFromFile (file) {
@@ -23,14 +23,14 @@ export function getDataUrlFromFile (file) {
 /**
  * getFilefromDataUrl
  *
- * @param {string} dataurl
+ * @param {string} dataUrl
  * @param {string} filename
  * @param {number} [lastModified=Date.now()]
- * @returns {Promise<File|Blob>}
+ * @returns {Promise<File | Blob>}
  */
-export function getFilefromDataUrl (dataurl, filename, lastModified = Date.now()) {
+export function getFilefromDataUrl (dataUrl, filename, lastModified = Date.now()) {
   return new Promise((resolve) => {
-    const arr = dataurl.split(',')
+    const arr = dataUrl.split(',')
     const mime = arr[0].match(/:(.*?);/)[1]
     const bstr = atob(arr[1])
     let n = bstr.length
@@ -88,7 +88,7 @@ export function drawImageInCanvas (img) {
 /**
  * drawFileInCanvas
  *
- * @param {File} file
+ * @param {File | Blob} file
  * @returns {Promise<[ImageBitmap | HTMLImageElement, HTMLCanvasElement | OffscreenCanvas]>}
  */
 export async function drawFileInCanvas (file) {
@@ -111,7 +111,7 @@ export async function drawFileInCanvas (file) {
  * @param {string} fileName
  * @param {number} fileLastModified
  * @param {number} [quality]
- * @returns {Promise<File|Blob>}
+ * @returns {Promise<File | Blob>}
  */
 export async function canvasToFile (canvas, fileType, fileName, fileLastModified, quality = 1) {
   let file
@@ -131,7 +131,7 @@ export async function canvasToFile (canvas, fileType, fileName, fileLastModified
  * get image exif orientation info
  * source: https://stackoverflow.com/a/32490603/10395024
  *
- * @param {File} file
+ * @param {File | Blob} file
  * @returns {Promise<number>} - orientation id, see https://i.stack.imgur.com/VGsAj.gif
  */
 export function getExifOrientation (file) {