feat(typings): add index.d.ts

Author: waitingsong

index.d.ts

@@ -0,0 +1,22 @@
+import { SecureContextOptions } from 'tls';
+
+
+export interface ClusterOptions {
+  /** specify framework that can be absolute path or npm package */
+  framework?: string;
+  /** directory of application, default to `process.cwd()` */
+  baseDir?: string;
+  /** customized plugins, for unittest */
+  plugins?: object | null;
+  /** numbers of app workers, default to `os.cpus().length` */
+  workers?: number;
+  /** listening port, default to 7001(http) or 8443(https) */
+  port?: number;
+  /** Ref: https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options */
+  https?: SecureContextOptions;
+  [prop: string]: any;
+}
+
+
+
+export function startCluster(options: ClusterOptions, callback: (...args: any[]) => any): void;

package.json

@@ -3,6 +3,7 @@
   "version": "1.19.1",
   "description": "cluster manager for egg",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "autod": "autod",
     "lint": "eslint .",
@@ -14,6 +15,7 @@
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "lib"
   ],
   "repository": {