Refactor TypeScript definition to CommonJS compatible export (#31)

index.d.ts

@@ -1,43 +1,64 @@
-export interface Options {
-	/**
-	 * Include other users' processes as well as your own.
-	 *
-	 * On Windows this has no effect and will always be the users' own processes.
-	 *
-	 * @default true
-	 */
-	readonly all?: boolean;
-}
+declare namespace psList {
+	interface Options {
+		/**
+		Include other users' processes as well as your own.
 
-export interface ProcessDescriptor {
-	readonly pid: number;
-	readonly name: string;
-	readonly ppid: number;
+		On Windows this has no effect and will always be the users' own processes.
 
-	/**
-	 * Not supported on Windows.
-	 */
-	readonly cmd?: string;
+		@default true
+		*/
+		readonly all?: boolean;
+	}
 
-	/**
-	 * Not supported on Windows.
-	 */
-	readonly cpu?: number;
+	interface ProcessDescriptor {
+		readonly pid: number;
+		readonly name: string;
+		readonly ppid: number;
 
-	/**
-	 * Not supported on Windows.
-	 */
-	readonly memory?: number;
+		/**
+		Not supported on Windows.
+		*/
+		readonly cmd?: string;
 
-	/**
-	 * Not supported on Windows.
-	 */
-	readonly uid?: number;
+		/**
+		Not supported on Windows.
+		*/
+		readonly cpu?: number;
+
+		/**
+		Not supported on Windows.
+		*/
+		readonly memory?: number;
+
+		/**
+		Not supported on Windows.
+		*/
+		readonly uid?: number;
+	}
 }
 
-/**
- * Get running processes.
- *
- * @returns List of running processes.
- */
-export default function psList(options?: Options): Promise<ProcessDescriptor[]>;
+declare const psList: {
+	/**
+	Get running processes.
+
+	@returns List of running processes.
+
+	@example
+	```
+	import psList = require('ps-list');
+
+	(async () => {
+		console.log(await psList());
+		//=> [{pid: 3213, name: 'node', cmd: 'node test.js', ppid: 1, uid: 501, cpu: 0.1, memory: 1.5}, …]
+	})();
+	```
+	*/
+	(options?: psList.Options): Promise<psList.ProcessDescriptor[]>;
+
+	// TODO: remove this in the next major version, refactor the whole definition to:
+	// declare function psList(options?: psList.Options): Promise<psList.ProcessDescriptor[]>;
+	// export = psList;
+	default: typeof psList;
+};
+
+export = psList;

index.js

@@ -59,4 +59,5 @@ const main = async (options = {}) => {
 };
 
 module.exports = process.platform === 'win32' ? windows : main;
+// TODO: remove this in the next major version
 module.exports.default = module.exports;

index.test-d.ts

@@ -1,5 +1,6 @@
-import {expectType} from 'tsd-check';
-import psList, {ProcessDescriptor} from '.';
+import {expectType} from 'tsd';
+import psList = require('.');
+import {ProcessDescriptor} from '.';
 
 const processes: ProcessDescriptor[] = await psList();
 psList({all: false});

package.json

@@ -13,7 +13,7 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -30,8 +30,8 @@
 		"tasklist"
 	],
 	"devDependencies": {
-		"ava": "^1.3.1",
-		"tsd-check": "^0.3.0",
+		"ava": "^1.4.1",
+		"tsd": "^0.7.1",
 		"xo": "^0.24.0"
 	}
 }