使用Typescript扩展Express Request对象

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

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

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

当前回答

这就是我在使用Nestjs和Express时的工作方式。截至2020年11月。

创建一个文件:./@types/express- server -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",
    ]

2020-11-10 21:44:16

其他回答

我也有同样的问题，我是这样解决的:

// /src/types/types.express.d.ts
declare namespace Express {
    export interface Request {
        user: IUser
    }
}

但有一些条件是必须的!

添加到tsconfig。json配置

"paths": {
    "*": [
        "node_modules/*",
        "src/types/*"
    ]
},

在此之后，tsc将构建bundle，而ts-node则不会。

必须在编译器命令中添加——files

ts-node --files src/server.ts

2022-01-04 15:21:26

你想要创建一个自定义定义，并使用Typescript中称为声明合并的特性。这是常用的，例如在方法重写中。

创建一个custom.d.ts文件，并确保将其包含在tsconfig中。Json的文件节(如果有的话)。内容如下所示:

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)
})

2016-11-23 10:54:28

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

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

如果你尝试了所有的答案，仍然没有得到工作，这里有一个简单的hack

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

这将把req对象转换为任意类型，因此您可以添加任何想要的属性。请记住，这样做将失去req对象的类型安全性。

2021-04-26 05:50:26