Add TypeScript definition (#2)

.gitattributes

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

.travis.yml

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

index.d.ts

@@ -0,0 +1,19 @@
+/**
+Get consecutively unique elements from an array.
+
+@returns A function that when called will return a random element that's never the same as the previous.
+
+@example
+```
+import uniqueRandomArray = require('unique-random-array');
+const random = uniqueRandomArray([1, 2, 3, 4]);
+
+console.log(random(), random(), random(), random());
+//=> 4 2 1 4
+```
+*/
+declare function uniqueRandomArray<ValueType>(
+	array: readonly ValueType[]
+): () => ValueType;
+
+export = uniqueRandomArray;

index.test-d.ts

@@ -0,0 +1,5 @@
+import {expectType} from 'tsd';
+import uniqueRandomArray = require('.');
+
+expectType<() => number>(uniqueRandomArray([1, 2, 3, 4]));
+expectType<() => string | number>(uniqueRandomArray(['1', 2, 3, 4]));

package.json

@@ -13,10 +13,11 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"unique",
@@ -36,7 +37,8 @@
 		"unique-random": "^2.0.0"
 	},
 	"devDependencies": {
-		"ava": "*",
-		"xo": "*"
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -25,13 +25,13 @@ console.log(random(), random(), random(), random());
 
 ## API
 
-### uniqueRandomArray(input)
+### uniqueRandomArray(array)
 
 Returns a function that when called will return a random element that's never the same as the previous.
 
-#### input
+#### array
 
-Type: `Array`
+Type: `Array<unknown>`
 
 
 ## Related

test.js

@@ -1,8 +1,8 @@
 import test from 'ava';
-import m from '.';
+import uniqueRandomArray from '.';
 
 test('main', t => {
-	const random = m([1, 2, 3, 4]);
+	const random = uniqueRandomArray([1, 2, 3, 4]);
 
 	let current;
 	let previous;