# browser-image-hash

> Image to dhash for Browser

Latest version **0.0.7** (published 2026-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install browser-image-hash
pnpm add browser-image-hash
yarn add browser-image-hash
bun add browser-image-hash
```

## Health

**Score 65/100 (B)** — status: stable.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.0.7 |
| Published | 2026-03-16 |
| First published | 2019-08-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 3 |
| Unpacked size | 51.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 6 |
| Author | ytetsuro |
| Maintainers | ytetsuro |
| Keywords | image, dhash, imagehash, difference, hashing |

## Links

- npm: https://www.npmjs.com/package/browser-image-hash
- Repository: https://github.com/ytetsuro/image-hash
- Homepage: https://github.com/ytetsuro/image-hash#readme
- Issues: https://github.com/ytetsuro/image-hash/issues
- npm.io page: https://npm.io/package/browser-image-hash

## Dependencies (3)

- [decimal.js](https://npm.io/package/decimal.js.md) ^10.2.0
- [wasm-imagemagick](https://npm.io/package/wasm-imagemagick.md) ^1.2.3
- [@rgba-image/lanczos](https://npm.io/package/@rgba-image/lanczos.md) ^0.1.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 0.0.7 (latest) — 2026-03-16
- 0.0.6 — 2026-03-16
- 0.0.5 — 2021-07-09
- 0.0.4 — 2021-07-09
- 0.0.3 — 2020-11-18
- 0.0.2 — 2019-08-26

## README

[![Build Status](https://travis-ci.org/ytetsuro/image-hash.svg?branch=master)](https://travis-ci.org/ytetsuro/image-hash)
[![codecov](https://codecov.io/gh/ytetsuro/image-hash/branch/master/graph/badge.svg)](https://codecov.io/gh/ytetsuro/image-hash)

# Browser image hash

This is browser image hash generator.

This library is made to generate the same hash as [image-hash](https://github.com/JohannesBuchner/imagehash) as much as possible.

## Supported

* difference hashing ([dHash](http://www.hackerfactor.com/blog/index.php?/archives/529-Kind-of-Like-That.html))
* average hashing ([aHash](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html))
* perception hashing ([pHash](http://www.hackerfactor.com/blog/index.php?/archives/432-Looks-Like-It.html))
* wavelet hashing ([wHash](https://fullstackml.com/2016/07/02/wavelet-image-hash-in-python/))

## Installation

```bash
$ npm install browser-image-hash
```

## Basic Usage

```typescript
import {DifferenceHashBuilder, Hash} from 'browser-image-hash';

document.addEventListener('DOMContentLoaded', async () => {
  const builder = new DifferenceHashBuilder();
  const targetURL = new URL('./example.jpg', window.location.href);
  const destHash = await builder.build(targetURL);
  const srcHash = new Hash('0111011001110000011110010101101100110011000100110101101000111000');

  if (srcHash.getHammingDistance(destHash) <= 10) {
     console.log('Resembles');
     return;
  }

  console.log('Different');
});
```

## Other Hash Algorithms

```typescript
import {
  AverageHashBuilder,
  PerceptualHashBuilder,
  WaveletHashBuilder,
} from 'browser-image-hash';

const url = new URL('./example.jpg', window.location.href);

// Average Hash
const aHash = await new AverageHashBuilder().build(url);

// Perceptual Hash
const pHash = await new PerceptualHashBuilder().build(url);

// Wavelet Hash
const wHash = await new WaveletHashBuilder().build(url);
```

## Type-safe Hash Comparison

Each builder returns a branded hash type (`DHash`, `AHash`, `PHash`, `WHash`). `getHammingDistance` only accepts the same hash type at compile time.

```typescript
import type { DHash, AHash } from 'browser-image-hash';

const d1: DHash = await new DifferenceHashBuilder().build(url1);
const d2: DHash = await new DifferenceHashBuilder().build(url2);
const a1: AHash = await new AverageHashBuilder().build(url1);

d1.getHammingDistance(d2); // OK
d1.getHammingDistance(a1); // Compile error
```

## Warning

Since this library uses canvas, please be careful of the same origin policy.

[Allowing cross-origin use of images and canvas](https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image)

---
_Source: https://npm.io/package/browser-image-hash · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._