插件窝 干货文章 我如何修复 TypeScript 设置问题:类型请求中不存在属性用户

我如何修复 TypeScript 设置问题:类型请求中不存在属性用户

typescript request express 问题 458    来源:    2024-10-20

问题
我一直在使用 typescript 和 express.js 开发 node.js 项目。有一次,我需要将一个用户对象附加到 express request 对象,但我遇到了这个 typescript 错误:

类型“request”上不存在属性“user”。

我很快意识到发生这种情况是因为 express 的默认 request 对象不包含用户属性,而 typescript 对此并不满意。

我的初步修复
为了解决这个问题,我扩展了 request 接口以添加用户属性。我是这样做的:

  1. 我在项目的 types 文件夹中创建了一个名为express.d.ts 的新文件:
// src/types/express.d.ts
import { user } from '@prisma/client'; // assuming user is a prisma model

declare global {
    namespace express {
        interface request {
            user?: user; // add user to the request interface
        }
    }
}
  1. 我更新了 tsconfig.json 以确保 typescript 选择这种新类型:
{
  "compilerOptions": {
    //extra options here
    "typeRoots": ["./node_modules/@types", "./src/types"] // Add the types folder
  }
}

此时,错误从我的代码编辑器中消失了,所以我认为我已经解决了问题。但是当我尝试运行该项目时,我在终端中遇到了另一个错误:

错误 ts2339:“请求”类型中不存在属性“用户”。

被困了好几天
我花了 3-4 天的时间来解决这个问题,尝试了网上能找到的所有方法。我完全陷入困境,不明白为什么它不起作用。

解决方案
最后,我发现了根本问题并通过以下步骤修复了它:

  1. 全局安装 typescript:我意识到我没有全局安装 typescript 编译器(tsc),所以我运行了这个命令:

npm install -g typescript

  1. 在监视模式下运行 typescript 编译器:我使用 --watch 标志在工作时自动重新编译我的 typescript 代码:
    tsc --观看

  2. 重新启动我的代码编辑器:我重新启动了我的编辑器(在我的例子中是 vs code)以确保所有内容都已正确加载。

  3. 运行项目:重新启动后,我再次运行该项目,它成功了!

结论
我原本以为是一个小问题,结果变成了几天的挫败感,但我终于成功了!如果您遇到类似的问题,typescript 无法识别 express 的 request 对象上的新属性,请记住:

正确扩展request接口。
确保 typescript 的编译器 (tsc) 已安装并正常运行。
希望这可以帮助其他像我一样陷入困境的人!