heic-to 1.0.0 → 1.0.2

package/README.md

@@ -4,14 +4,14 @@ Convert HEIC/HEIF images to JPEG, PNG in browser using Javascript.
 
 Inspired by [heic2any](https://github.com/alexcorvi/heic2any) and [libheif-web](https://github.com/joutvhu/libheif-web). The purpose of heic-to is to continuously follow up on releases of [libheif](https://github.com/strukturag/libheif) to be able to preview HEIC/HEIF images in browser.
 
-Currently, heic-to is using libheif 1.18.1 under the hood.
+Currently, heic-to is using [libheif 1.18.2](https://github.com/strukturag/libheif/releases/tag/v1.18.2) under the hood.
 
 ### Usage
 
 #### Check whether the image is HEIC or not 
 
 ```js
-import { isHeic } from "hiec-to"
+import { isHeic } from "heic-to"
 
 const file = field.files[0]
 await isHeic(file)
@@ -21,7 +21,7 @@ await isHeic(file)
 
 
 ```js
-import { heicTo } from "hiec-to"
+import { heicTo } from "heic-to"
 
 const file = field.files[0]
 
@@ -69,4 +69,4 @@ cd libheif
 mkdir buildjs
 cd buildjs
 USE_WASM=0 ../build-emscripten.sh ..
-```
+```

package/dist/heic-to.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Checks if a file is in HEIC format.
+ * @param file - The file to check.
+ * @returns A promise that resolves to true if the file is HEIC, false otherwise.
+ */
+export declare function isHeic(file: File): Promise<boolean>;
+
+/**
+ * Options for converting HEIC images.
+ */
+export interface HeicToOptions {
+  /**
+   * The HEIC image blob to convert.
+   */
+  blob: Blob;
+
+  /**
+   * The desired output image MIME type (e.g., 'image/jpeg', 'image/png').
+   */
+  type: string;
+
+  /**
+   * The quality of the output image, between 0 and 1.
+   */
+  quality?: number;
+}
+
+/**
+ * Converts a HEIC image to another format.
+ * @param options - The conversion options.
+ * @returns A promise that resolves to the converted image blob.
+ */
+export declare function heicTo(options: HeicToOptions): Promise<Blob>;