xxhashjs

library0.2.2jsnpmunverified

xxhashjs is a pure JavaScript implementation of the xxHash fast hashing algorithm. Currently at version 0.2.2, the library provides both 32-bit and 64-bit hashing capabilities, a feature introduced in version 0.2.0. While it aims to replicate the speed of the original C implementation, it acknowledges performance limitations inherent to JavaScript's handling of unsigned 32-bit integers. The project appears to be in a maintenance phase, with infrequent updates since its last release. It supports both Node.js environments via CommonJS and browser environments through a global `_XXH_` object, offering a convenient way to compute hashes in single or multiple steps for various data types including strings, ArrayBuffers, and Node.js Buffers.

serialization

npm install xxhashjs

github ↗package ↗

INSTALL

IMPORT

SIG · XXHASHJS

xxhashjs

serializationjavascriptv0.2.2

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

XXH

✓ const XXH = require('xxhashjs');

✗ import XXH from 'xxhashjs';

This package is CommonJS-only for Node.js environments. Attempting to use ES module import syntax will fail.

XXH.h32

✓ const XXH = require('xxhashjs'); const hash32 = XXH.h32('data', 0);

✗ import { h32 } from 'xxhashjs';

`h32` is a method on the default CommonJS export `XXH`, not a named export. It can be used in a single step or to instantiate a hasher.

_XXH_

✓ // Accessible globally after <script src="/your/path/to/xxhash.js"></script>

✗ const _XXH_ = require('xxhashjs');

In browser environments, the library exposes itself as a global variable `_XXH_` when loaded via a script tag. No explicit import or require is needed.

Demonstrates both 32-bit and 64-bit xxHash calculations, including multi-step hashing with object reuse, suitable for Node.js CommonJS or browser global usage.

// For Node.js const XXH = require('xxhashjs'); // For browser, XXH is available as _XXH_ // const XXH = _XXH_; // Instantiate a 32-bit hasher with a seed in multiple steps const H32 = XXH.h32(0xABCD); // seed = 0xABCD // Update with data (can be string, ArrayBuffer, or Buffer) H32.update('abcd'); // Digest and get the hash value as a hexadecimal string const hashValue32 = H32.digest().toString(16); console.log('32-bit hash:', hashValue32); // Expected: cda8fae4 // The hasher object can be reused with a new or the same seed H32.init(0x1234).update('some new data example').digest(); console.log('32-bit hash (reused):', H32.digest().toString(16)); // Example of 64-bit hash in one step const h64Result = XXH.h64('another string example', 0x12345678).toString(16); console.log('64-bit hash:', h64Result);

Debug

Known issues

gotchaPerformance of xxhashjs is inherently slower than native C/C++ xxHash implementations due to JavaScript's limitations in handling unsigned 32-bit integers and overall execution speed. Do not expect native performance levels.

fix

Be aware of performance characteristics for high-throughput applications. Consider native add-ons if absolute maximum speed is critical.

affects: >=0.1.0

gotchaThe package currently only supports CommonJS modules in Node.js environments. There is no official ES module (`import`) support, which can lead to errors in modern JavaScript projects configured for ESM.

fix

Ensure you use `const XXH = require('xxhashjs');` for Node.js. If you need to use it in an ESM context, consider using a CommonJS wrapper or a bundler that handles CJS modules.

affects: >=0.1.0

gotchaIn browser environments, `xxhashjs` exposes a global variable `_XXH_`. This can potentially conflict with other scripts or libraries that also define a global variable with the same name, leading to unexpected behavior.

fix

If conflicts arise, load `xxhashjs` in an isolated scope (e.g., an IIFE if possible) or consider manually mapping the global `_XXH_` to another variable immediately after loading.

affects: >=0.1.0

gotchaThe project appears to be in a maintenance-only mode with infrequent updates. The last version (0.2.2) was released some time ago, and there may not be active development for new features or prompt bug fixes.

fix

Evaluate the project's suitability for long-term critical applications. For actively maintained alternatives, explore other hashing libraries or actively developed xxHash ports.

affects: >=0.2.2

Errors

Common errors & fixes

ReferenceError: XXH is not defined (when using 'import XXH from \'xxhashjs\'')

Attempting to use ES module import syntax for a CommonJS-only package in Node.js.

fix

Change your import statement to `const XXH = require('xxhashjs');` for Node.js.

TypeError: H.update is not a function (when H = XXH.h32('data', seed))

You are trying to call `.update()` on a result from a one-step hash calculation. The `update()` method is available only on a hasher instance created for multi-step operations.

fix

To use `.update()`, first instantiate a hasher: `const H = XXH.h32(seed);` (without data), then call `H.update(data);`.

TypeError: Cannot read property 'toString' of undefined (after H.update('data'))

After calling `update()`, you need to call `digest()` on the hasher instance to finalize the calculation and get the hash value before attempting to convert it.

fix

Ensure you call `.digest()`: `const hashResult = H.digest(); console.log(hashResult.toString(16));`

ReferenceError: _XXH_ is not defined (in browser, after <script src=...></script>)

The script file for xxhashjs was either not loaded correctly, the path was wrong, or it was loaded after the code trying to access `_XXH_`.

fix

Verify the script path in your HTML `<script>` tag is correct and that the script loads before any JavaScript code that attempts to use the `_XXH_` global variable.

Upgrade

Version history

0.2.2latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

22 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/pierrec/js-xxhash ↗

packagehttps://www.npmjs.com/package/xxhashjs ↗