Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

phash-imagemagick

standard-analytics163apache-v21.0.1

get and compare perceptual hashes (as computed by imagemagick)

perceptual, hash, phash

readme

phash-imagemagick

CircleCI

Get and compare perceptual hashes (as computed by imagemagick).

Installation

  • Install imagemagick (brew install imagemagick on OSX).

Run:

npm install

Usage

Get a perceptual hash

var pHash = require('phash-imagemagick');

pHash.get('image.png', function(err, data) {
  console.log(data.pHash);
});

pHash.get(input, callback)

where input is a filePath or a readable stream.

Test if 2 perceptual hashes are similar

pHash.eq(obj1, obj2)

where obj1 and obj2 are object obtained from pHash.get.

Test

Run:

npm test