@aws-sdk/hash-stream-node

What is @aws-sdk/hash-stream-node?

@aws-sdk/hash-stream-node is a package from the AWS SDK for JavaScript that provides utilities for hashing streams. It is particularly useful for creating hash digests of data streams, which is a common requirement when working with AWS services like S3 for data integrity checks.

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

Hashing a Stream

This feature allows you to create a hash digest of a data stream using a specified hashing algorithm (e.g., SHA-256). The code sample demonstrates how to read a file as a stream and generate its hash digest.

const { Hash } = require('@aws-sdk/hash-stream-node');
const { createReadStream } = require('fs');

const stream = createReadStream('path/to/file');
const hash = new Hash('sha256');

hash.update(stream);
hash.digest().then(digest => {
  console.log('Hash digest:', digest);
});

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

crypto

The 'crypto' module is a built-in Node.js module that provides cryptographic functionality, including hashing. It can be used to hash streams, but it requires more manual setup compared to @aws-sdk/hash-stream-node. For example, you need to manually handle the stream events and update the hash accordingly.

hash-stream

The 'hash-stream' package is a third-party Node.js module that simplifies hashing streams. It provides a more straightforward API for hashing streams compared to the built-in 'crypto' module, but it may not be as tightly integrated with AWS services as @aws-sdk/hash-stream-node.

stream-hash

The 'stream-hash' package is another third-party module for hashing streams. It offers similar functionality to @aws-sdk/hash-stream-node but is more general-purpose and not specifically designed for AWS SDK integration.

README

@aws-sdk/hash-stream-node

A utility for calculating the hash of Node.JS readable streams.

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.337.0 (2023-05-22)

Bug Fixes

• node-http-handler: open promise handle while waiting for http continue (#4719) (14810d3)

Features

• client-backup: Added support for tags on restore. (ceac978)
• client-quicksight: Add support for Asset Bundle, Geospatial Heatmaps. (faef6ff)
• clients: update command documentation examples as of 2023-05-22 (4c1a871)