jasterv/imgphash
1
0
Fork 0
mirror of https://codeberg.org/JasterV/imgphash.git synced 2026-04-26 18:10:01 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
36 commits 2 branches 3 tags 339 KiB
JavaScript 100%
Find a file
Dan Flettre 6e4a899128 update deps and convert to esm 
- resolves 7 vulnerabilities in dependencies
  - updates code to ESM. This is a breaking change for CommonJS consumers of this package, but it was necessary to get the latest patched axios package.
  - switch from jest to mocha for better esm support

add extensions to file imports

switch from jest to mocha
2024-04-03 19:29:06 -05:00
.github Merge pull request #5 from JasterV/JasterV-patch-1 2024-04-04 01:56:20 +02:00
src update deps and convert to esm 2024-04-03 19:29:06 -05:00
test update deps and convert to esm 2024-04-03 19:29:06 -05:00
.gitignore first commit 2022-03-18 16:03:06 +01:00
.npmrc first commit 2022-03-21 10:39:08 +01:00
LICENSE Create LICENSE 2022-03-21 10:46:01 +01:00
package-lock.json update deps and convert to esm 2024-04-03 19:29:06 -05:00
package.json update deps and convert to esm 2024-04-03 19:29:06 -05:00
README.md patch update 2022-03-22 09:52:01 +01:00

README.md

Welcome to imgphash 👋

Version Documentation Maintenance License: MIT

Provide an image class that is able to calculate similarity to other images using the phash value

🏠 Homepage

Install

npm i imgphash

Use

This module provides a class HashImage that you can use to hash an image and compare it

  • Create a HashImage from a url
const image = await HashImage.fromUrl(url1)
  • Create a HashImage from a Node buffer
const image = new HashImage(buffer)
  • Get the hash of 2 images and compare them
const image1 = await HashImage.fromUrl(url1);
const image2 = await HashImage.fromUrl(url2);
const hash1 = await image1.phash() // PHash instance
const hash2 = await image2.phash()
const similarity = hash1.compare(hash2)

The hash function returns an instance of PHash

  • Or just compare 2 image objects, this is going to internally calculate their hash and use it
const image1 = await HashImage.fromUrl(url1);
const image2 = await HashImage.fromUrl(url2);
const similarity = await image1.compare(image2);

All the comparisons return a value between 0 and 1. 0 meaning that the images are completely different and 1 meaning they are exactly the same image

Author

👤 Victor Martinez jaster.victor@gmail.com

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Victor Martinez jaster.victor@gmail.com.
This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator