Add TypeScript definition (#81)

Author: BendingBender

index.d.ts

@@ -0,0 +1,18 @@
+export interface Options {
+	/**
+	 * Enable globbing when matching file paths.
+	 *
+	 * @default true
+	 */
+	readonly glob?: boolean;
+}
+
+/**
+ * Move files and folders to the trash.
+ *
+ * @param input - Accepts paths and [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns).
+ */
+export default function trash(
+	input: string | string[],
+	options?: Options
+): Promise<void>;

index.js

@@ -7,7 +7,7 @@ const macos = require('./lib/macos');
 const linux = require('./lib/linux');
 const windows = require('./lib/windows');
 
-module.exports = (paths, options) => pTry(() => {
+const trash = (paths, options) => pTry(() => {
 	paths = (typeof paths === 'string' ? [paths] : paths).map(String);
 
 	options = {
@@ -51,3 +51,6 @@ module.exports = (paths, options) => pTry(() => {
 			return linux(paths);
 	}
 });
+
+module.exports = trash;
+module.exports.default = trash;

index.test-d.ts

@@ -0,0 +1,8 @@
+import {expectType} from 'tsd-check';
+import trash from '.';
+
+expectType<Promise<void>>(trash('/path/to/item1'));
+expectType<Promise<void>>(trash(['/path/to/item1', '/path/to/item2']));
+expectType<Promise<void>>(
+	trash(['/path/to/item1', '/path/to/item2'], {glob: false})
+);

package.json

@@ -13,10 +13,11 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd-check"
 	},
 	"files": [
 		"index.js",
+		"index.d.ts",
 		"lib"
 	],
 	"keywords": [
@@ -52,6 +53,7 @@
 	"devDependencies": {
 		"ava": "^1.0.0-rc.1",
 		"tempfile": "^2.0.0",
-		"xo": "^0.23.0"
+		"tsd-check": "^0.3.0",
+		"xo": "^0.24.0"
 	}
 }

test.js

@@ -51,6 +51,7 @@ test('no glob', async t => {
 	if (process.platform !== 'win32') {
 		fs.writeFileSync('fixture-noglob*.js', '');
 	}
+
 	fs.writeFileSync('fixture-noglob1.js', '');
 
 	await trash(['fixture-noglob*.js'], {glob: false});