在TypeScript+Node.js Express中声明app.use及修复错误中间件类型报错

问题情况 #

我用Node.js + TypeScript + Express开发应用，编写了如下错误处理中间件：

app.use((error:any, req:Request, res:Response, next:NextFunction) => {
    res.status(500).json({message:error.message, stack:error.stack, path:req.path});
});

但触发了TypeScript类型错误，报错信息如下：

No overload matches this call.
  The last overload gave the following error.
    Argument of type '(error: any, req: Request, res: Response, next: NextFunction) => void' is not assignable to parameter of type 'PathParams'.ts(2769)
index.d.ts(163, 5): The last overload is declared here.

解决办法 #

1. 检查类型导入是否正确 #

确保从express包中正确导入所需类型：

import { Request, Response, NextFunction } from 'express';

如果类型导入路径错误或未导入，TypeScript无法识别该函数是错误处理中间件的签名，会错误匹配普通中间件的重载，抛出类型不兼容的错误。

2. 调整错误中间件的位置 #

Express要求错误处理中间件必须放在所有路由和普通中间件的后面。如果提前放置，TypeScript的类型推断会混乱，优先匹配只有3个参数的普通中间件重载，导致报错。

正确的代码顺序示例：

// 先加载普通中间件
app.use(express.json());
// 再加载路由
app.use('/api', userRouter);
// 最后加载错误处理中间件
app.use((error: any, req: Request, res: Response, next: NextFunction) => {
    res.status(500).json({message:error.message, stack:error.stack, path:req.path});
});

3. 显式指定错误处理中间件类型（兜底方案） #

如果前两种方法无效，可以直接显式指定函数类型为ErrorRequestHandler（从express导入），让TypeScript明确识别这是错误处理中间件：

import { ErrorRequestHandler } from 'express';

const errorHandler: ErrorRequestHandler = (error, req, res, next) => {
    res.status(500).json({message:error.message, stack:error.stack, path:req.path});
};

app.use(errorHandler);

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