Merge pull request #111 from maxmellen/strict-ts

Improve Type Declarations

Author: jeremydaly

index.d.ts

@@ -27,7 +27,7 @@ export declare interface FileOptions {
   maxAge?: number;
   root?: string;
   lastModified?: boolean | string;
-  headers?: {};
+  headers?: { [key: string]: string };
   cacheControl?: boolean | string;
   private?: boolean;
 }
@@ -36,10 +36,10 @@ export declare interface App {
   [namespace: string]: HandlerFunction;
 }
 
-export declare type Middleware = (req: Request, res: Response, next: Middleware) => void;
+export declare type Middleware = (req: Request, res: Response, next: () => void) => void;
 export declare type ErrorHandlingMiddleware = (error: Error, req: Request, res: Response, next: ErrorHandlingMiddleware) => void;
 export declare type ErrorCallback = (error?: Error) => void;
-export declare type HandlerFunction = (req?: Request, res?: Response, next?: NextFunction) => void | {} | Promise<{}>;
+export declare type HandlerFunction = (req: Request, res: Response, next?: NextFunction) => void | any | Promise<any>;
 export declare type LoggerFunction = (message: string) => void;
 export declare type NextFunction = () => void;
 export declare type TimestampFunction = () => string;
@@ -80,7 +80,7 @@ export declare interface LoggerOptions {
     rules?: SamplingOptions[];
   };
   serializers?: {
-    [name: string]: (req: Request) => {};
+    [name: string]: (prop: any) => any;
   };
   stack?: boolean;
 }
@@ -100,17 +100,21 @@ export declare class Request {
   app: API;
   version: string;
   id: string;
-  params: {};
+  params: {
+    [key: string]: string | undefined;
+  };
   method: string;
   path: string;
   query: {
-    [key: string]: string;
+    [key: string]: string | undefined;
   };
   headers: {
-    [key: string]: string;
+    [key: string]: string | undefined;
   };
-  rawHeaders?: {};
-  body: {} | string;
+  rawHeaders?: {
+    [key: string]: string | undefined;
+  };
+  body: any;
   rawBody: string;
   route: '';
   requestContext: APIGatewayEventRequestContext;
@@ -119,8 +123,8 @@ export declare class Request {
   stageVariables: { [name: string]: string } | null;
   auth: {
     [key: string]: any;
-    type: 'Bearer' | 'Basic' | 'OAuth' | 'Digest';
-    value: string;
+    type: 'Bearer' | 'Basic' | 'OAuth' | 'Digest' | 'none';
+    value: string | null;
   };
   cookies: {
     [key: string]: CookieOptions;
@@ -141,15 +145,18 @@ export declare class Request {
     error: LoggerFunction;
     fatal: LoggerFunction;
   };
+
+  [key: string]: any;
 }
 
 export declare class Response {
   status(code: number): this;
+  sendStatus(code: number): void;
   header(key: string, value: string): this;
   getHeader(key: string): string;
   hasHeader(key: string): boolean;
   removeHeader(key: string): this;
-  getLink(s3Path: string, expires?: number, callback?: (err, data) => void);
+  getLink(s3Path: string, expires?: number, callback?: ErrorCallback): Promise<string>;
   send(body: any): void;
   json(body: any): void;
   jsonp(body: any): void;
@@ -159,16 +166,16 @@ export declare class Response {
   redirect(status: number, path: string): void;
   redirect(path: string): void;
   cors(options: CorsOptions): this;
-  error(message: string, detail?: any);
-  error(code: number, message: string, detail?: any);
+  error(message: string, detail?: any): void;
+  error(code: number, message: string, detail?: any): void;
   cookie(name: string, value: string, options?: CookieOptions): this;
   clearCookie(name: string, options?: CookieOptions): this;
   etag(enable?: boolean): this;
   cache(age?: boolean | number | string, private?: boolean): this;
   modified(date: boolean | string | Date): this;
   attachment(fileName?: string): this;
-  download(file: string | Buffer, fileName?: string, options?: FileOptions, callback?: ErrorCallback);
-  sendFile(file: string | Buffer, options?: FileOptions, callback?: ErrorCallback);
+  download(file: string | Buffer, fileName?: string, options?: FileOptions, callback?: ErrorCallback): void;
+  sendFile(file: string | Buffer, options?: FileOptions, callback?: ErrorCallback): Promise<void>;
 }
 
 export declare class API {
@@ -197,10 +204,10 @@ export declare class API {
 
 
 
-  use(path: string, ...middleware: Middleware[]);
-  use(paths: string[], ...middleware: Middleware[]);
-  use (...middleware: Middleware[]);
-  use (...errorHandlingMiddleware: ErrorHandlingMiddleware[]);
+  use(path: string, ...middleware: Middleware[]): void;
+  use(paths: string[], ...middleware: Middleware[]): void;
+  use(...middleware: Middleware[]): void;
+  use(...errorHandlingMiddleware: ErrorHandlingMiddleware[]): void;
 
   finally(callback: FinallyFunction): void;