# browser-md5-file

> MD5 file in browser.

Latest version **1.1.1** (published 2018-12-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install browser-md5-file
pnpm add browser-md5-file
yarn add browser-md5-file
bun add browser-md5-file
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2018-12-25 |
| First published | 2016-03-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 28 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 277 |
| Author | forsigner |
| Maintainers | forsigner |
| Keywords | md5, browser, md5 file browser |

## Links

- npm: https://www.npmjs.com/package/browser-md5-file
- Repository: https://github.com/forsigner/browser-md5-file
- Homepage: https://github.com/forsigner/browser-md5-file#readme
- Issues: https://github.com/forsigner/browser-md5-file/issues
- npm.io page: https://npm.io/package/browser-md5-file

## Dependencies (1)

- [spark-md5](https://npm.io/package/spark-md5.md) ^2.0.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2018-12-25
- 1.1.0 — 2018-10-24
- 1.0.0 — 2016-03-04

## README

# browser-md5-file [![NPM Version](http://img.shields.io/npm/v/browser-md5-file.svg?style=flat)](https://www.npmjs.org/package/browser-md5-file)

MD5 file in browser. Base on [js-spark-md5](https://github.com/satazor/js-spark-md5).

### Demo

[demo](http://forsigner.com/browser-md5-file)

### Installation

```bash
$ npm i browser-md5-file -S
```

### Usage

```js
import BMF from 'browser-md5-file';

const el = document.getElementById('upload');
const bmf = new BMF();

el.addEventListener('change', handle, false);

function handle(e) {
  const file = e.target.files[0];
  bmf.md5(
    file,
    (err, md5) => {
      console.log('err:', err);
      console.log('md5 string:', md5); // 97027eb624f85892c69c4bcec8ab0f11
    },
    progress => {
      console.log('progress number:', progress);
    },
  );
}
```

You can abort it before success to md5 :

```js
  bmf.abort();
```

### Browser compatibility

- IE9+
- Firefox
- Chrome
- Safari
- Opera

### License

[MIT](LICENSE)

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