Refactor TypeScript definition to CommonJS compatible export (#14)

Author: BendingBender

index.d.ts

@@ -1,39 +1,69 @@
 /// <reference types="node"/>
 import * as fs from 'fs';
 
-export interface Options {
+declare namespace makeDir {
+	interface Options {
+		/**
+		Directory [permissions](https://x-team.com/blog/file-system-permissions-umask-node-js/).
+
+		@default 0o777 & (~process.umask())
+		*/
+		readonly mode?: number;
+
+		/**
+		Use a custom `fs` implementation. For example [`graceful-fs`](https://github.com/isaacs/node-graceful-fs).
+
+		Using a custom `fs` implementation will block the use of the native `recursive` option if `fs.mkdir` or `fs.mkdirSync` is not the native function.
+
+		@default require('fs')
+		*/
+		readonly fs?: typeof fs;
+	}
+}
+
+declare const makeDir: {
 	/**
-	 * Directory [permissions](https://x-team.com/blog/file-system-permissions-umask-node-js/).
-	 *
-	 * @default 0o777 & (~process.umask())
-	 */
-	readonly mode?: number;
+	Make a directory and its parents if needed - Think `mkdir -p`.
+
+	@param path - Directory to create.
+	@returns The path to the created directory.
+
+	@example
+	```
+	import makeDir = require('make-dir');
+
+	(async () => {
+		const path = await makeDir('unicorn/rainbow/cake');
+
+		console.log(path);
+		//=> '/Users/sindresorhus/fun/unicorn/rainbow/cake'
+
+		// Multiple directories:
+		const paths = await Promise.all([
+			makeDir('unicorn/rainbow'),
+			makeDir('foo/bar')
+		]);
+
+		console.log(paths);
+		// [
+		// 	'/Users/sindresorhus/fun/unicorn/rainbow',
+		// 	'/Users/sindresorhus/fun/foo/bar'
+		// ]
+	})();
+	```
+	*/
+	(path: string, options?: makeDir.Options): Promise<string>;
 
 	/**
-	 * Use a custom `fs` implementation. For example [`graceful-fs`](https://github.com/isaacs/node-graceful-fs).
-	 *
-	 * Using a custom `fs` implementation will block the use of the native `recursive` option if `fs.mkdir` or `fs.mkdirSync` is not the native function.
-	 *
-	 * @default require('fs')
-	 */
-	readonly fs?: typeof fs;
-}
+	Synchronously make a directory and its parents if needed - Think `mkdir -p`.
+
+	@param path - Directory to create.
+	@returns The path to the created directory.
+	*/
+	sync(path: string, options?: makeDir.Options): string;
+
+	// TODO: Remove this for the next major release
+	default: typeof makeDir;
+};
 
-/**
- * Make a directory and its parents if needed - Think `mkdir -p`.
- *
- * @param path - Directory to create.
- * @returns A `Promise` for the path to the created directory.
- */
-export default function makeDir(
-	path: string,
-	options?: Options
-): Promise<string>;
-
-/**
- * Synchronously make a directory and its parents if needed - Think `mkdir -p`.
- *
- * @param path - Directory to create.
- * @returns The path to the created directory.
- */
-export function sync(path: string, options?: Options): string;
+export = makeDir;

index.js

@@ -85,6 +85,7 @@ const makeDir = (input, options) => Promise.resolve().then(() => {
 });
 
 module.exports = makeDir;
+// TODO: Remove this for the next major release
 module.exports.default = makeDir;
 
 module.exports.sync = (input, options) => {

index.test-d.ts

@@ -1,5 +1,6 @@
-import {expectType} from 'tsd-check';
-import makeDir, {sync as makeDirSync} from '.';
+import {expectType} from 'tsd';
+import makeDir = require('.');
+import {sync as makeDirSync} from '.';
 import * as fs from 'fs';
 import * as gfs from 'graceful-fs';
 

package.json

@@ -13,7 +13,7 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && nyc ava && tsd-check"
+		"test": "xo && nyc ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -46,14 +46,14 @@
 	},
 	"devDependencies": {
 		"@types/graceful-fs": "^4.1.3",
-		"@types/node": "^11.10.4",
-		"ava": "^1.2.0",
-		"codecov": "^3.0.0",
-		"graceful-fs": "^4.1.11",
-		"nyc": "^13.1.0",
+		"@types/node": "^11.12.2",
+		"ava": "^1.4.0",
+		"codecov": "^3.2.0",
+		"graceful-fs": "^4.1.15",
+		"nyc": "^13.3.0",
 		"path-type": "^3.0.0",
 		"tempy": "^0.2.1",
-		"tsd-check": "^0.3.0",
+		"tsd": "^0.7.1",
 		"xo": "^0.24.0"
 	}
 }