@cumulus/checksum

Checksum

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.

Usage

const fs = require('fs');
const { generateChecksumFromStream } = require('@cumulus/checksum');

const stream = fs.createReadStream('myDataFile.hdf');
const myCksum = generateChecksumFromStream('cksum', stream);

API

checksum

• checksum
  • .generateChecksumFromStream(algorithm, stream, [options]) ⇒ Promise.<(number|string)>
  • .validateChecksumFromStream(algorithm, stream, expectedSum, [options]) ⇒ Promise.<boolean>

checksum.generateChecksumFromStream(algorithm, stream, [options]) ⇒ 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() |

checksum.validateChecksumFromStream(algorithm, stream, expectedSum, [options]) ⇒ 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 |

About Cumulus

Cumulus is a cloud-based data ingest, archive, distribution and management prototype for NASA's future Earth science data streams.

Cumulus Documentation

Generated automatically using npm run build-docs