chore(typescript): add more types (#514)

Co-authored-by: Steven Chim <[email protected]>

Author: chimurai

src/context-matcher.ts

@@ -1,17 +1,18 @@
+import type { Filter, Request } from './types';
 import * as isGlob from 'is-glob';
 import * as micromatch from 'micromatch';
 import * as url from 'url';
 import { ERRORS } from './errors';
 
-export function match(context, uri, req) {
+export function match(context: Filter, uri: string, req: Request): boolean {
   // single path
-  if (isStringPath(context)) {
-    return matchSingleStringPath(context, uri);
+  if (isStringPath(context as string)) {
+    return matchSingleStringPath(context as string, uri);
   }
 
   // single glob path
-  if (isGlobPath(context)) {
-    return matchSingleGlobPath(context, uri);
+  if (isGlobPath(context as string)) {
+    return matchSingleGlobPath(context as string[], uri);
   }
 
   // multi path
@@ -20,7 +21,7 @@ export function match(context, uri, req) {
       return matchMultiPath(context, uri);
     }
     if (context.every(isGlobPath)) {
-      return matchMultiGlobPath(context, uri);
+      return matchMultiGlobPath(context as string[], uri);
     }
 
     throw new Error(ERRORS.ERR_CONTEXT_MATCHER_INVALID_ARRAY);
@@ -40,18 +41,18 @@ export function match(context, uri, req) {
  * @param  {String} uri     'http://example.org/api/b/c/d.html'
  * @return {Boolean}
  */
-function matchSingleStringPath(context, uri) {
+function matchSingleStringPath(context: string, uri: string) {
   const pathname = getUrlPathName(uri);
   return pathname.indexOf(context) === 0;
 }
 
-function matchSingleGlobPath(pattern, uri) {
+function matchSingleGlobPath(pattern: string | string[], uri: string) {
   const pathname = getUrlPathName(uri);
   const matches = micromatch([pathname], pattern);
   return matches && matches.length > 0;
 }
 
-function matchMultiGlobPath(patternList, uri) {
+function matchMultiGlobPath(patternList: string | string[], uri: string) {
   return matchSingleGlobPath(patternList, uri);
 }
 
@@ -60,7 +61,7 @@ function matchMultiGlobPath(patternList, uri) {
  * @param  {String} uri     'http://example.org/api/b/c/d.html'
  * @return {Boolean}
  */
-function matchMultiPath(contextList, uri) {
+function matchMultiPath(contextList: string[], uri: string) {
   let isMultiPath = false;
 
   for (const context of contextList) {
@@ -79,14 +80,14 @@ function matchMultiPath(contextList, uri) {
  * @param  {String} uri from req.url
  * @return {String}     RFC 3986 path
  */
-function getUrlPathName(uri) {
+function getUrlPathName(uri: string) {
   return uri && url.parse(uri).pathname;
 }
 
-function isStringPath(context) {
+function isStringPath(context: string) {
   return typeof context === 'string' && !isGlob(context);
 }
 
-function isGlobPath(context) {
+function isGlobPath(context: string) {
   return isGlob(context);
 }

src/handlers.ts

@@ -1,9 +1,11 @@
 import type * as express from 'express';
+import type { Options } from './types';
+import type * as httpProxy from 'http-proxy';
 import camelcase = require('camelcase');
 import { getInstance } from './logger';
 const logger = getInstance();
 
-export function init(proxy, option) {
+export function init(proxy: httpProxy, option: Options): void {
   const handlers = getHandlers(option);
 
   for (const eventName of Object.keys(handlers)) {
@@ -13,7 +15,7 @@ export function init(proxy, option) {
   logger.debug('[HPM] Subscribed to http-proxy events:', Object.keys(handlers));
 }
 
-export function getHandlers(options) {
+export function getHandlers(options: Options) {
   // https://github.com/nodejitsu/node-http-proxy#listening-for-proxy-events
   const proxyEvents = ['error', 'proxyReq', 'proxyReqWs', 'proxyRes', 'open', 'close'];
   const handlers: any = {};

src/http-proxy-middleware.ts

@@ -1,13 +1,13 @@
-import * as https from 'https';
-import * as express from 'express';
+import type * as https from 'https';
+import type * as express from 'express';
+import type { Filter, Request, RequestHandler, Response, Options } from './types';
 import * as httpProxy from 'http-proxy';
 import { createConfig, Config } from './config-factory';
 import * as contextMatcher from './context-matcher';
 import * as handlers from './handlers';
 import { getArrow, getInstance } from './logger';
 import * as PathRewriter from './path-rewriter';
 import * as Router from './router';
-import { Filter, Request, RequestHandler, Response, Options } from './types';
 
 export class HttpProxyMiddleware {
   private logger = getInstance();
@@ -109,7 +109,7 @@ export class HttpProxyMiddleware {
    * @param  {Object} req     [description]
    * @return {Boolean}
    */
-  private shouldProxy = (context, req: Request) => {
+  private shouldProxy = (context, req: Request): boolean => {
     const path = req.originalUrl || req.url;
     return contextMatcher.match(context, path, req);
   };

test/unit/context-matcher.spec.ts

@@ -1,7 +1,8 @@
+import type { Request } from '../../src/types';
 import * as contextMatcher from '../../src/context-matcher';
 
 describe('Context Matching', () => {
-  const fakeReq = {};
+  const fakeReq = {} as Request;
 
   describe('String path matching', () => {
     let result;