Giter Club home page Giter Club logo

js-xxhash's Introduction

Javascript implementation of xxHash

Synopsis

xxHash is a very fast hashing algorithm (see the details here). xxhashjs is a Javascript implementation of it, written in 100% Javascript. Although not as fast as the C version, it does perform pretty well given the current Javascript limitations in handling unsigned 32 bits integers.

Installation

In nodejs:

npm install xxhashjs

In the browser, include the following, and access the constructor with XXH:

<script src="/your/path/to/xxhash.lmd.js"></script>

Examples

  • In one step:
var h = XXH( 'abcd', 0xABCD ).toString(16)	// seed = 0xABCD

0xCDA8FAE4

  • In several steps (useful in conjunction of NodeJS streams):
var H = XXH( 0xABCD )	// seed = 0xABCD
var h = H.update( 'abcd' ).digest().toString(16)

0xCDA8FAE4

  • More examples in the examples directory:
    • Compute xxHash from a file data
    • Use xxHashjs in the browser

Usage

  • In one step: XXH(<data>, <seed>) The data can either be a string, an ArrayBuffer or a NodeJS Buffer object. The seed can either be a number or a UINT32 object.

  • In several steps:

    • instantiate a new XXH object: XXH(<seed>) or XXH() The seed can be set later on with the init method

    • add data to the hash calculation: XXH.update(<data>)

    • finish the calculations: XXH.digest()

The object returned can be converted to a string with toString(<radix>) or a number toNumber(). Once digest() has been called, the object can be reused. The same seed will be used or it can be changed with init(<seed>).

Methods

  • XXH.init(<seed>) Initialize the XXH object with the given seed. The seed can either be a number or a UINT32 object.
  • XXH.update(<data>) Add data for hashing. The data can either be a string, an ArrayBuffer or a NodeJS Buffer object.
  • XXH.digest() (UINT32) Finalize the hash calculations and returns an UINT32 object. The hash value can be retrived with toString().

License

MIT

js-xxhash's People

Contributors

pierrec avatar theultdev avatar hnilsen avatar

Watchers

 avatar James Cloos avatar

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.