mirror of
https://github.com/github/codeql-action.git
synced 2025-12-28 18:20:08 +08:00
50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
# md5-hex [](https://travis-ci.org/sindresorhus/md5-hex)
|
|
|
|
> Create a MD5 hash with hex encoding
|
|
|
|
*Please don't use MD5 hashes for anything sensitive!*
|
|
|
|
Works in the browser too, when used with a bundler like Webpack, Rollup, Browserify.
|
|
|
|
Checkout [`hasha`](https://github.com/sindresorhus/hasha) if you need something more flexible.
|
|
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install md5-hex
|
|
```
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const fs = require('fs');
|
|
const md5Hex = require('md5-hex');
|
|
|
|
const buffer = fs.readFileSync('unicorn.png');
|
|
|
|
md5Hex(buffer);
|
|
//=> '1abcb33beeb811dca15f0ac3e47b88d9'
|
|
```
|
|
|
|
|
|
## API
|
|
|
|
### md5Hex(data)
|
|
|
|
#### data
|
|
|
|
Type: `Buffer | string | Array<Buffer | string>`
|
|
|
|
Prefer buffers as they're faster to hash, but strings can be useful for small things.
|
|
|
|
Pass an array instead of concatenating strings and/or buffers. The output is the same, but arrays do not incur the overhead of concatenation.
|
|
|
|
|
|
## Related
|
|
|
|
- [crypto-hash](https://github.com/sindresorhus/crypto-hash) - Tiny hashing module that uses the native crypto API in Node.js and the browser
|
|
- [hasha](https://github.com/sindresorhus/hasha) - Hashing made simple
|
|
- [hash-obj](https://github.com/sindresorhus/hash-obj) - Get the hash of an object
|