使用Typescript扩展Express Request对象

Question

我正在尝试添加一个属性来表达使用打字稿来自中间件的请求对象。但是，我不知道如何向对象添加额外的属性。如果可能的话，我宁愿不使用括号表示法。

我正在寻找一个解决方案，允许我写类似的东西（如果可能的话）：

app.use((req, res, next) => {
    req.property = setProperty(); 
    next();
});

Answer 1

对于较新版本的express，您需要扩充< code > express-serve-static-core 模块。

这是需要的，因为现在Express对象来自那里:https://github . com/DefinitelyTyped/DefinitelyTyped/blob/8 FB 0 e 959 C2 c 7529 b5 fa 4793 a 44 b 41 b 797 AE 671 b 9/types/Express/index . d . ts # L19

基本上，使用以下内容:

declare module 'express-serve-static-core' {
  interface Request {
    myField?: string
  }
  interface Response {
    myField?: string
  }
}

Answer 2

正如index.d.ts中的注释所建议的，您只需向全局Express命名空间声明任何新成员。例子：

declare global {
  namespace Express {
    interface Request {
      context: Context
    }
  }
}

import * as express from 'express';

export class Context {
  constructor(public someContextVariable) {
  }

  log(message: string) {
    console.log(this.someContextVariable, { message });
  }
}

declare global {
  namespace Express {
    interface Request {
      context: Context
    }
  }
}

const app = express();

app.use((req, res, next) => {
  req.context = new Context(req.url);
  next();
});

app.use((req, res, next) => {
  req.context.log('about to return')
  res.send('hello world world');
});

app.listen(3000, () => console.log('Example app listening on port 3000!'))

TypeScript Deep Dive中还涵盖了扩展全局命名空间。

Answer 3

您想创建一个自定义定义，并使用Typescript中称为声明合并的功能。这是常用的，例如在方法覆盖中。

创建一个文件< code>custom.d.ts，并确保将其包含在您的< code>tsconfig.json的< code > files -部分(如果有)中。内容可能如下所示:

declare namespace Express {
   export interface Request {
      tenant?: string
   }
}

这将允许您在代码中的任何点使用如下所示的内容：

router.use((req, res, next) => {
    req.tenant = 'tenant-X'
    next()
})

router.get('/whichTenant', (req, res) => {
    res.status(200).send('This is your tenant: '+req.tenant)
})