转译TypeScript NodeJS类后VSCode智能感知失效的解决方案
TypeScript转译后智能感知失效问题汇总
项目基础配置
- 转译脚本定义:
"scripts": { "build": "npm run clean && mkdir dist && tsc -p .", "clean": "rm -rf dist" }
- 预期智能感知效果:
- 引入类创建实例时,自动弹出构造函数的参数类型与必填提示
- 输入类实例的访问符
instanceObj.时,自动弹出类已定义的属性、方法提示
- 当前异常表现:转译流程可正常执行生成JS文件与.d.ts类型声明文件,但上述智能感知功能完全不触发
已生成的类型声明文件
Auth.d.ts
import { Document, Model } from "mongoose"; import { Request, Response } from "express"; interface Auth { SignUp(request: Request, response: Response): Response; Login(request: Request, response: Response): Reponse; } declare class AuthController implements Auth { userModel: Model<Document>; userSession: Document; hashRounds: number; mailTransporterUser: string; mailTransporterPass: string; passwordLength: number; constructor(userModel: Model<Document>, userSessions: Document, hashRounds: number, mailTransporterUser: string, mailTransporterPass: string, passwordLength: number); SignUp(request: Request, response: Response): Response<any>; Login(request: Request, response: Response): Response<any>; } export default AuthController; //# sourceMappingURL=Auth.d.ts.map
index.d.ts
import AuthController from "./Auth"; export default AuthController; //# sourceMappingURL=index.d.ts.map
对应原始TypeScript源码
interface Auth { SignUp(request: Request, response: Response): Response; Login(request: Request, response: Response): Response; } class AuthController implements Auth { userModel: Model<Document>; userSession: Document; hashRounds: number; mailTransporterUser: string; mailTransporterPass: string; passwordLength: number; constructor( userModel: Model<Document>, userSessions: Document, hashRounds: number, mailTransporterUser: string, mailTransporterPass: string, passwordLength: number ) { this.userModel = userModel; this.userSession = userSessions; this.hashRounds = hashRounds || 15; this.mailTransporterUser = mailTransporterUser; this.mailTransporterPass = mailTransporterPass; this.passwordLength = passwordLength || 8; } SignUp(request: Request, response: Response) { const form: Formidable.IncomingForm = new Formidable.IncomingForm(); try { form.parse(request, async (error, fields, files) => { if (error) { return response .status(500) .json({ msg: "Network Error: Failed to sign user up" }); } const { username, email, password, verifiedPassword } = fields; if (!username || !email || !password || !verifiedPassword) { return response.status(400).json({ msg: "All fields are required" }); } if (password.length < this.passwordLength) { return response.status(400).json({ msg: `Password has to be at least ${this.passwordLength} characters long`, }); } if (password !== verifiedPassword) { return response.status(400).json({ msg: "Password's do not match" }); } const isUserAlreadyExisting = await this.userModel.findOne({ email: email, }); if (!isUserAlreadyExisting) { return response .status(400) .json({ msg: "Account with this email already exist" }); } const salt: string = await Bcrypt.genSalt(this.hashRounds); const hashedPassword: string = await Bcrypt.hash(password, salt); const newUser = new this.userModel({ username: username, email: email, password: hashedPassword, }); const savedUser = await newUser.save(); }); return response.status(201).json({ msg: "Account successfully created" }); } catch (error) { console.error(error); return response .status(500) .json({ msg: "Network Error: Failed to signup user" }); } } }
项目tsconfig.json配置
{ "compilerOptions": { "target": "es5", "module": "commonjs", "declaration": true, "declarationMap": true, "sourceMap": true, "outDir": "dist", "strict": true, "esModuleInterop": true, "skipLibCheck": true, "forceConsistentCasingInFileNames": true }, "include": ["src"] }
已知故障点与修复步骤
- 类型声明文件拼写错误:Auth.d.ts中Login方法的返回值类型误写为
Reponse,缺失字母s,会直接触发TypeScript类型解析中断,导致智能感知失效 - 源码导出逻辑缺失:原始TypeScript源码定义完AuthController类后,未添加
export default AuthController语句,导致实际转译后的JS文件无默认导出,生成的类型声明文件结构与运行时代码不匹配 - 模块解析配置缺失:tsconfig.json中未显式开启
moduleResolution: "node"配置,TypeScript无法按照Node.js的目录规则定位dist目录下的.d.ts类型文件 - 包入口配置缺失:如果作为本地包引入或对外发布,需要在项目根目录的
package.json中补充两个字段,否则TypeScript无法定位到转译后的产物:"main": "./dist/index.js":指定JS运行代码入口"types": "./dist/index.d.ts":指定类型声明文件入口
- 引入路径校验:测试代码中引入AuthController的路径需正确指向dist目录下的入口文件,避免错误引入src下的未转译源码
内容的提问来源于stack exchange,提问作者Ntshembo Hlongwane
相关产品推荐
相关产品推荐

