Merge pull request #3 from argos-ci/async-api

feat: make the API async

Author: gregberge

README.md

@@ -69,7 +69,7 @@ import { fingerprintDiff } from 'mask-fingerprint'
 
 const png = fs.readFileSync('diff.png')
 
-const fingerprint = fingerprintDiff(png, {
+const fingerprint = await fingerprintDiff(png, {
   gridSize: 16,
   dilateRadius: 1,
   padToSquare: true,
@@ -92,6 +92,8 @@ The returned value is designed to be stored in a database, indexed, and compared
 
 ### `fingerprintDiff(buffer, options?)`
 
+Returns a `Promise<string>`.
+
 #### Parameters
 
 **buffer**

__test__/index.spec.ts

@@ -5,32 +5,32 @@ import { describe, expect, it } from 'vitest'
 import { fingerprintDiff } from '../index'
 
 describe('diff fingerprint', () => {
-  it('generates a same fingerprint for similar diffs', () => {
+  it('generates a same fingerprint for similar diffs', async () => {
     const fixturesDir = path.join(__dirname, './__fixtures__')
 
-    const generateFingerprintFromFilename = (name: string) => {
+    const generateFingerprintFromFilename = async (name: string) => {
       const diffPath = path.join(fixturesDir, name)
       const buffer = fs.readFileSync(diffPath)
       console.time(name)
-      const res = fingerprintDiff(buffer)
+      const res = await fingerprintDiff(buffer)
       console.timeEnd(name)
       return res
     }
 
-    const generateFingerprintFromPath = (name: string) => {
+    const generateFingerprintFromPath = async (name: string) => {
       const diffPath = path.join(fixturesDir, name)
       console.time(`${name}-path`)
-      const res = fingerprintDiff(diffPath)
+      const res = await fingerprintDiff(diffPath)
       console.timeEnd(`${name}-path`)
       return res
     }
 
-    const fA1 = generateFingerprintFromFilename('diff-A1.png')
-    const fA1Path = generateFingerprintFromPath('diff-A1.png')
-    const fA2 = generateFingerprintFromFilename('diff-A2.png')
-    const fA3 = generateFingerprintFromFilename('diff-A3.png')
-    const fB1 = generateFingerprintFromFilename('diff-B1.png')
-    const fLong = generateFingerprintFromFilename('long-diff.png')
+    const fA1 = await generateFingerprintFromFilename('diff-A1.png')
+    const fA1Path = await generateFingerprintFromPath('diff-A1.png')
+    const fA2 = await generateFingerprintFromFilename('diff-A2.png')
+    const fA3 = await generateFingerprintFromFilename('diff-A3.png')
+    const fB1 = await generateFingerprintFromFilename('diff-B1.png')
+    const fLong = await generateFingerprintFromFilename('long-diff.png')
 
     expect(fA1).toBe('v1:g16:d1:t0.002,0.02,0.08:202566ca9533046b')
     expect(fA1).toBe(fA2)

index.d.ts

@@ -1,6 +1,6 @@
 /* auto-generated by NAPI-RS */
 /* eslint-disable */
-export declare function fingerprintDiff(pngInput: string | Buffer, options?: JsEqualityFingerprintOptions | undefined | null): string
+export declare function fingerprintDiff(pngInput: string | Buffer, options?: JsEqualityFingerprintOptions | undefined | null): Promise<string>
 
 export interface JsEqualityFingerprintOptions {
   redThreshold?: JsRedThreshold