Skip to content

Commit bbbfeff

Browse files
BendingBendersindresorhus
BendingBender
authored and
sindresorhus
committed
Require Node.js 8, add TypeScript definition (#12)
1 parent 926c7b2 commit bbbfeff

11 files changed

+93
-68
lines changed

‎.editorconfig

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ charset = utf-8
77
trim_trailing_whitespace = true
88
insert_final_newline = true
99

10-
[{package.json,*.yml}]
10+
[*.yml]
1111
indent_style = space
1212
indent_size = 2

‎.gitattributes

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
* text=auto
2-
*.js text eol=lf
1+
* text=auto eol=lf

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
node_modules
2+
yarn.lock

‎.npmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=false

‎.travis.yml

-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,3 @@ node_js:
33
- '12'
44
- '10'
55
- '8'
6-
- '6'

‎index.d.ts

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/// <reference types="node"/>
2+
3+
/**
4+
Create a MD5 hash with hex encoding.
5+
6+
@param data - Prefer buffers as they're faster to hash, but strings can be useful for small things.
7+
8+
Pass an array instead of concatenating strings and/or buffers. The output is the same, but arrays do not incur the overhead of concatenation.
9+
10+
@example
11+
```
12+
import * as fs from 'fs';
13+
import md5Hex = require('md5-hex');
14+
15+
const buffer = fs.readFileSync('unicorn.png');
16+
17+
md5Hex(buffer);
18+
//=> '1abcb33beeb811dca15f0ac3e47b88d9'
19+
```
20+
*/
21+
declare function md5Hex(data: Buffer | string | ReadonlyArray<Buffer | string>): string;
22+
23+
export = md5Hex;

‎index.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
'use strict';
22
const crypto = require('crypto');
33

4-
module.exports = function (input) {
4+
module.exports = function (data) {
55
const hash = crypto.createHash('md5');
66

7-
const update = buf => {
8-
const inputEncoding = typeof buf === 'string' ? 'utf8' : undefined;
9-
hash.update(buf, inputEncoding);
7+
const update = buffer => {
8+
const inputEncoding = typeof buffer === 'string' ? 'utf8' : undefined;
9+
hash.update(buffer, inputEncoding);
1010
};
1111

1212
if (arguments.length > 1) {
1313
throw new Error('Too many arguments. Try specifying an array.');
1414
}
1515

16-
if (Array.isArray(input)) {
17-
input.forEach(update);
16+
if (Array.isArray(data)) {
17+
data.forEach(update);
1818
} else {
19-
update(input);
19+
update(data);
2020
}
2121

2222
return hash.digest('hex');

‎index.test-d.ts

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import {expectType} from 'tsd';
2+
import * as fs from 'fs';
3+
import md5Hex = require('.');
4+
5+
const buffer = fs.readFileSync('unicorn.png');
6+
7+
expectType<string>(md5Hex(buffer));
8+
expectType<string>(md5Hex([buffer]));
9+
expectType<string>(md5Hex('foo'));
10+
expectType<string>(md5Hex(['foo']));
11+
expectType<string>(md5Hex([buffer, 'foo']));

‎license

+4-16
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,9 @@
1-
The MIT License (MIT)
1+
MIT License
22

33
Copyright (c) Sindre Sorhus <[email protected]> (sindresorhus.com)
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
116

12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
7+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
148

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
9+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎package.json

+40-37
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
11
{
2-
"name": "md5-hex",
3-
"version": "2.0.0",
4-
"description": "Create a MD5 hash with hex encoding",
5-
"license": "MIT",
6-
"repository": "sindresorhus/md5-hex",
7-
"author": {
8-
"name": "Sindre Sorhus",
9-
"email": "[email protected]",
10-
"url": "sindresorhus.com"
11-
},
12-
"engines": {
13-
"node": ">=4"
14-
},
15-
"scripts": {
16-
"test": "xo && ava"
17-
},
18-
"files": [
19-
"index.js",
20-
"browser.js"
21-
],
22-
"keywords": [
23-
"hash",
24-
"crypto",
25-
"md5",
26-
"hex",
27-
"buffer",
28-
"browser",
29-
"browserify"
30-
],
31-
"dependencies": {
32-
"md5-o-matic": "^0.1.1"
33-
},
34-
"devDependencies": {
35-
"ava": "*",
36-
"xo": "*"
37-
},
38-
"browser": "browser.js"
2+
"name": "md5-hex",
3+
"version": "2.0.0",
4+
"description": "Create a MD5 hash with hex encoding",
5+
"license": "MIT",
6+
"repository": "sindresorhus/md5-hex",
7+
"author": {
8+
"name": "Sindre Sorhus",
9+
"email": "[email protected]",
10+
"url": "sindresorhus.com"
11+
},
12+
"engines": {
13+
"node": ">=8"
14+
},
15+
"scripts": {
16+
"test": "xo && ava && tsd"
17+
},
18+
"files": [
19+
"index.js",
20+
"index.d.ts",
21+
"browser.js"
22+
],
23+
"keywords": [
24+
"hash",
25+
"crypto",
26+
"md5",
27+
"hex",
28+
"buffer",
29+
"browser",
30+
"browserify"
31+
],
32+
"dependencies": {
33+
"md5-o-matic": "^0.1.1"
34+
},
35+
"devDependencies": {
36+
"@types/node": "^12.0.0",
37+
"ava": "^1.4.1",
38+
"tsd": "^0.7.2",
39+
"xo": "^0.24.0"
40+
},
41+
"browser": "browser.js"
3942
}

‎readme.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Checkout [`hasha`](https://github.com/sindresorhus/hasha) if you need something
1212
## Install
1313

1414
```
15-
$ npm install --save md5-hex
15+
$ npm install md5-hex
1616
```
1717

1818

@@ -30,11 +30,11 @@ md5Hex(buffer);
3030

3131
## API
3232

33-
### md5Hex(input)
33+
### md5Hex(data)
3434

35-
#### input
35+
#### data
3636

37-
Type: `Buffer` `string` `Buffer[]` `string[]`
37+
Type: `Buffer | string | Array<Buffer | string>`
3838

3939
Prefer buffers as they're faster to hash, but strings can be useful for small things.
4040

0 commit comments

Comments
 (0)