npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

hmsearch

v0.1.0

Published

Efficiently find hashes within a certain hamming distance, typically used for perceptual hashing.

Downloads

3

Readme

hmsearch-node

Node API to HmSearch library. For more information on the library, see https://github.com/commonsmachinery/hmsearch

Installing

Currently the build only supports Linux. Pull requests for Mac and Windows are welcome!

Ensure that Kyoto Cabinet is installed. On Ubuntu:

apt-get install libkyotocabinet-dev kyotocabinet-util

When building from the git repository the hmsearch submodule must be initialised on first checkout:

git submodule init
git submodule update

API

For details on these methods, see the documentation for the C++ library: https://github.com/commonsmachinery/hmsearch/blob/master/hmsearch.h

The synchronous methods all throw an Error if the operation fails, with the message providing further details. The asynchronous methods instead invoke the callback with the first argument set to an Error instance.

Initialise a database

hmsearch.initdb(path, hash_bits, max_error, num_hashes, function(err) {...})

hmsearch.initdbSync(path, hash_bits, max_error, num_hashes)

Open a database

hmsearch.open(path, mode, function(err, db) {...})

db = hmsearch.openSync(path, mode)

Mode is either hmsearch.READONLY or hmsearch.READWRITE.

db is a newly opened database object.

Close a database

db.close(function(err) {...})

db.closeSync()

Sync any changes to the database and close it. This must be done to release any locks on the database so other processes can access it.

It is safe to close the database multiple times.

The database is also closed when the database object is garbage collected.

Insert a hash

db.insert(hash, function(err) {...})

db.insertSync(hash)

hash must be a hexadecimal string of the correct length.

Lookup a hash

db.lookupSync(query, [max_error], function(err, matches) {...})

matches = db.lookupSync(query, [max_error])

query must be a hexadecimal string of the correct length. If max_error is provided and non-negative, it can further restrict the accepted hamming distance than the database default.

matches lists each matching hash as a hexadecimal string and the hamming distance to the query hash:

[ { hash: '0123456789abcdef', distance: 3 }, ... ]

matches is an empty list if no hashes are found.

License

Copyright 2014 Commons Machinery http://commonsmachinery.se/

Distributed under an MIT license, please see LICENSE in the top dir.

Contact: [email protected]