@cumulus/checksum
Advanced tools
The @cumulus/checksum library provides checksum functionality used by Cumulus
packages and tasks. Currently the supported input includes file streams, and
supported checksum algorithms include cksum and the algorithms available to
the crypto package, as documented
here.
const fs = require('fs');
const { generateChecksumFromStream } = require('@cumulus/checksum');
const stream = fs.createReadStream('myDataFile.hdf');
const myCksum = generateChecksumFromStream('cksum', stream);
Promise.<(number|string)>Promise.<boolean>Promise.<(number|string)>Create file checksum from readable stream
Kind: static method of checksum
Returns: Promise.<(number|string)> - the file checksum
| Param | Type | Description |
|---|---|---|
| algorithm | string | Checksum algorithm type |
| stream | stream.Readable | A readable file stream |
| [options] | Object | Checksum options, see crypto.createHash() |
Promise.<boolean>Validate expected checksum against calculated checksum
Kind: static method of checksum
Returns: Promise.<boolean> - whether expectedSum === calculatedSum
| Param | Type | Description |
|---|---|---|
| algorithm | string | Checksum algorithm |
| stream | stream.Readable | A readable file stream |
| expectedSum | number | string | expected checksum |
| [options] | Object | Checksum options |
Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.
Generated automatically using npm run build-docs
FAQs
Cumulus checksum utilities
The npm package @cumulus/checksum receives a total of 87 weekly downloads. As such, @cumulus/checksum popularity was classified as not popular.
We found that @cumulus/checksum demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Fluent Assertions is facing backlash after dropping the Apache license for a commercial model, leaving users blindsided and questioning contributor rights.
Research
Security News
Socket researchers uncover the risks of a malicious Python package targeting Discord developers.
Security News
The UK is proposing a bold ban on ransomware payments by public entities to disrupt cybercrime, protect critical services, and lead global cybersecurity efforts.