@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.374.0 (2023-07-20)

Bug Fixes

• packages: fix migrated package imports (#4990) (d800f78)

Features

• client-codecatalyst: This release adds support for updating and deleting spaces and projects in Amazon CodeCatalyst. It also adds support for creating, getting, and deleting source repositories in CodeCatalyst projects. (05a9f89)
• client-connectcases: This release adds the ability to assign a case to a queue or user. (f47d6f4)
• client-lex-models-v2: This release updates type for Channel field in SessionSpecification and UtteranceSpecification (1f77d0a)
• client-route53resolver: This release adds support for Route 53 On Outposts, a new feature that allows customers to run Route 53 Resolver and Resolver endpoints locally on their Outposts. (8acc64c)
• client-s3: Improve performance of S3 clients by simplifying and optimizing endpoint resolution. (72eb598)
• client-sagemaker-featurestore-runtime: Cross account support for SageMaker Feature Store (b0593ab)
• client-sagemaker: Cross account support for SageMaker Feature Store (e4918c1)
• client-securitylake: Adding support for Tags on Create and Resource Tagging API. (596636d)
• client-transcribe: Added API argument --toxicity-detection to startTranscriptionJob API, which allows users to view toxicity scores of submitted audio. (9e7552a)
• smithy-client: update client defaults provider (830cb06)