Require Node.js 8, add TypeScript definition (#14)

Author: BendingBender

.travis.yml

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

index.d.ts

@@ -0,0 +1,46 @@
+declare namespace sparkly {
+	interface Options {
+		/**
+		Minimum range.
+		*/
+		readonly minimum?: number;
+
+		/**
+		Maximum range.
+		*/
+		readonly maximum?: number;
+
+		/**
+		Style for the sparklines.
+		*/
+		readonly style?: 'fire';
+	}
+}
+
+/**
+Generate sparklines `▁▂▃▅▂▇`.
+
+@param numbers - Numbers to create the sparkline from.
+
+@example
+```
+const sparkly = require('sparkly');
+
+sparkly([0, 3, 5, 8, 4, 3, 4, 10]);
+//=> '▁▃▄▇▄▃▄█'
+
+// Specifying anything other than finite numbers will cause holes
+sparkly([0, 3, 5, '', 4, 3, 4, 10]);
+//=> '▁▃▄ ▄▃▄█'
+
+// Specifying an object with minimum and maximum options will change the sparkline range
+sparkly([1, 2, 3, 4, 5], {minimum: 0, maximum: 10});
+//=> '▁▂▃▄▄'
+```
+*/
+declare function sparkly(
+	numbers: ReadonlyArray<number | ''>,
+	options?: sparkly.Options
+): string;
+
+export = sparkly;

index.js

@@ -9,11 +9,11 @@ module.exports = (numbers, options = {}) => {
 	let ticks = ['▁', '▂', '▃', '▄', '▅', '▆', '▇', '█'];
 	const color = [[5, 5, 4], [5, 5, 3], [5, 5, 0], [5, 4, 0], [5, 3, 0], [5, 2, 0], [5, 1, 0], [5, 0, 0]];
 	const finiteNumbers = numbers.filter(number => Number.isFinite(number));
-	const min = typeof options.min === 'number' ? options.min : Math.min(...finiteNumbers);
-	const max = typeof options.max === 'number' ? options.max : Math.max(...finiteNumbers);
+	const minimum = typeof options.minimum === 'number' ? options.minimum : Math.min(...finiteNumbers);
+	const maximum = typeof options.maximum === 'number' ? options.maximum : Math.max(...finiteNumbers);
 
 	// Use a high tick if data is constant and max is not equal to 0
-	if (min === max && max !== 0) {
+	if (minimum === maximum && maximum !== 0) {
 		ticks = [ticks[4]];
 	}
 
@@ -22,9 +22,9 @@ module.exports = (numbers, options = {}) => {
 			return ' ';
 		}
 
-		let tickIndex = Math.ceil((el / max) * ticks.length) - 1;
+		let tickIndex = Math.ceil((el / maximum) * ticks.length) - 1;
 
-		if (max === 0 || tickIndex < 0) {
+		if (maximum === 0 || tickIndex < 0) {
 			tickIndex = 0;
 		}
 

index.test-d.ts

@@ -0,0 +1,8 @@
+import {expectType} from 'tsd';
+import sparkly = require('.');
+
+expectType<string>(sparkly([0, 3, 5, 8, 4, 3, 4, 10]));
+expectType<string>(sparkly([0, 3, 5, '', 4, 3, 4, 10]));
+expectType<string>(sparkly([1, 2, 3, 4, 5], {minimum: 0}));
+expectType<string>(sparkly([1, 2, 3, 4, 5], {maximum: 10}));
+expectType<string>(sparkly([1, 2, 3, 4, 5, 6, 7, 8], {style: 'fire'}));

package.json

@@ -10,13 +10,14 @@
 		"url": "sindresorhus.com"
 	},
 	"engines": {
-		"node": ">=6"
+		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"spark",
@@ -31,10 +32,11 @@
 		"ascii"
 	],
 	"dependencies": {
-		"chalk": "^2.4.1"
+		"chalk": "^2.4.2"
 	},
 	"devDependencies": {
-		"ava": "*",
-		"xo": "*"
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -26,8 +26,8 @@ sparkly([0, 3, 5, 8, 4, 3, 4, 10]);
 sparkly([0, 3, 5, '', 4, 3, 4, 10]);
 //=> '▁▃▄ ▄▃▄█'
 
-// Specifying a min max object will change the sparkline range
-sparkly([1, 2, 3, 4, 5], {min: 0, max: 10});
+// Specifying an object with minimum and maximum options will change the sparkline range
+sparkly([1, 2, 3, 4, 5], {minimum: 0, maximum: 10});
 //=> '▁▂▃▄▄'
 
 // Specifying a style option will change the sparkline color
@@ -50,15 +50,15 @@ Numbers to create the sparkline from.
 
 #### options
 
-Type: `Object`
+Type: `object`
 
-##### min
+##### minimum
 
 Type: `number`
 
 Minimum range.
 
-##### max
+##### maximum
 
 Type: `number`
 

test.js

@@ -30,11 +30,11 @@ test('use the lowest tick if data is all 0', t => {
 	t.is(sparkly([0, 0, 0, 0, 0]), '▁▁▁▁▁');
 });
 
-test('min and max arguments set graph range', t => {
-	t.is(sparkly([1], {min: 0, max: 1}), '█');
-	t.is(sparkly([1, 2, 3, 4, 5], {min: 0, max: 10}), '▁▂▃▄▄');
-	t.is(sparkly([10, 11, 12, 13], {min: 0}), '▇▇██');
-	t.is(sparkly([10, 20, 30, 40, 50], {max: 100}), '▁▂▃▄▄');
+test('minimum and maximum arguments set graph range', t => {
+	t.is(sparkly([1], {minimum: 0, maximum: 1}), '█');
+	t.is(sparkly([1, 2, 3, 4, 5], {minimum: 0, maximum: 10}), '▁▂▃▄▄');
+	t.is(sparkly([10, 11, 12, 13], {minimum: 0}), '▇▇██');
+	t.is(sparkly([10, 20, 30, 40, 50], {maximum: 100}), '▁▂▃▄▄');
 });
 
 test('colored graph', t => {