Add TypeScript definition (#28)

Author: BendingBender

index.d.ts

@@ -0,0 +1,43 @@
+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;
+}
+
+export interface ProcessDescriptor {
+	readonly pid: number;
+	readonly name: string;
+	readonly ppid: number;
+
+	/**
+	 * Not supported on Windows.
+	 */
+	readonly cmd?: string;
+
+	/**
+	 * 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[]>;

index.js

@@ -59,3 +59,4 @@ const main = async (options = {}) => {
 };
 
 module.exports = process.platform === 'win32' ? windows : main;
+module.exports.default = module.exports;

index.test-d.ts

@@ -0,0 +1,13 @@
+import {expectType} from 'tsd-check';
+import psList, {ProcessDescriptor} from '.';
+
+const processes: ProcessDescriptor[] = await psList();
+psList({all: false});
+
+expectType<number>(processes[0].pid);
+expectType<string>(processes[0].name);
+expectType<number>(processes[0].ppid);
+expectType<string | undefined>(processes[0].cmd);
+expectType<number | undefined>(processes[0].cpu);
+expectType<number | undefined>(processes[0].memory);
+expectType<number | undefined>(processes[0].uid);

package.json

@@ -13,10 +13,11 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd-check"
 	},
 	"files": [
 		"index.js",
+		"index.d.ts",
 		"fastlist.exe"
 	],
 	"keywords": [
@@ -29,7 +30,8 @@
 		"tasklist"
 	],
 	"devDependencies": {
-		"ava": "^0.25.0",
-		"xo": "^0.23.0"
+		"ava": "^1.3.1",
+		"tsd-check": "^0.3.0",
+		"xo": "^0.24.0"
 	}
 }

readme.md

@@ -41,7 +41,7 @@ Type: `Object`
 Type: `boolean`<br>
 Default: `true`
 
-Return other users' processes as well as your own.
+Include other users' processes as well as your own.
 
 On Windows this has no effect and will always be the users' own processes.