How to create a typescript model with instance methods ?

Hello everybody,

In first, thank you for this amazing package.

I’m currently working on typescript projet an we want to use Sequelize as PG ORM, but we’re totally confused on the model creation (with instance method) since v4:

// db/index.ts)
import * as Sequelize from "sequelize";
import {config} from "../config";
import UserModel from "./models/users"

const sequelize = new Sequelize(config.database.schema, config.database.username, config.database.password, {
  host: config.database.host,
  dialect: "postgres",
});


// sequelize.sync({force: true}).then(() => console.log("Database synchronized."));
const Users = sequelize.import("./models/users");

Users.create({
  first_name: "Test",
  last_name: "TEST",
  email: "[e-mail]",
  password: "123456",
}).then((user) => {
  console.log("================> verifyPassword: " + user.verifyPassword("123456"));
});

export {sequelize};

// db/models/users.js
import * as Sequelize from "sequelize";
import {createHash} from "crypto";
import {v4} from "uuid";
import {config} from "../../config";

interface IUserModelAttribute {
  id?: string;
  email?: string;
  first_name?: string;
  last_name?: string;
  gender?: string;
  phone_number?: string;
  confirmation_token?: string;
  confirmation_date?: string;
  password?: string;
  status?: string;
  password_reset_token?: string;
  password_reset_date?: string;
  lang?: string;
  created_at?: string;
  updated_at?: string;
  deleted_at?: string;
}

interface IUserModelInstance extends Sequelize.Instance<IUserModelAttribute>, IUserModelAttribute {
  verifyPassword(password: string): boolean;
}

const UserModel = (sequelize: Sequelize.Sequelize, dataTypes: Sequelize.DataTypes) => {
  const User = sequelize.define<IUserModelInstance, IUserModelAttribute>(
    "users",
    {
      id: {
        type: dataTypes.INTEGER(11),
        primaryKey: true,
        autoIncrement: true,
      },
      email: {
        type: dataTypes.STRING(255),
        allowNull: false,
      },
      password: {
        type: dataTypes.STRING(255),
        allowNull: false,
      },
    },
    {
      tableName: "users",
      underscored: true,
      freezeTableName: true,
      paranoid: true,
    },
  );

  User.prototype.verifyPassword = function(password: string) {
    const hash = createHash(config.password.type)
      .update(password + config.password.salt)
      .digest("hex");
    return this.password === hash;
  };

  return User;
};

export {UserModel as default};

When I try to build, typescript say me

Property 'prototype' does not exist on type 'Model<IUserModelInstance, IUserModelAttribute>'.

Package version:

"sequelize": "^4.38.0",
"@types/sequelize": "^4.27.24",
"typescript": "^3.0.1"

Do you know how can I solve it ?

Thank you ! Regards,

[florianherrengt]

Any idea of how to do this now that Sequelize.Instance no longer exist in v5?

[sahatnicholas-gdp]

Done @papb , here it is https://github.com/sequelize/sequelize/issues/11215