Git Product home page Git Product logo

murmurhash-wasm's Introduction

MurmurHash WASM

Build Status XO code style codecov

MurmurHash in WASM for Node.js and the browser.

Generated documentation is here: https://murmurhash-wasm.jonah.pw.

The WASM is inlined into the JS file to prevent issues from loading the module.

Usage

MurmurHash3

32-bit hash

Hashes a provided key with a seed using the MurmurHash3 algorithm yielding a 32-bit hash.

Refer to the documentation for more info.

import {MurmurHash3} from 'murmurhash-wasm';

const key = 'hello';
const seed = 0;

const hash = MurmurHash3.hash32(key, seed);

const hex = hash.toString('hex');
// '5844da46'
const value = hash.readUInt32BE();
// 1480907334

Installation

npm install murmurhash-wasm
# or
yarn add murmurhash-wasm

Browsers

When running in the browser the global Buffer object will be used when available. If it's not defined the library will use feross/buffer as a fallback (a ponyfill).

The global Buffer will never be modified or globally polyfilled.

Benchmarks

Some benchmarks for the library are available in the benchmark/ directory of the source. See contributing.md for info on how to run them yourself.

The results on my MacBook Pro (16-inch, 2019) are shown below:

crypto
--> MD5: 681,199ops/sec
--> SHA-1: 681,663ops/sec
murmurhash-wasm
--> MurmurHash3 32-bit: 793,651ops/sec

As you can see, this library performs slightly better than the native crypto MD5 and SHA-1 hash function implementations.

It's important to mention that the MurmurHash variants are not cryptographic hash functions like SHA-1 and MD5 were originally designed to be. Comparing them isn't done to say "this library is a faster alternative than MD5 and SHA-1", but rather "here's how this library compares to similar hashing solutions".

murmurhash-wasm's People

Contributors

jonahsnider avatar renovate-bot avatar renovate[bot] avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

murmurhash-wasm's Issues

The automated release is failing 🚨

🚨 The automated release from the main branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the main branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Repository problems

These problems occurred while renovating this repository. View logs.

  • WARN: Using npm packages for Renovate presets is now deprecated. Please migrate to repository-based presets instead.

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

  • build(deps): update mcr.microsoft.com/vscode/devcontainers/typescript-node docker tag to v1

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Detected dependencies

dockerfile
.devcontainer/Dockerfile
  • mcr.microsoft.com/vscode/devcontainers/typescript-node 0-16-bullseye
github-actions
.github/workflows/ci.yml
  • actions/checkout v4
  • actions/setup-node v4
  • actions/upload-artifact v4
  • actions/upload-artifact v4
  • actions/upload-artifact v4
  • actions/checkout v4
  • actions/setup-node v4
  • actions/upload-artifact v4
  • actions/checkout v4
  • actions/setup-node v4
  • actions/checkout v4
  • actions/setup-node v4
  • actions/checkout v4
  • actions/setup-node v4
  • codecov/codecov-action v4
  • actions/checkout v4
  • actions/setup-node v4
  • actions/checkout v4
  • actions/setup-node v4
nodenv
.node-version
  • node 20
npm
package.json
  • @assemblyscript/loader 0.27.27
  • buffer 6.0.3
  • @babel/core 7.24.7
  • @babel/preset-env 7.24.7
  • @babel/preset-typescript 7.24.7
  • @jonahsnider/benchmark 5.0.3
  • @jonahsnider/prettier-config 1.1.2
  • @jonahsnider/xo-config 5.3.0
  • @microsoft/api-extractor 7.47.0
  • @tsconfig/node16 16.1.3
  • @types/jest 29.5.12
  • @types/node 20.14.2
  • assemblyscript 0.27.27
  • babel-jest 29.7.0
  • enhanced-resolve 5.17.0
  • esbuild 0.21.5
  • jest 29.7.0
  • prettier 3.3.2
  • semantic-release 22.0.12
  • ts-node 10.9.2
  • typedoc 0.25.13
  • typescript 4.9.5
  • xo 0.58.0
  • node >=12.20.0
  • yarn 3.8.2

  • Check this box to trigger a request for Renovate to run again on this repository

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.