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
76 commits 2 branches 3 tags 339 KiB
JavaScript 100%
Find a file
dependabot[bot] 584e712184
Bump actions/checkout from 4 to 6 
Bumps [actions/checkout](https://github.com/actions/checkout) from 4 to 6.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v4...v6)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-03-01 17:27:35 +00:00
.github Bump actions/checkout from 4 to 6 2026-03-01 17:27:35 +00:00
src update code to support latest node 2026-03-01 18:16:47 +01:00
test update code to support latest node 2026-03-01 18:16:47 +01:00
.gitignore first commit 2022-03-18 16:03:06 +01:00
.mise.toml update mise.toml 2026-03-01 18:16:51 +01:00
.npmrc first commit 2022-03-21 10:39:08 +01:00
bun.lock feat: migrate to bun and update dependencies 2026-03-01 18:16:47 +01:00
LICENSE Create LICENSE 2022-03-21 10:46:01 +01:00
package.json update version 2026-03-01 18:17:47 +01: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