Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support ExpressOptions.expressInstance in createApp #547

Merged
merged 1 commit into from
Sep 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/cookbook/expressjs.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,13 @@ import * as express from 'express';

const expressApp = express();
expressApp.use(/* an Express middleware */)

const app = createApp(AppController, expressApp);
// OR
const app = createApp(AppController, {
expressInstance: expressApp
});

```

## Pre and Post Express Middlewares
Expand Down
9 changes: 9 additions & 0 deletions packages/core/src/express/create-app.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,15 @@ describe('createApp', () => {
strictEqual(actual, expected);
});

it('should use the optional options.expressInstance if one is given.', () => {
const expected = express();
const actual = createApp(class {}, {
expressInstance: expected
});

strictEqual(actual, expected);
});

it('should use the optional preMiddlewares if they are given.', () => {
class AppController {
@Get('/')
Expand Down
6 changes: 6 additions & 0 deletions packages/core/src/express/create-app.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ interface ExpressApplication extends express.Express {
}

interface ExpressOptions {
expressInstance?: ExpressApplication;
preMiddlewares?: (express.RequestHandler | express.ErrorRequestHandler)[];
postMiddlewares?: (express.RequestHandler | express.ErrorRequestHandler)[];
}
Expand All @@ -31,6 +32,8 @@ interface ExpressOptions {
* @param {Class} rootControllerClass - The root controller, usually called `AppController` and located in `src/app`.
* @param {(ExpressApplication|ExpressOptions)} [expressInstanceOrOptions] - Express instance or options containaining
* Express middlewares.
* @param {ExpressApplication} [expressInstanceOrOptions.expressInstance] - Express instance to be used as base for the
* returned application.
* @param {(express.RequestHandler | express.ErrorRequestHandler)[]} [expressInstanceOrOptions.preMiddlewares] Express
* middlewares to be executed before the controllers and hooks.
* @param {(express.RequestHandler | express.ErrorRequestHandler)[]} [expressInstanceOrOptions.postMiddlewares] Express
Expand All @@ -47,6 +50,9 @@ export function createApp(
}

if (expressInstanceOrOptions && typeof expressInstanceOrOptions === 'object') {
if (expressInstanceOrOptions.expressInstance) {
app = expressInstanceOrOptions.expressInstance;
}
for (const middleware of expressInstanceOrOptions.preMiddlewares || []) {
app.use(middleware);
}
Expand Down