如何在独立文件编写Sequelize模型并获取智能提示？

下面提供两种实用方案，帮你在独立模型文件中获得sequelize对象的智能提示：

方案一：给纯JS模型添加JSDoc类型标注 #

如果你的项目还在使用纯JavaScript，通过JSDoc给参数标注类型就能让编辑器识别sequelize的结构，提供智能提示。

首先确保安装sequelize的类型定义（用于编辑器识别类型）：

npm install --save-dev @types/sequelize

然后修改你的category.js模型文件，添加JSDoc注释：

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

/**
 * @param {Sequelize} sequelize
 */
module.exports = (sequelize) => {
    const Category = sequelize.define(
        "category",
        {
            name: {
                type: DataTypes.STRING,
                allowNull: false,
            },
            color: {
                type: DataTypes.STRING,
                defaultValue: 'red'
            }
        }
    );
  
    return Category;
 };

添加@param {Sequelize}后，编辑器就能识别sequelize对象的所有方法和属性，比如define、query等都会有对应的提示。

方案二：改用TypeScript编写模型（推荐） #

如果项目可以迁移到TypeScript，Sequelize对TS的原生支持能提供更精准的类型提示，不仅是sequelize参数，模型的属性、实例方法也能获得完整提示。

示例category.ts代码：

import { DataTypes, Model, Sequelize } from 'sequelize';

// 定义模型的属性结构
interface CategoryAttributes {
  name: string;
  color?: string;
}

// 定义模型实例的类型（结合Model基类和属性结构）
interface CategoryInstance extends Model<CategoryAttributes>, CategoryAttributes {}

export default (sequelize: Sequelize) => {
  const Category = sequelize.define<CategoryInstance>(
    "category",
    {
      name: {
        type: DataTypes.STRING,
        allowNull: false,
      },
      color: {
        type: DataTypes.STRING,
        defaultValue: 'red'
      }
    }
  );

  return Category;
};

对应的主配置文件index.ts：

import { Sequelize } from 'sequelize';
import noteModel from './note';
import categoryModel from './category';

// 初始化sequelize实例
const sequelize = new Sequelize('数据库名', '用户名', '密码', {
  host: 'localhost',
  dialect: 'mysql' // 根据你的数据库类型调整
});

const db = {
  Sequelize,
  sequelize,
  notes: noteModel(sequelize),
  categories: categoryModel(sequelize)
};

export default db;

这种方式下，sequelize参数的类型被明确指定，编辑器会自动补全所有可用方法，同时模型的属性校验、实例操作也会有类型约束，减少出错概率。

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