express:project local中间件扩展express。要求

Question

我正在开发一个基于express的节点服务器，它是用TypeScript 1.7编写的。我正在使用一些特定于项目的中间件，这些中间件扩展了现有的express请求或响应接口，但我还无法使其完全工作（tsc抱怨在req或res中找不到X）。我发现了关于这个问题的其他问题，但它们要么已经过时（我想），要么解决方案不直接。

我查看了现有中间件的定义，但如果不手动编写单独的d.ts文件并在typings/tsd中引用它们，我就无法使其工作。d、 ts.这是我的设置：

// middleware/foobar.ts
declare module Express {
  export interface Request {
    foobar?: string;
  }
}

/* my project-related middleware extends the request by `foobar` */
export = function(req: Express.Request, res, next) {
  req.foobar = 'FooBar';
  next();
};

// main.ts
import express = require('express');

var app = express();

app.use(require('./middleware/foobar'));

app.get('/foobar', (req, res) => {
  /* tsc: Property 'foobar' does not exist on type 'Request' */
  res.send(req.foobar);
});

扩展express的请求和响应接口的最佳实践是什么？如果可能的话，不需要编写单独的d.T，操作typings目录中的任何内容或使用///




Answer 1

我自己找到了一个解决方案，用这个例子作为参考。我的中间件需要包装在一个声明的模块中，所以中间件/foobar.ts看起来像这样：

declare module Express {
  export interface Request {
    foobar?: string;
  }
}

declare module 'foobar' {
  function foobar(req: Express.Request, res, next) {
    req.foobar = 'FooBar';
    next();
  }

  export = foobar;
}

如果您在中间件中使用类或其他导入的东西，那么就更加复杂了。在我的示例中，我的中间件使用我自己的“EntityManager”类，这是对数据库连接的抽象（对我来说是mysql）。我的中间件（对我来说是中间件/数据库。ts）现在看起来像这样：

declare module Express {
  import { Manager as EntityManager } from 'entity-manager';

  export interface Request {
    entityManager?: EntityManager;
  }
}

declare module 'database' {
  import * as mysql from 'mysql';
  import { Manager as EntityManager } from 'entity-manager';

  /* some middleware-related code */
  var pool = mysql.createPool(...);
  var entityManager = new EntityManager(pool);
  /* *** */


  /* the actual exported function */
  function database(req: Express.Request, res, next) {
    req.entityManager = entityManager;
    next();
  };

  export = database;
}

注意，我的EntityManager类被导入了两次，每个模块声明一次。仅仅在两个模块上导入它似乎不起作用。

更新

将实际代码放在声明的模块中（在我的例子中是“数据库”）不会在JS文件中产生任何输出。

在常规模块中包含该代码需要名称不使用撇号（例如，此处不允许使用连字符），并且也不会生成单函数导出代码。

将实际代码完全从模块中取出（因此只有带有扩展请求的声明的Express模块）可以生成正确的JS，但我的文本编辑器在req中再也找不到entityManager。

似乎我需要将打字（例如我自己的扩展名来表示请求）放入一个专用的d.ts文件中，在这个文件中没有实际的代码。