Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.94 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.94 KB

Sumchecker

Build Status Code Coverage Dependency Status NPM package

Sumchecker is a pure Node.js solution to validating files specified in a checksum file, which are usually generated by programs such as sha256sum.

Requirements

sumchecker is tested with Node.js 14.19.0 (LTS) and above.

Usage

const sumchecker = require("sumchecker");

// NB: Top-level await is available in Node.js >= 14.8.0. Non-top-level-await syntax is left as an
// exercise to the reader.
try {
  await sumchecker(algorithm, checksumFilename, baseDir, filesToCheck);
  console.log("All files validate!");
} catch (error) {
  console.error("An error occurred", error);
}

For details, see the API documentation.

Security contact information

See SECURITY.md.

Legal

This library is copyrighted under the terms of the Apache 2.0 License.

Enterprise support

Available as part of the Tidelift Subscription.

The maintainers of sumchecker and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.