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
47 commits 2 branches 3 tags 339 KiB
  • JavaScript 100%
Find a file
dependabot[bot] f29b5d1dd1
 Bump @types/node from 20.12.5 to 20.12.7 
Bumps [@types/node](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/node) from 20.12.5 to 20.12.7.
- [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases)
- [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/node)

---
updated-dependencies:
- dependency-name: "@types/node"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-04-15 05:57:47 +00:00
.github Create npm-publish.yml 2024-04-04 10:03:48 +02:00
src install prettier 2024-04-04 10:11:08 +02:00
test install prettier 2024-04-04 10:11:08 +02:00
.gitignore first commit 2022-03-18 16:03:06 +01:00
.mise.toml add .mise.toml 2024-04-04 10:11:17 +02: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 Bump @types/node from 20.12.5 to 20.12.7 2024-04-15 05:57:47 +00:00
package.json forgot to update package.json 2024-04-04 10:19:11 +02:00
README.md Update README.md 2024-04-08 14:53:30 +02: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