Wondering what’s next for npm?Check out our public roadmap! »

    sumchecker
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2 • Public • Published

    Sumchecker

    Travis CI AppVeyor CI Code Climate Test Coverage

    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

    sumchecker(algorithm, checksumFilename, baseDir, filesToCheck)
      .then(() => {
        console.log('All files validate!');
      }, (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:

    Legal

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

    Keywords

    Install

    npm i [email protected]

    Version

    2.0.2

    License

    Apache-2.0

    Last publish

    Collaborators

    • avatar