如何让VSCode自动补全Sequelize自定义模型的属性与方法？

问题场景 #

当前使用自定义基类CustomModel继承Sequelize的Model，代码如下：

const { Model, DataTypes } = require('sequelize');

class CustomModel extends Model {
  static init(attributes, config) {
    return super.init(attributes, {
      ...config,
      timestamps: true,
      underscored: true,
      createdAt: 'created_at',
      updatedAt: 'updated_at',
    });
  }
}

class User extends CustomModel {
  ahoy() {
    const { email } = this.get();
    console.log(`Ahoy, ${email}`);
  }
}

User.init({
  id: {
    type: DataTypes.UUID,
    primaryKey: true,
    allowNull: false,
    defaultValue: DataTypes.UUIDV4,
  },
  email: {
    type: DataTypes.STRING,
    allowNull: false,
    unique: true
  },
}, myConfigHere);

遇到的问题：

• 通过User.findOne()获取的实例，user.email和user.ahoy()都无法触发VSCode自动补全
• 若直接让User继承Model，ahoy()能补全，但email依然无法补全

解决方法 #

1. 给自定义基类添加泛型JSDoc声明 #

修改CustomModel，通过JSDoc泛型让VSCode能推断子类的属性类型：

const { Model, DataTypes } = require('sequelize');

/**
 * @template TAttributes, TCreationAttributes
 * @extends Model<TAttributes, TCreationAttributes>
 */
class CustomModel extends Model {
  static init(attributes, config) {
    return super.init(attributes, {
      ...config,
      timestamps: true,
      underscored: true,
      createdAt: 'created_at',
      updatedAt: 'updated_at',
    });
  }
}

2. 给User类添加实例属性JSDoc #

明确声明User实例的属性，让VSCode识别：

/**
 * @typedef {Object} UserAttributes
 * @property {string} id
 * @property {string} email
 * @property {Date} created_at
 * @property {Date} updated_at
 */

/**
 * @extends CustomModel<UserAttributes, Omit<UserAttributes, 'id'|'created_at'|'updated_at'>>
 */
class User extends CustomModel {
  /** @type {string} */
  id;
  /** @type {string} */
  email;
  /** @type {Date} */
  created_at;
  /** @type {Date} */
  updated_at;

  ahoy() {
    console.log(`Ahoy, ${this.email}`);
  }
}

3. 安装Sequelize类型定义（可选） #

如果项目未安装类型依赖，执行以下命令补充类型支持：

npm install --save-dev @types/sequelize

效果验证 #

修改后，以下代码即可正常触发自动补全：

const user = await User.findOne({ where: { email: 'john@example.com' } });
user.email; // 自动补全生效
user.ahoy(); // 自动补全生效

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