Merge pull request #38 from kahowane/typescript-description

initial typescript description

Author: jkyberneees

index.d.ts

@@ -0,0 +1,51 @@
+import * as restana from 'restana';
+
+declare namespace fastgateway {
+  type Type = 'http' | 'lambda';
+
+  type Method = 'GET' | 'DELETE' | 'PATCH' | 'POST' | 'PUT' | 'HEAD' | 'OPTIONS' | 'TRACE';
+
+  interface LambdaProxy {
+    region?: string;
+    target?: string;
+  }
+
+  interface Docs {
+    name: string;
+    endpoint: string;
+    type: string;
+  }
+
+  interface Route {
+    proxyType?: Type;
+    fastProxy?: {};
+    lambdaProxy?: LambdaProxy;
+    proxyHandler?: Function;
+    http2?: boolean;
+    pathRegex?: string;
+    timeout?: number;
+    prefix: string;
+    docs?: Docs;
+    prefixRewrite?: string;
+    target: string;
+    methods?: Method[];
+    middlewares?: Function[];
+    hooks?: {};
+  }
+
+  interface Options<P extends restana.Protocol> {
+    server?: restana.Server<P>;
+    restana?: {};
+    middlewares?: Function[];
+    pathRegex?: string;
+    timeout?: number;
+    targetOverride?: string;
+    routes: Route[];
+  }
+}
+
+declare function fastgateway<P extends restana.Protocol = restana.Protocol.HTTP>(
+  opts?: fastgateway.Options<P>
+): restana.Service<P>;
+
+export = fastgateway;

package.json

@@ -3,6 +3,7 @@
   "version": "2.3.7",
   "description": "A Node.js API Gateway for the masses!",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "nyc mocha test/*.test.js",
     "format": "npx standard --fix",