Sequelize模型属性的VSCode IntelliSense自动补全实现咨询
Sequelize + VSCode 字段自动补全实现
纯JS写Sequelize的话,VSCode默认没有静态类型推导能力,无法识别模型定义的字段,因此默认不会补全where子句字段、模型实例属性。通过以下两种方案即可实现需求:
方案1:JSDoc 注解(不想改TS就用这个)
VSCode原生支持JSDoc类型推导,不需要装任何额外插件,只要给Model类加显式类型声明即可,修改后的完整示例:
const { Sequelize, DataTypes, Model } = require('sequelize'); const sequelize = new Sequelize('sqlite::memory'); // 先定义模型的所有字段类型 /** * @typedef {Object} UserModelFields * @property {string} firstName 名 * @property {string} lastName 姓 */ // 给User类绑定字段类型 /** * @extends {Model<UserModelFields, UserModelFields>} */ class User extends Model {} User.init( { firstName: { type: DataTypes.STRING, allowNull: false, }, lastName: { type: DataTypes.STRING, }, }, { sequelize, modelName: 'User', }, ); async function main() { await User.sync(); await User.create({ firstName: 'Ruby', lastName: 'Gem', }); // 这里输入where之后直接弹出firstName/lastName补全 const ruby = await User.findOne({ where: { firstName: 'Ruby', }, }); // 这里访问ruby的属性也会自动补全firstName/lastName const rubyFirstName = ruby.firstName; console.log(rubyFirstName); console.log(ruby); } main();
小提示:后续给模型加新字段,只要更新UserModelFields的@typedef定义即可,补全自动同步。
方案2:TypeScript 泛型(TS项目直接用)
如果项目已经是TS,直接给Model类传入字段接口,类型推导更严格,也能实现同样的补全效果:
import { Sequelize, DataTypes, Model, Optional } from 'sequelize'; const sequelize = new Sequelize('sqlite::memory'); // 定义返回的实例需要的字段 interface UserAttributes { firstName: string; lastName: string; } // 定义创建时可省略的字段(比如allowNull的字段) interface UserCreationAttributes extends Optional<UserAttributes, 'lastName'> {} // 给Model传入两个泛型 class User extends Model<UserAttributes, UserCreationAttributes> {} User.init( { firstName: { type: DataTypes.STRING, allowNull: false, }, lastName: { type: DataTypes.STRING, }, }, { sequelize, modelName: 'User', }, );
常见失效原因
- 漏传
Model的两个泛型参数:第一个是实例返回的字段类型,第二个是创建/更新的入参类型,漏传任何一个都会导致补全失效。 - 字段类型不匹配:JSDoc/TS里定义的类型要和
init里的DataTypes对应,比如DataTypes.INTEGER对应JS的number,不要写错类型。
内容的提问来源于stack exchange,提问作者dina
相关产品推荐
相关产品推荐

