Why is sequelize Intellisense not working? - node.js

Question

How I can turn on Intellisense of node.js sequelize?
There is no model method:
What I can do?

Answer 1

i solved the problem related to sequelize intellisense by changing my general require syntax to
const {Sequelize}=require('sequelize');

Answer 2

What I found is that The previous versions of Intellisense is working, but not stable ( or 6.x) version.
So you can try this:
const {Sequelize} = require("sequelize");
or
const Sequelize = require("sequelize").Sequelize
Either of this following works.

Answer 3

follow this you will get Intellisense works properly.
/models/index.js
'use strict';
const Sequelize = require('sequelize');
const db = {};
/**
* #type {Sequelize.Sequelize}=con
*/
let con = new Sequelize(process.env.db_database, process.env.db_username, process.env.db_password, {
host: process.env.db_host,
dialect: "mysql"
});
(async function () {
try {
//ck connection
await con.authenticate()
//attach models
db.User = require('./User')
db.Test = require('./Test')
//associate
Object.keys(db).forEach(modelName => {
// if (db[modelName].associate) {
// db[modelName].associate(db);
// }
});
//sync
await con.sync({
logging: true,
force: false
})
} catch (e) {
console.log("error db con: ", e.name)
}
}())
db.con = con
module.exports = db;
/models/User.js
const { DataTypes } = require('sequelize');
const { con } = require('.');
const User = con.define("User", {
name: {
type: DataTypes.STRING,
allowNull: false
},
password: {
type: DataTypes.STRING,
allowNull: false
}
})
module.exports = User

Answer 4

according to:
https://github.com/sequelize/sequelize/issues/11103
const Sequelize = require('sequelize').Sequelize;

Answer 5

Here is an ES6 way to get IntelliSense working on your models (instead of just the instantiated class).
First - declare the sequelize instance which can be imported into many files.
// sequelize.js
const { Sequelize } = require('sequelize');
const sequelize = new Sequelize(...);
export default sequelize;
Second - follow the suggested setup by sequelize-cli. Note you need to reimport the model. I know this might seem annoying to continually add export declarations here but when you add this 1 line, you get all the benefit :)
// models/index.js
import Sequelize from 'sequelize';
import sequelize from '../config/sequelize';
export * from './user';
export * from './another-model';
// ... etc
let db = {};
const basename = path.basename(__filename);
fs.readdirSync(__dirname)
.filter((file) => file.indexOf('.') !== 0 && file !== basename && file.slice(-3) === '.js')
.forEach((file) => {
const module = require(path.join(__dirname, file));
Object.values(module).forEach((model) => {
db[model.name] = model;
});
});
Object.keys(db).forEach((modelName) => {
if (db[modelName].associate) {
db[modelName].associate(db);
}
});
export {
sequelize,
Sequelize,
migrations
};
Third - update model file like so.
Note: adding export keyword here and importing your base sequelize instance.
//models/MyModel.js
import Sequelize from 'sequelize';
import sequelize from '../sequelize';
const { DataTypes } = Sequelize;
export const User = sequelize.define('User', {
userId: DataTypes.UUID,
...
}, {});
User.associate = function (models) {
User.belongsTo(models.Admin, {
foreignKey: 'adminId',
});
};
Sharing this since I struggled to find a working example since if you follow the official docs, you don't get IntelliSense on the models.
example showing models on db object
example showing sequelize intellisense

Answer 6

The reason you are not getting the Intellisense might be because you are not importing your models through sequelize correctly. Assuming you are defining your models in separate files and then importing them. I would recommend doing the following:
Create an index.js file in your models folder
Use sequelize.import to import all your models and associate them as well.
Then export them all from index.js along with seqeulize db instance and Sequelize module.
Wherever in your project you need your models just require db from /models.
models/index.js
const sequelize = new Sequelize(DB_NAME, DB_USERNAME, DB_PASSWORD)
const db = {
Sequelize: Sequelize,
sequelize,
User: sequelize.import("./user"),
Message: sequelize.import("./message")
}
Object.keys(db).forEach(model => {
if ("associate" in db[model]) {
db[model].associate(db)
}
})
module.exports = db