Socket
Socket
Sign inDemoInstall

sumchecker

Package Overview
Dependencies
2
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

sumchecker

Checksum validator


Version published
Maintainers
1
Weekly downloads
679,626
decreased by-6.04%

Weekly downloads

Readme

Source

Sumchecker

Travis CI AppVeyor CI Code Coverage Dependency Status

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

Usage

const sumchecker = require('sumchecker');

try {
  await sumchecker(algorithm, checksumFilename, baseDir, filesToCheck);
  console.log('All files validate!');
} catch (error) {
  console.error('An error occurred', error);
}

Returns a Promise. The promise is resolved when all files specified in filesToCheck are validated. The promise is rejected otherwise.

Parameters

algorithm

String - The hash algorithm used in checksumFilename. Corresponds to the algorithms allowed by crypto.createHash().

checksumFilename

String - The path to the checksum file.

baseDir

String - The base directory for the files specified in filesToCheck.

filesToCheck

Array or String - one or more paths of the files that will be validated, relative to baseDir.

Errors

These are sumchecker-specific error classes that are passed to the promise's reject callback.

sumchecker.ChecksumMismatchError

When at least one of the files does not match its expected checksum.

Properties:

  • filename (String) - a path to a file that did not match
sumchecker.ChecksumParseError

When the checksum file cannot be parsed (as in, it does not match the checksum file format).

Properties:

  • lineNumber (Number) - the line number that could not be parsed
  • line (String) - the raw line data that could not be parsed, sans newline
sumchecker.NoChecksumFoundError

When at least one of the files specified to check is not listed in the checksum file.

Properties:

Support

Get supported sumchecker with the Tidelift Subscription.

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

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

Keywords

FAQs

Last updated on 25 Nov 2019

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc