Conversation
BREAKING CHANGE: API is now returning a promise
There was a problem hiding this comment.
Pull request overview
This PR converts the fingerprintDiff API from synchronous to asynchronous by implementing NAPI's AsyncTask pattern, enabling non-blocking execution of the image fingerprinting operations.
Changes:
- Refactored the Rust implementation to use
AsyncTaskwith a newFingerprintDiffTaskstruct that implements theTasktrait - Updated TypeScript type definitions to return
Promise<unknown>instead ofstring - Updated all test cases to use
async/awaitsyntax
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/lib.rs | Introduced FingerprintDiffTask struct implementing Task trait; moved computation logic to compute() method for async execution; updated fingerprint_diff to return AsyncTask |
| index.d.ts | Changed return type from string to Promise<unknown> |
| test/index.spec.ts | Updated test functions to be async and added await keywords for all fingerprintDiff calls |
| README.md | Updated usage example to include await keyword and documented that the function returns a Promise<string> |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE: API is now returning a promise