Node.js+TypeScript扩展Express响应类型报错求助

问题详情 #

在项目的@types文件夹下创建了express.d.ts来扩展Express的Response接口，添加了自定义的Success和Error方法，代码如下：

export {}

declare global {
    namespace Express {
        // interface Request {
        //     auth: User;
        // }

        interface Response {
            Success(message: string, data?: any, responseCode?: number): void;
            Error(message: string, data?: any, responseCode?: number): void;
        }
    }
}

同时在startappmiddleware中间件中实现了这两个方法：

responseMiddleware(req: express.Request, res: express.Response, next: NextFunction){
    res.Success = (message: string, data?: any, resCode?: number) => {
        resCode = resCode ? resCode : 200;
        res.status(resCode)
            .json({
                success: true,
                message,
                data
            })
    };

    res.Error = (message: string, data?: any, resCode?: number) => {
        resCode = resCode ? resCode : 200;
        res.status(resCode)
            .json({
                success: true,
                message,
                data
            })
    };

    next();
}

调用res.Error()时出现类型报错，提示“属性‘Error’在类型‘Response<any, Record<string, any>>’上不存在”。

解决方案 #

1. 配置TypeScript识别自定义类型目录 #

打开tsconfig.json，确保typeRoots字段包含项目的@types目录，让TypeScript加载自定义的类型扩展：

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

若没有该字段，TypeScript默认只会读取node_modules/@types下的类型定义，自定义扩展不会生效。

2. 调整自定义类型文件的目录结构 #

将express.d.ts移动到@types/express/index.d.ts路径下，目录结构如下：

项目根目录
├─ @types
│  └─ express
│     └─ index.d.ts

这种结构符合TypeScript对包类型扩展的查找规则，能确保扩展的接口被正确合并到Express的原始类型中。

3. 重启TypeScript语言服务 #

编辑器的TypeScript服务可能未自动刷新类型文件，可重启编辑器或手动触发服务重启（比如VSCode中按Ctrl+Shift+P，选择「TypeScript: Restart TS Server」）。

4. 验证中间件类型注解 #

确保中间件中res的类型是express.Response，如果扩展生效，类型检查会自动识别Success和Error方法。若仍有问题，可临时使用类型断言（优先解决前面的配置问题）：

(res as any).Error = (message: string, data?: any, resCode?: number) => {
    // 实现代码
};

补充：你的Error方法返回的JSON中success: true不符合错误响应的语义，建议改为success: false。

内容的提问来源于stack exchange，提问作者Shahid khan