Refactor TypeScript definition to CommonJS compatible export (#26)

index.d.ts

@@ -1,9 +1,27 @@
-/**
- * Copy text to the clipboard.
- *
- * Must be called in response to a user gesture event, like `click` or `keyup`.
- *
- * @param text - The text to copy to clipboard.
- * @returns Whether it succeeded to copy the text.
- */
-export default function copyTextToClipboard(text: string): boolean;
+declare const copyTextToClipboard: {
+	/**
+	Copy text to the clipboard.
+
+	Must be called in response to a user gesture event, like `click` or `keyup`.
+
+	@param text - The text to copy to clipboard.
+	@returns Whether it succeeded to copy the text.
+
+	@example
+	```
+	import copy = require('copy-text-to-clipboard');
+
+	button.addEventListener('click', () => {
+		copy('🦄🌈');
+	});
+	```
+	*/
+	(text: string): boolean;
+
+	// TODO: Remove this for the next major release, refactor the whole definition to:
+	// declare function copyTextToClipboard(text: string): boolean;
+	// export = copyTextToClipboard;
+	default: typeof copyTextToClipboard;
+};
+
+export = copyTextToClipboard;

index.js

@@ -42,4 +42,5 @@ const copyTextToClipboard = input => {
 };
 
 module.exports = copyTextToClipboard;
+// TODO: Remove this for the next major release
 module.exports.default = copyTextToClipboard;

index.test-d.ts

@@ -1,4 +1,4 @@
-import {expectType} from 'tsd-check';
-import copyTextToClipboard from '.';
+import {expectType} from 'tsd';
+import copyTextToClipboard = require('.');
 
 expectType<boolean>(copyTextToClipboard('🦄🌈'));

package.json

@@ -13,7 +13,7 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && tsd-check"
+		"test": "xo && tsd"
 	},
 	"files": [
 		"index.js",
@@ -28,7 +28,7 @@
 		"modern"
 	],
 	"devDependencies": {
-		"tsd-check": "^0.3.0",
+		"tsd": "^0.7.2",
 		"xo": "^0.24.0"
 	},
 	"xo": {