# checksum

> Checksum utility for node

Latest version **1.0.0** (published 2021-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install checksum
pnpm add checksum
yarn add checksum
bun add checksum
```

Provides the command `checksum`.

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-08-10 |
| First published | 2013-02-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/checksum) |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 71 |
| Author | Daniel D. Shaw |
| Maintainers | dshaw, bengl |
| Keywords | checksum, shasum, hash, sha, sha1, md5 |

## Links

- npm: https://www.npmjs.com/package/checksum
- Repository: https://github.com/dshaw/checksum
- Homepage: https://github.com/dshaw/checksum#readme
- Issues: http://github.com/dshaw/checksum/issues
- npm.io page: https://npm.io/package/checksum

## Dependencies (1)

- [optimist](https://npm.io/package/optimist.md) ~0.3.5

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2021-08-10
- 0.1.1 — 2013-06-04
- 0.1.0 — 2013-02-25
- 0.0.2 — 2013-02-24
- 0.0.1 — 2013-02-24

## README

# Checksum

Checksum utility for node.

## Status

[![build status](https://secure.travis-ci.org/dshaw/checksum.png)](http://travis-ci.org/dshaw/checksum)

## Install

    npm install checksum

### Usage

    var checksum = require('checksum')
      , cs = checksum('dshaw')

    if (cs === '650a94547ad8ff00d5c5e3c8d54e8503d566b8ab0029dc289b5bb4294e39b92a') {
      console.log('yay')
    }

    checksum.file('dshaw.txt', function (err, sum) {
       if (sum === '650a94547ad8ff00d5c5e3c8d54e8503d566b8ab0029dc289b5bb4294e39b92a') {
         console.log('yay yay')
       }
    })

## Checksum cli tool

    npm install -g checksum

### Options

* `-a` `--algorithm`: default `sha256`
* `-v` `--verbose`: default `false`

### Usage

    $ echo -n dshaw | checksum
    > 650a94547ad8ff00d5c5e3c8d54e8503d566b8ab0029dc289b5bb4294e39b92a

    $ checksum ./*
    > dac3afc010e743f3e6e1ff063b47faf2862454df1d60e3eef1339817cfed39ad  ./History.md
    > 54ffa21d49426466813611c248867318add8d023c2834433aee831f3f1f1746b  ./Readme.md
    > 24a902990485588c18da6c965c6c19031995777593b92d28b23e7c0fa09011dd  ./checksum.js
    > b5c6c08d3b58b0057fe380b0fad07b6382c32b48280f16fdb4e9939d7f94d5f4  ./package.json

    $ checksum -a md5 ./test/*
    > 0255f3cb587ea090a6b39b5b864bdc95  ./test/checksum.test.js

    $ checksum -a sha1 ./bin/*
    > 7934b7927e562aa7f368430bf421b4a0aff27225  ./bin/checksum-cli.js

---
_Source: https://npm.io/package/checksum · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
