Add TypeScript definition (#34)

index.d.ts

@@ -0,0 +1,53 @@
+declare namespace camelcaseKeys {
+	interface Options {
+		/**
+		Recurse nested objects and objects in arrays.
+
+		@default false
+		*/
+		readonly deep?: boolean;
+
+		/**
+		Exclude keys from being camelCased.
+
+		@default []
+		*/
+		readonly exclude?: Array<string | RegExp>;
+	}
+}
+
+/**
+Convert object keys to camelCase using [`camelcase`](https://github.com/sindresorhus/camelcase).
+
+@param input - Object or array of objects to camelCase.
+
+@example
+```
+import camelcaseKeys = require('camelcase-keys');
+
+// Convert an object
+camelcaseKeys({'foo-bar': true});
+//=> {fooBar: true}
+
+// Convert an array of objects
+camelcaseKeys([{'foo-bar': true}, {'bar-foo': false}]);
+//=> [{fooBar: true}, {barFoo: false}]
+
+camelcaseKeys({'foo-bar': true, nested: {unicorn_rainbow: true}}, {deep: true});
+//=> {fooBar: true, nested: {unicornRainbow: true}}
+
+import minimist = require('minimist');
+
+const argv = minimist(process.argv.slice(2));
+//=> {_: [], 'foo-bar': true}
+
+camelcaseKeys(argv);
+//=> {_: [], fooBar: true}
+```
+*/
+declare function camelcaseKeys(
+	input: unknown,
+	options?: camelcaseKeys.Options
+): {[key: string]: unknown};
+
+export = camelcaseKeys;

index.test-d.ts

@@ -0,0 +1,10 @@
+import {expectType} from 'tsd';
+import camelcaseKeys = require('.');
+
+expectType<{[key: string]: unknown}>(camelcaseKeys({'foo-bar': true}));
+expectType<{[key: string]: unknown}>(
+	camelcaseKeys({'foo-bar': true}, {deep: true})
+);
+expectType<{[key: string]: unknown}>(
+	camelcaseKeys({'foo-bar': true}, {exclude: ['foo', /bar/]})
+);

package.json

@@ -13,11 +13,12 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && ava",
+		"test": "xo && ava && tsd",
 		"bench": "matcha bench/bench.js"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"map",
@@ -46,14 +47,15 @@
 		"recursive"
 	],
 	"dependencies": {
-		"camelcase": "^5.0.0",
+		"camelcase": "^5.3.1",
 		"map-obj": "^3.0.0",
 		"quick-lru": "^1.0.0"
 	},
 	"devDependencies": {
-		"ava": "^0.25.0",
+		"ava": "^1.4.1",
 		"matcha": "^0.7.0",
-		"xo": "^0.23.0"
+		"tsd": "^0.7.2",
+		"xo": "^0.24.0"
 	},
 	"xo": {
 		"overrides": [

readme.md

@@ -54,7 +54,7 @@ Type: `Object`
 
 ##### exclude
 
-Type: `Array<string|RegExp>`<br>
+Type: `Array<string | RegExp>`<br>
 Default: `[]`
 
 Exclude keys from being camelCased.