Add typescript types

Closes #8

Author: lenovouser

.appveyor.yml

@@ -5,6 +5,9 @@ environment:
     - nodejs_version: '8'
     - nodejs_version: '6'
     - nodejs_version: '4'
+matrix:
+  allow_failures:
+    - nodejs_version: '4'
 platform:
   - x86
   - x64

.travis.yml

@@ -4,6 +4,9 @@ node_js:
   - '8'
   - '6'
   - '4'
+matrix:
+  allow_failures:
+  - node_js: '4'
 os:
   - linux
   - osx

index.d.ts

@@ -0,0 +1,52 @@
+// Type definitions for pidtree 0.3
+// Project: https://github.com/simonepri/pidtree
+// Definitions by: Silas Rech <https://github.com/lenovouser>
+// Definitions: https://github.com/simonepri/pidtree
+// TypeScript Version: 3.4
+
+declare namespace pidtree {
+  export interface Options {
+    /**
+    Include the provided PID in the list. Ignored if -1 is passed as PID.
+
+    @default false
+    */
+    root?: boolean;
+  }
+
+  export interface AdvancedResult {
+    /**
+    PID of the parent.
+    */
+    ppid: number,
+    /**
+    PID
+    */
+    pid: number,
+  }
+
+  export type Result = number;
+}
+
+/**
+Get the list of children and grandchildren pids of the given PID.
+
+@param pid The PID
+
+@example
+```
+import * as pidtree from 'pidtree';
+(async => {
+  const result = await pidtree(1, { advanced: true });
+  //=> [{ppid: 1, pid: 530}, {ppid: 1, pid: 42}, ..., {ppid: 1, pid: 41241}]
+})();
+```
+*/
+declare function pidtree(pid: string | number, callback: (error: Error | undefined, result: pidtree.Result[]) => void): void;
+declare function pidtree(pid: string | number, options: pidtree.Options, callback: (error: Error | undefined, result: pidtree.Result[]) => void): void;
+declare function pidtree(pid: string | number, options: pidtree.Options & { advanced: true }, callback: (error: Error | undefined, result: pidtree.AdvancedResult[]) => void): void;
+declare function pidtree(pid: string | number): Promise<pidtree.Result[]>;
+declare function pidtree(pid: string | number, options: pidtree.Options): Promise<pidtree.Result[]>;
+declare function pidtree(pid: string | number, options: pidtree.Options & { advanced: true }): Promise<pidtree.AdvancedResult[]>;
+
+export = pidtree;

index.test-d.ts

@@ -0,0 +1,9 @@
+import { expectType } from 'tsd';
+import * as pidtree from '.';
+
+(async () => {
+	expectType<number[]>(await pidtree(1));
+	expectType<number[]>(await pidtree('1'));
+	expectType<Array<{ ppid: number; pid: number }>>(await pidtree(1, { advanced: true }));
+	expectType<Array<{ ppid: number; pid: number }>>(await pidtree('1', { advanced: true }));
+})();

package.json

@@ -28,13 +28,15 @@
     "processes"
   ],
   "main": "index.js",
+  "types": "index.d.ts",
   "bin": {
     "pidtree": "./bin/pidtree.js"
   },
   "files": [
     "bin",
     "lib",
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "engines": {
     "node": ">=0.10"
@@ -44,7 +46,7 @@
     "update": "npm-check -u",
     "release": "np",
     "lint": "xo",
-    "test": "npm run lint&& nyc ava -m \"!*benchmark*\"",
+    "test": "npm run lint && nyc ava -m \"!*benchmark*\" && tsd",
     "bench": "ava -m \"*benchmark*\"",
     "coverage": "codecov"
   },
@@ -60,6 +62,7 @@
     "through": "^2.3.8",
     "time-span": "^3.1.0",
     "tree-kill": "^1.1.0",
+    "tsd": "^0.7.2",
     "xo": "*"
   },
   "ava": {