@aws-sdk/hash-node

What is @aws-sdk/hash-node?

The @aws-sdk/hash-node package is part of the AWS SDK for JavaScript (v3) and is specifically designed for hashing functionalities within Node.js environments. It provides a set of utilities for generating hash digests of data. This can be particularly useful for creating secure, fixed-size representations of data for tasks such as validating the integrity of files, securely storing passwords, or implementing caching mechanisms.

What are @aws-sdk/hash-node's main functionalities?

Generating SHA-256 Hashes

This feature allows you to generate SHA-256 hash digests of data. The code sample demonstrates how to create a new Hash instance, update it with the data to be hashed, and then generate the digest.

const { Hash } = require('@aws-sdk/hash-node');
const hash = new Hash('sha256');
hash.update('data to hash');
const digest = await hash.digest();
console.log(digest);

Streaming Data Hashing

This feature is useful for hashing large files or streaming data. The code sample shows how to create a hash instance, stream a file, update the hash with chunks of the file, and finally generate the digest once the stream ends.

const { Hash } = require('@aws-sdk/hash-node');
const fs = require('fs');
const fileStream = fs.createReadStream('path/to/file');
const hash = new Hash('sha256');
fileStream.on('data', (chunk) => hash.update(chunk));
fileStream.on('end', async () => {
  const digest = await hash.digest();
  console.log(digest);
});

Other packages similar to @aws-sdk/hash-node

crypto

The 'crypto' module is a built-in Node.js module that provides cryptographic functionality that includes a set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify functions. Unlike @aws-sdk/hash-node, it is built into Node.js and does not require an additional installation. It offers a wider range of cryptographic functions but might be more complex to use for simple hashing needs.

hasha

Hasha is a high-performance Node.js hashing module that makes it easy to create hash digests of data. It supports multiple algorithms and can hash strings, buffers, and streams. Compared to @aws-sdk/hash-node, hasha is more focused on simplicity and ease of use for hashing operations, without the broader AWS SDK context.

README

md5-node

An internal package

Usage

You probably shouldn't, at least directly.