Merge pull request #4 from MyUnisoft/version

feat: add version method

README.md

@@ -35,11 +35,27 @@ The **heif-converter** package facilitates the conversion of HEIF (High Efficien
 ## 🦴 Installation
 
 ```bash
-npm install heif-converter
+npm install @myunisoft/heif-converter
 ```
 
 ## 🚀 API
 <details>
+<summary>version</summary>
+<br>
+
+The **version** method is used to obtain the version of libheif.
+
+```ts
+function version(): string;
+```
+```js
+import lib from "../index.js";
+
+console.log(lib.version());
+// 1.17.6
+```
+</details>
+<details>
 <summary>toJpeg</summary>
 <br>
 

index.d.ts

@@ -19,6 +19,7 @@ declare const types: {
   toJpeg(input: string | Buffer | Readable, options?: JpegOptions): Promise<Buffer>;
   toPng(input: string | Buffer | Readable, options?: PngOptions): Promise<Buffer>;
   extract(input: string | Buffer | Readable): Promise<ExtractedImage[]>;
+  version(): string;
 };
 
 export default types;

index.js

@@ -52,6 +52,9 @@ async function getBufferFromInput(input) {
 }
 
 module.exports = {
+  version() {
+    return lib.version();
+  },
   async toJpeg(input, options = { quality: 75 }) {
     const buffer = await getBufferFromInput(input);
 

src/lib.cc

@@ -290,7 +290,12 @@ Napi::Value ExtractIds(const Napi::CallbackInfo& info) {
     return result;
 }
 
+Napi::String GetVersion(const Napi::CallbackInfo& info) {
+    return Napi::String::New(info.Env(), heif_get_version());
+}
+
 Napi::Object InitAll(Napi::Env env, Napi::Object exports) {
+    exports.Set(Napi::String::New(env, "version"), Napi::Function::New(env, GetVersion));
     exports.Set(Napi::String::New(env, "toPng"), Napi::Function::New(env, ToPng));
     exports.Set(Napi::String::New(env, "toJpeg"), Napi::Function::New(env, ToJpeg));
     exports.Set(Napi::String::New(env, "extractIds"), Napi::Function::New(env, ExtractIds));

test/test.spec.js

@@ -15,6 +15,12 @@ import lib from "../index.js";
 // CONSTANTS
 const kDirname = path.dirname(fileURLToPath(import.meta.url));
 
+describe("version", () => {
+  it("Should get libheif version", () => {
+    assert.strictEqual(/\d{1}\.\d{1,2}\.\d{1,2}/.test(lib.version()), true);
+  });
+});
+
 describe("toJpeg", () => {
   it("Should convert .heic to .jpeg", async() => {
     const heifFilePath = path.join(kDirname, "image.heic");