我正在尝试添加一个属性以使用 typescript 从中间件表达请求对象。但是我不知道如何为对象添加额外的属性。如果可能的话，我宁愿不使用括号表示法。
我正在寻找一种解决方案，可以让我写出类似的东西（如果可能的话）：
app.use((req, res, next) => {
req.property = setProperty();
next();
});
【问题讨论】：
标签： node.js express typescript
您想要创建自定义定义，并使用 Typescript 中称为 Declaration Merging 的功能。这是常用的，例如在method-override。
创建一个文件custom.d.ts 并确保将其包含在您的tsconfig.json 的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)
})
【讨论】：
files 部分限制了 TypeScript 包含的文件集。如果您不指定files 或include，则默认包含所有*.d.ts，因此无需在此处添加自定义类型。
Property 'tenant 不存在于类型“请求”`如果我明确地将它包含在 tsconfig.json 中没有区别。 更新declare global@basarat 在他的 answear 作品中指出，但我必须先做import {Request} from 'express'。
Request 对象的正确方法（至少 4.x）
按照comments in the 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!'))
more at my GitBook 涵盖了扩展全局命名空间。
【讨论】：
对于较新版本的 express，您需要扩充 express-serve-static-core 模块。
这是必需的，因为现在 Express 对象来自那里：https://github.com/DefinitelyTyped/DefinitelyTyped/blob/8fb0e959c2c7529b5fa4793a44b41b797ae671b9/types/express/index.d.ts#L19
基本上，使用以下内容：
declare module 'express-serve-static-core' {
interface Request {
myField?: string
}
interface Response {
myField?: string
}
}
【讨论】：
'express' 模块却没有。谢谢！
import {Express} from "express-serve-static-core";
export {}，它也可以使用。
express.d.ts，否则编译器会尝试将其合并到快速类型中，从而导致错误。跨度>
尝试了 8 个左右的答案并没有成功。我终于设法让它与 jd291 指向 3mards repo 的评论一起工作。
在名为types/express/index.d.ts 的基础中创建一个文件。并在其中写道：
declare namespace Express {
interface Request {
yourProperty: <YourType>;
}
}
并将其包含在tsconfig.json 中：
{
"compilerOptions": {
"typeRoots": ["./types"]
}
}
那么yourProperty 应该可以在每个请求下访问：
import express from 'express';
const app = express();
app.get('*', (req, res) => {
req.yourProperty =
});
【讨论】：
declare global {} 中，这样就可以了。
接受的答案（与其他人一样）对我不起作用，但
declare module 'express' {
interface Request {
myProperty: string;
}
}
做到了。希望对某人有所帮助。
【讨论】：
*.d.ts 文件并将您的类型存储在常规 *.ts 文件中，那就太好了。
custom-declarations.d.ts 文件放在 TypeScript 的项目根目录中。
import { Request as IRequest } from 'express/index'; 和 interface Request extends IRequest。还必须添加 typeRoot
所提供的解决方案都不适合我。我最终只是简单地扩展了 Request 接口：
import {Request} from 'express';
export interface RequestCustom extends Request
{
property: string;
}
然后使用它：
import {NextFunction, Response} from 'express';
import {RequestCustom} from 'RequestCustom';
someMiddleware(req: RequestCustom, res: Response, next: NextFunction): void
{
req.property = '';
}
编辑：根据您的 tsconfig，您可能需要这样做：
someMiddleware(expressRequest: Request, res: Response, next: NextFunction): void
{
const req = expressRequest as RequestCustom;
req.property = '';
}
【讨论】：
interface CustomResponse extends Response { customProperty: string}，我称之为someMiddleware(res: CustomResponse)，它工作正常，可以访问Response 和新定义的接口上存在的属性。
Req 没有被类型“修改”。它始终是同一个对象，接口声明只允许您以类型安全的方式向对象添加其他属性。
所有这些响应似乎都是错误的或以某种方式过时。
这在 2020 年 5 月对我有用：
在${PROJECT_ROOT}/@types/express/index.d.ts:
import * as express from "express"
declare global {
namespace Express {
interface Request {
my_custom_property: TheCustomType
}
}
}
在tsconfig.json 中，添加/合并属性使得：
"typeRoots": [ "@types" ]
干杯。
【讨论】：
Property 'user' does not exist on type 'Request'.
这实际上并没有直接回答这个问题，但我提供了一个替代方案。我一直在为同样的问题苦苦挣扎，并尝试了此页面上的几乎所有接口扩展解决方案，但都没有奏效。
这让我停下来思考：“我为什么要修改请求对象？”。
response.locals
Express 开发人员似乎认为用户可能想要添加自己的属性。这就是为什么有一个locals 对象。问题是，它不在 request 中，而是在 response 对象中。
response.locals 对象可以包含您可能想要的任何自定义属性，封装在请求-响应周期中，因此不会暴露给来自不同用户的其他请求。
需要存储用户 ID？只需设置response.locals.userId = '123'。无需为打字而苦恼。
它的缺点是您必须传递响应对象，但很可能您已经在这样做了。
https://expressjs.com/en/api.html#res.locals
另一个缺点是缺乏类型安全性。但是，您可以使用 Response 对象上的泛型类型来定义 body 和 locals 对象的结构：
Response<MyResponseBody, MyResponseLocals>
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/express/index.d.ts#L127
您不能真正保证 userId 属性确实存在。您可能需要在访问它之前进行检查，尤其是在对象的情况下。
使用上面的例子添加一个 userId，我们可以有这样的东西：
interface MyResponseLocals {
userId: string;
}
const userMiddleware = (
request: Request,
response: Response<MyResponseBody, MyResponseLocals>,
next: NextFunction
) => {
const userId: string = getUserId(request.cookies.myAuthTokenCookie);
// Will nag if you try to assign something else than a string here
response.locals.userId = userId;
next();
};
router.get(
'/path/to/somewhere',
userMiddleware,
(request: Request, response: Response<MyResponseBody, MyResponseLocals>) => {
// userId will have string type instead of any
const { userId } = response.locals;
// You might want to check that it's actually there
if (!userId) {
throw Error('No userId!');
}
// Do more stuff
}
);
【讨论】：
response.locals 仍然没有类型。其中存储的任何值都是any。
虽然这是一个非常古老的问题，但我最近偶然发现了这个问题。接受的答案工作正常，但我需要向Request 添加一个自定义接口——我在代码中一直使用的接口，但没有与接受的答案一起工作得很好。从逻辑上讲，我试过这个：
import ITenant from "../interfaces/ITenant";
declare namespace Express {
export interface Request {
tenant?: ITenant;
}
}
但这不起作用，因为 Typescript 将 .d.ts 文件视为全局导入，并且当它们具有导入时，它们被视为普通模块。这就是为什么上面的代码在标准打字稿设置上不起作用的原因。
这就是我最终做的事情
// typings/common.d.ts
declare namespace Express {
export interface Request {
tenant?: import("../interfaces/ITenant").default;
}
}
// interfaces/ITenant.ts
export interface ITenant {
...
}
【讨论】：
.d.ts、tsconfig.json 和使用实例吗？另外，您使用的是什么版本的打字稿，因为仅从 TS 2.9 开始支持在全局模块中导入？这可能会有所帮助。
... "include": [ "src/**/*" ] ... 对我有用，但 "include": ["./src/", "./src/Types/*.d.ts"], 没有。我还没有深入了解这一点
在 express 4.17.1 中，https://stackoverflow.com/a/55718334/9321986 和 https://stackoverflow.com/a/58788706/9321986 的组合起作用了：
在types/express/index.d.ts:
declare module 'express-serve-static-core' {
interface Request {
task?: Task
}
}
在tsconfig.json:
{
"compilerOptions": {
"typeRoots": ["./types"]
}
}
【讨论】：
在 TypeScript 中，接口是开放式的。这意味着您可以从任何地方通过重新定义它们来向它们添加属性。
考虑到您正在使用这个express.d.ts 文件，您应该能够重新定义Request 接口以添加额外的字段。
interface Request {
property: string;
}
那么在你的中间件函数中，req 参数也应该有这个属性。您应该能够在不更改代码的情况下使用它。
【讨论】：
app.ts 中说 Request.user = {}; userController.ts 是如何知道它的？
express.Handler 类型（而不是手动指定 (req: express.Request, res: express.Response, next: express.NextFunction) => any)），它似乎并没有引用相同的 Request，因为它抱怨我的财产不存在。
declare module "express"，我可以做到这一点，但如果我使用declare namespace Express，就不行。我宁愿使用命名空间语法，但它对我不起作用。
如果您正在寻找与 express4 一起使用的解决方案，这里是：
@types/express/index.d.ts: --------必须是/index.d.ts
declare namespace Express { // must be namespace, and not declare module "Express" {
export interface Request {
user: any;
}
}
tsconfig.json：
{
"compilerOptions": {
"module": "commonjs",
"target": "es2016",
"typeRoots" : [
"@types", // custom merged types must be first in a list
"node_modules/@types",
]
}
}
来自https://github.com/TypeStrong/ts-node/issues/715#issuecomment-526757308的参考
【讨论】：
Cannot find module 'express' or its corresponding type declarations.
这对我使用 Nestjs 和 Express 时有用。截至 2020 年 11 月。
创建一个文件：./@types/express-serve-static-core/index.d.ts
注意：必须有上面的路径和文件名。这样Typescript声明合并才会起作用。
import { UserModel } from "../../src/user/user.model";
declare global{
namespace Express {
interface Request {
currentUser: UserModel
}
}
}
将此添加到您的 tsconfig.json
"typeRoots": [
"@types",
"./node_modules/@types",
]
【讨论】：
Express 没有global，否则它不会起作用。
declare global 仅当您在同一 *.d.ts 文件中导入任何模块时才需要
这个答案对那些依赖npm包ts-node的人会有所帮助。
我也在为扩展 request 对象而苦苦挣扎，我在堆栈溢出中遵循了很多答案，并以遵循下面提到的策略结束。
我在以下目录中声明了 express 的扩展类型。 ${PROJECT_ROOT}/api/@types/express/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 无法找到 request 对象的扩展类型定义。
最终在花费数小时后，我知道 VS Code 没有抱怨并且能够找到打字定义，这意味着 ts-node 编译器有问题。
在package.json 中更新开始script 为我修复了它。
"start": "ts-node --files api/index.ts",
--files 参数在这里起到了决定自定义类型定义的关键作用。
更多信息请访问：https://github.com/TypeStrong/ts-node#help-my-types-are-missing
【讨论】：
--files 标志是我无法让合并类型为我工作的缺失部分。
在 2020 年 5 月下旬尝试扩展 ExpressJS 的请求时，帮助那些只是在这里尝试其他东西的人对我有用。在让它发挥作用之前，我必须尝试十几件事：
"typeRoots": [
"./node_modules/@types",
"./your-custom-types-dir"
]
declare global {
namespace Express {
interface Request {
customBasicProperty: string,
customClassProperty: import("../path/to/CustomClass").default;
}
}
}
{
"restartable": "rs",
"ignore": [".git", "node_modules/**/node_modules"],
"verbose": true,
"exec": "ts-node --files",
"watch": ["src/"],
"env": {
"NODE_ENV": "development"
},
"ext": "js,json,ts"
}
【讨论】：
也许这个问题已经回答了，但我想分享一点，
现在有时像其他答案这样的界面可能有点过于严格，
但我们实际上可以维护所需的属性，然后通过创建一个类型为 string 且值类型为 any 的键来添加要添加的任何其他属性
import { Request, Response, NextFunction } from 'express'
interface IRequest extends Request {
[key: string]: any
}
app.use( (req: IRequest, res: Response, next: NextFunction) => {
req.property = setProperty();
next();
});
所以现在，我们还可以为这个对象添加任何我们想要的附加属性。
【讨论】：
如果您尝试了所有答案但仍然无法正常工作，这里有一个简单的技巧
app.use((req, res, next) => {
(req as any).property = setProperty();
next();
});
这会将req 对象转换为any，因此您可以添加任何您想要的属性。
请记住，这样做您将失去 req 对象的类型安全性。
【讨论】：
一种可能的解决方案是使用“双重强制转换”
1- 用你的属性定义一个接口
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()
（不要使用您自己的属性编辑现有定义文件 - 这是不可维护的。如果定义错误，请打开拉取请求）
编辑
见下面的评论，在这种情况下简单的铸造工作req as MyRequest
【讨论】：
MyRequest 扩展了http.IncomingMessage。如果不是这样，通过any 进行双重转换将是唯一的选择
Request 并将所有可能的属性放在上面。
在带有节点 12.19.0 和 express 4 的 mac 上，使用 Passport 进行身份验证，我需要扩展我的 Session 对象
与上述类似，但略有不同：
import { Request } from "express";
declare global {
namespace Express {
export interface Session {
passport: any;
participantIds: any;
uniqueId: string;
}
export interface Request {
session: Session;
}
}
}
export interface Context {
req: Request;
user?: any;
}```
【讨论】：
对我有用的简单解决方案是创建一个扩展 express Request 的新自定义接口。 这个接口应该包含你所有的自定义 req 属性作为可选的。 将此接口设置为中间件req的类型。
// ICustomRequset.ts
import { Request } from "express"
export default interface ICustomRequset extends Request {
email?: string;
roles?: Array<string>;
}
// AuthMiddleware.ts
...
export default async function (
req: ICustomRequset,
res: Response,
next: NextFunction
) {
try {
// jwt code
req.email=jwt.email
req.roles=jwt.roles
next()
}catch(err){}
【讨论】：
No overload matches this call
这个答案可能已经很晚了，但无论如何我是这样解决的：
tsconfig 文件中（这可能是一个全新的线程）express 的目录
express 目录中创建一个文件并将其命名为index.d.ts（必须完全一样）declare module 'express' {
export interface Request {
property?: string;
}
}
【讨论】：
我使用response.locals 对象来存储新属性。这是完整的代码
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}` });
});
【讨论】：
我也有同样的问题，可以这样解决：
// /src/types/types.express.d.ts
declare namespace Express {
export interface Request {
user: IUser
}
}
但需要一些条件！
tsconfig.json配置"paths": {
"*": [
"node_modules/*",
"src/types/*"
]
},
在此之后 tsc 将构建捆绑包，但 ts-node 不会。
--files 添加到编译器命令中ts-node --files src/server.ts
【讨论】：
这对我有用：
declare namespace e {
export interface Request extends express.Request {
user:IUserReference,
[name:string]:any;
}
export interface Response extends express.Response {
[name:string]:any;
}
}
export type AsyncRequestHandler = (req:e.Request, res:e.Response, logger?:Logger) => Promise<any>|Promise<void>|void;
export type AsyncHandlerWrapper = (req:e.Request, res:e.Response) => Promise<void>;
我在代码中使用了它，例如以这种方式导出具有此类签名的函数：
app.post('some/api/route', asyncHandlers(async (req, res) => {
return await serviceObject.someMethod(req.user, {
param1: req.body.param1,
paramN: req.body.paramN,
///....
});
}));
【讨论】：
只需将属性添加到 req.params 对象。
req.params.foo = "bar"
【讨论】：