Refactor TypeScript definition to CommonJS compatible export (#26)

sindresorhus · Apr 5, 2019 · 31ab056 · 31ab056
1 parent 7548b77
commit 31ab056
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 32 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -1,4 +1,4 @@
-declare namespace internalIp {
+interface v6 {
 	/**
 	 * @returns The IPv6 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
 	 *
@@ -7,19 +7,20 @@ declare namespace internalIp {
 	 * console.log(await internalIp.v6());
 	 * //=> 'fe80::1'
 	 */
-	export function v6(): Promise<string>;
-	export namespace v6 {
-		/**
-		 * @returns The IPv6 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
-		 *
-		 * @example
-		 *
-		 * console.log(internalIp.v6.sync());
-		 * //=> 'fe80::1'
-		 */
-		function sync(): string;
-	}
+	(): Promise<string>;
 
+	/**
+	 * @returns The IPv6 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
+	 *
+	 * @example
+	 *
+	 * console.log(internalIp.v6.sync());
+	 * //=> 'fe80::1'
+	 */
+	sync(): string;
+}
+
+interface v4 {
 	/**
 	 * @returns The IPv4 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
 	 *
@@ -28,18 +29,25 @@ declare namespace internalIp {
 	 * console.log(await internalIp.v4())
 	 * //=> '10.0.0.79'
 	 */
-	export function v4(): Promise<string>;
-	export namespace v4 {
-		/**
-		 * @returns The IPv4 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
-		 *
-		 * @example
-		 *
-		 * console.log(internalIp.v4.sync())
-		 * //=> '10.0.0.79'
-		 */
-		function sync(): string;
-	}
+	(): Promise<string>;
+
+	/**
+	 * @returns The IPv4 address of the internet-facing interface, as determined from the default gateway. When the address cannot be determined for any reason, `null` will be returned.
+	 *
+	 * @example
+	 *
+	 * console.log(internalIp.v4.sync())
+	 * //=> '10.0.0.79'
+	 */
+	sync(): string;
 }
 
-export default internalIp;
+declare const internalIp: {
+	v6: v6;
+	v4: v4;
+
+	// TODO: Remove this for the next major release
+	default: typeof internalIp;
+};
+
+export = internalIp;
diff --git a/index.js b/index.js
@@ -47,4 +47,5 @@ internalIp.v6.sync = () => sync('v6');
 internalIp.v4.sync = () => sync('v4');
 
 module.exports = internalIp;
+// TODO: Remove this for the next major release
 module.exports.default = internalIp;
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -1,5 +1,5 @@
-import {expectType} from 'tsd-check';
-import internalIp from '.';
+import {expectType} from 'tsd';
+import internalIp = require('.');
 
 expectType<string>(await internalIp.v4());
 expectType<string>(await internalIp.v6());

diff --git a/package.json b/package.json
@@ -13,7 +13,7 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -32,12 +32,12 @@
 		"gateway"
 	],
 	"dependencies": {
-		"default-gateway": "^4.0.1",
+		"default-gateway": "^4.2.0",
 		"ipaddr.js": "^1.9.0"
 	},
 	"devDependencies": {
-		"ava": "^1.2.1",
-		"tsd-check": "^0.3.0",
+		"ava": "^1.4.1",
+		"tsd": "^0.7.2",
 		"xo": "^0.24.0"
 	}
 }