Require Node.js 10

Author: kevva

.editorconfig

@@ -7,6 +7,6 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[.yml]
+[*.yml]
 indent_style = space
 indent_size = 2

.gitattributes

@@ -1,2 +1 @@
-* text=auto
-*.js text eol=lf
+* text=auto eol=lf

.travis.yml

@@ -1,5 +1,4 @@
 language: node_js
 node_js:
-  - '8'
-  - '6'
-  - '4'
+  - '12'
+  - '10'

index.js

@@ -1,9 +1,9 @@
 'use strict';
-const PNG = require('pngjs').PNG;
+const {PNG} = require('pngjs');
 
-module.exports = (buf, opts) => {
-	if (!Buffer.isBuffer(buf)) {
-		return Promise.reject(new TypeError('Expected a buffer'));
+module.exports = async (buffer, opts) => {
+	if (!Buffer.isBuffer(buffer)) {
+		throw new TypeError(`Expected \`buffer\` to be of type \`Buffer\` but received type \`${typeof buffer}\``);
 	}
 
 	return new Promise((resolve, reject) => {
@@ -16,6 +16,6 @@ module.exports = (buf, opts) => {
 		png.on('error', reject);
 		png.on('parsed', () => resolve(png));
 
-		png.end(buf);
+		png.end(buffer);
 	});
 };

package.json

@@ -10,7 +10,7 @@
 		"url": "github.com/kevva"
 	},
 	"engines": {
-		"node": ">=4"
+		"node": ">=10"
 	},
 	"scripts": {
 		"test": "xo && ava"
@@ -27,10 +27,9 @@
 		"pngjs": "^3.3.0"
 	},
 	"devDependencies": {
-		"ava": "*",
+		"ava": "^2.4.0",
 		"file-type": "^7.2.0",
 		"get-stream": "^3.0.0",
-		"pify": "^3.0.0",
-		"xo": "*"
+		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -16,7 +16,9 @@ $ npm install parse-png
 const fs = require('fs');
 const parsePng = require('parse-png');
 
-parsePng(fs.readFileSync('unicorn.png')).then(png => {
+(async () => {
+	const png = await parsePng(fs.readFileSync('unicorn.png'));
+
 	console.log(png);
 	/*
 	{
@@ -35,15 +37,15 @@ parsePng(fs.readFileSync('unicorn.png')).then(png => {
 
 	png.adjustGamma();
 	png.pack().pipe(fs.createWriteStream('unicorn-adjusted.png'));
-});
+})();
 ```
 
 
 ## API
 
-### parsePng(buffer, [options])
+### parsePng(buffer, options?)
 
-Returns a `Promise` for a PNG instance. See the [pngjs documentation](https://github.com/lukeapage/pngjs#async-api) for more information.
+Returns a `Promise<Object>` with a PNG instance. See the [pngjs documentation](https://github.com/lukeapage/pngjs#async-api) for more information.
 
 #### buffer
 
@@ -56,8 +58,3 @@ A PNG image buffer.
 Type: `Object`
 
 See the [pngjs options](https://github.com/lukeapage/pngjs#options).
-
-
-## License
-
-MIT © [Kevin Martensson](http://github.com/kevva)

test.js

@@ -2,27 +2,31 @@ import fs from 'fs';
 import fileType from 'file-type';
 import getStream from 'get-stream';
 import test from 'ava';
-import m from '.';
+import parsePng from '.';
 
 test('parse', async t => {
-	const data = await m(fs.readFileSync('./fixture.png'));
-	t.is(data.width, 200);
-	t.is(data.height, 133);
-	t.is(data.depth, 8);
-	t.true(Buffer.isBuffer(data.data));
+	const png = await parsePng(fs.readFileSync('./fixture.png'));
+	t.is(png.width, 200);
+	t.is(png.height, 133);
+	t.is(png.depth, 8);
+	t.true(Buffer.isBuffer(png.data));
 });
 
 test('pack', async t => {
-	const png = await m(fs.readFileSync('./fixture.png'));
+	const png = await parsePng(fs.readFileSync('./fixture.png'));
 	t.deepEqual(fileType(await getStream.buffer(png.pack())), {ext: 'png', mime: 'image/png'});
 });
 
 test('parse interlaced png', async t => {
-	const data = await m(fs.readFileSync('./fixture-interlaced.png'));
-	t.true(data.interlace);
+	const png = await parsePng(fs.readFileSync('./fixture-interlaced.png'));
+	t.true(png.interlace);
 });
 
 test('pack interlaced png', async t => {
-	const png = await m(fs.readFileSync('./fixture-interlaced.png'));
+	const png = await parsePng(fs.readFileSync('./fixture-interlaced.png'));
 	t.deepEqual(fileType(await getStream.buffer(png.pack())), {ext: 'png', mime: 'image/png'});
 });
+
+test('accepts buffer', async t => {
+	await t.throwsAsync(parsePng('foo'), 'Expected `buffer` to be of type `Buffer` but received type `string`');
+});