[Feature] Support multiple types for path value

Author: jakehamilton

src/__tests__/index.ts

@@ -34,7 +34,7 @@ describe('HTTP', () => {
     });
 
     describe('#http', () => {
-        test('installs http components', () => {
+        test('installs http components where path is a string', () => {
             const http = new HTTP();
 
             const component: HTTPComponent = {
@@ -70,6 +70,81 @@ describe('HTTP', () => {
             expect(typeof instance.get.mock.calls[0][1]).toBe('function');
         });
 
+        test('installs http components where path is a regex', () => {
+            const http = new HTTP();
+
+            const component: HTTPComponent = {
+                is: 'component',
+                config: {
+                    type: 'http',
+                    http: {
+                        path: /\//,
+                        method: 'get',
+                    },
+                    dependencies: {
+                        plugins: [
+                            'http',
+                        ],
+                        services: [],
+                    },
+                },
+                http: jest.fn(),
+                plugins: [
+                    http,
+                ] as any,
+                services: [] as any,
+            };
+
+            expect(() => {
+                http.http(component);
+            }).not.toThrow();
+
+            expect(instance.get.mock.calls.length).toBe(1);
+            expect(instance.get.mock.calls[0][0]).toBe(
+                component.config.http.path,
+            );
+            expect(typeof instance.get.mock.calls[0][1]).toBe('function');
+        });
+
+        test('installs http components where path is an array', () => {
+            const http = new HTTP();
+
+            const component: HTTPComponent = {
+                is: 'component',
+                config: {
+                    type: 'http',
+                    http: {
+                        path: [
+                            '/',
+                            /x/,
+                        ],
+                        method: 'get',
+                    },
+                    dependencies: {
+                        plugins: [
+                            'http',
+                        ],
+                        services: [],
+                    },
+                },
+                http: jest.fn(),
+                plugins: [
+                    http,
+                ] as any,
+                services: [] as any,
+            };
+
+            expect(() => {
+                http.http(component);
+            }).not.toThrow();
+
+            expect(instance.get.mock.calls.length).toBe(1);
+            expect(instance.get.mock.calls[0][0]).toBe(
+                component.config.http.path,
+            );
+            expect(typeof instance.get.mock.calls[0][1]).toBe('function');
+        });
+
         test('does not accept invalid components', () => {
             const http = new HTTP();
 

src/index.ts

@@ -9,10 +9,12 @@ import {
 // tslint:disable-next-line:no-require-imports no-var-requires
 const express = require('express');
 
+export type Path = string | RegExp;
+
 export interface HTTPComponent extends ComponentInstanceWithDependencies {
     config: ComponentConfigWithDependencies & {
         http: {
-            path: string;
+            path: Path | Path[];
             method: string;
         };
     };
@@ -60,11 +62,15 @@ export class HTTP implements PluginUnit {
             );
         }
 
-        if (typeof component.config.http.path !== 'string') {
+        if (
+            typeof component.config.http.path !== 'string' &&
+            !Array.isArray(component.config.http.path) &&
+            typeof component.config.http.path !== 'object'
+        ) {
             throw new Error(
                 // prettier-ignore
                 // tslint:disable-next-line:max-line-length
-                `[HTTP] Expected \`component.config.http.path\` to be a string but got "${typeof component.config.http.path}"`,
+                `[HTTP] Expected \`component.config.http.path\` to be a string, array, or regex but got "${typeof component.config.http.path}"`,
             );
         }