From 91d90d348a5337d8f1023a2b12b45ce15e56d2ec Mon Sep 17 00:00:00 2001 From: Adrien Valcke Date: Sun, 28 Jun 2020 12:27:38 +0200 Subject: [PATCH] fix(index): remove default export and rename createMiddleware as building default export of this package makes CommonJS users need to access it via 'default' property, as there is no perfect way to handle this due to a TypeScript issue, remove default export and export createMiddleware so it is accessible via a property; rename createMiddleware to createMockMiddleware that I personnaly find more meaningful; update index spec and app testing https://github.com/aleksandryackovlev/openapi-mock-express-middleware/issues/9 --- src/index.spec.ts | 8 ++++---- src/index.ts | 4 +--- test/helpers/app.ts | 4 ++-- 3 files changed, 7 insertions(+), 9 deletions(-) diff --git a/src/index.spec.ts b/src/index.spec.ts index d409c5b..d1e06fa 100644 --- a/src/index.spec.ts +++ b/src/index.spec.ts @@ -2,11 +2,11 @@ import path from 'path'; import { Router } from 'express'; -import createMiddleware from './index'; +import { createMockMiddleware } from './index'; -describe('createMiddleware', () => { +describe('createMockMiddleware', () => { it('should return an instance of the express router', async () => { - const middleware = createMiddleware({ + const middleware = createMockMiddleware({ file: path.resolve(__dirname, '../test/fixtures/petstore.yaml'), }); @@ -15,7 +15,7 @@ describe('createMiddleware', () => { it('should throw an error if the given file does not exist', () => { try { - createMiddleware({ + createMockMiddleware({ file: path.resolve(__dirname, '../test/fixtures/petstore_not_exist.yaml'), }); throw new Error('exit'); diff --git a/src/index.ts b/src/index.ts index be3d44a..c9260b1 100644 --- a/src/index.ts +++ b/src/index.ts @@ -19,7 +19,7 @@ export interface MiddlewareOptions { options?: Partial; } -const createMiddleware = ({ +export const createMockMiddleware = ({ file, locale = 'en', options = {}, @@ -52,5 +52,3 @@ const createMiddleware = ({ return router; }; - -export default createMiddleware; diff --git a/test/helpers/app.ts b/test/helpers/app.ts index e205028..ba64808 100644 --- a/test/helpers/app.ts +++ b/test/helpers/app.ts @@ -2,11 +2,11 @@ import path from 'path'; import express from 'express'; -import createMiddleware from '../../src'; +import { createMockMiddleware } from '../../src'; const app = express(); -const middleware = createMiddleware({ +const middleware = createMockMiddleware({ file: path.resolve(__dirname, '../fixtures/petstore.yaml'), });