使用Typescript扩展Express Request对象

我试图添加一个属性来表达使用typescript从中间件请求对象。但是，我不知道如何向对象添加额外的属性。如果可能的话，我宁愿不用括号。

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

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

当前回答

这个答案将有利于那些依赖npm包ts-node的人。

我也在与扩展请求对象同样的问题作斗争，我在堆栈溢出中遵循了许多答案，并以遵循下面提到的策略结束。

我在以下目录中声明了express的扩展类型。$ {PROJECT_ROOT} / api / @types /快递/ index.d.ts

declare namespace Express {
  interface Request {
    decoded?: any;
  }
}

然后更新我的tsconfig。Json变成这样。

{
  "compilerOptions": {
     "typeRoots": ["api/@types", "node_modules/@types"]
      ...
  }
}

即使在执行上述步骤之后，visual studio也不再抱怨，但不幸的是，ts-node编译器仍然习惯抛出。

 Property 'decoded' does not exist on type 'Request'.

显然，ts-node无法定位请求对象的扩展类型定义。

最终，在花了几个小时后，我知道VS Code并没有抱怨，并且能够找到类型定义，这意味着ts-node编译器有问题。

正在更新包中的开始脚本。Json为我解决了这个问题。

"start": "ts-node --files api/index.ts",

——files参数在这里起着关键作用，确定自定义类型定义。

欲了解更多信息，请访问:https://github.com/TypeStrong/ts-node#help-my-types-are-missing

2020-05-23 12:28:14

其他回答

我用了回应。当地人反对储存新财产。下面是完整的代码

export function testmiddleware(req: Request, res: Response, next: NextFunction) {
    res.locals.user = 1;
    next();
}

// Simple Get
router.get('/', testmiddleware, async (req: Request, res: Response) => {
    console.log(res.locals.user);
    res.status(200).send({ message: `Success! ${res.locals.user}` });
});

2021-12-26 08:43:46

虽然这是一个非常古老的问题，但我最近偶然发现了这个问题。接受的答案工作得很好，但我需要添加一个自定义接口请求-一个接口，我一直在我的代码中使用，并不能很好地与接受的答案。从逻辑上讲，我尝试了这样做:

import ITenant from "../interfaces/ITenant";

declare namespace Express {
    export interface Request {
        tenant?: ITenant;
    }
}

但这不起作用，因为Typescript处理。d。Ts文件作为全局导入，当它们中有导入时，它们被视为普通模块。这就是为什么上面的代码不能在标准的typescript设置下工作。

这是我最后做的事情

// typings/common.d.ts

declare namespace Express {
    export interface Request {
        tenant?: import("../interfaces/ITenant").default;
    }
}

// interfaces/ITenant.ts

export interface ITenant {
    ...
}

2019-03-30 14:50:02

只需将属性添加到req。params对象。

req.params.foo = "bar"

2021-10-26 13:29:29

一个可能的解决方案是使用“double casting to any”

用你的属性定义一个接口

export interface MyRequest extends http.IncomingMessage {
     myProperty: string
}

2-双铸造

app.use((req: http.IncomingMessage, res: http.ServerResponse, next: (err?: Error) => void) => {
    const myReq: MyRequest = req as any as MyRequest
    myReq.myProperty = setProperty()
    next()
})

双铸造的优点是:

类型是可用的它不会污染现有的定义，而是扩展了它们，避免了混淆由于强制转换是显式的，它编译带有-noImplicitany标志的罚金

或者，还有一个快速(无类型)路由:

 req['myProperty'] = setProperty()

(不要用自己的属性编辑现有的定义文件——这是不可维护的。如果定义是错误的，打开一个拉请求)

EDIT

参见下面的评论，在这种情况下，简单的强制转换工作需要MyRequest

2016-05-22 19:00:16