Using Sequelize.Instance with Sequelize v5 & Typescript

Question

In most guides, chats, tutorial etc... the recommended way to type Sequelize models is to use the following code:

export interface IUserInstance extends Sequelize.Instance<IUserAttributes>, IUserAttributes {
  prototype: {
    verifyPassword: (password: string) => boolean;
  };
}

the key part here is Sequelize.Instance<, in Sequelize v5+ you see the error:

Namespace '".../node_modules/sequelize/types/index"' has no exported member 'Instance'.

I have looked around but have not come across solution.

** Looking at this guide, section "Usage of sequelize.define" http://docs.sequelizejs.com/manual/typescript

There does NOT seem to be a clear way of working with associations in using define and typescript.

Any help / advice would be appreciated.

References:

Regards, Emir

Aston · Accepted Answer · 2019-06-25 11:22:46Z

2

I searched a lot for a solution to this problem, and got it working with the following:

import sequelizeInstance from '..';
import { Model, DataTypes } from 'sequelize';

const config = {
  tableName: 'User',
  sequelize: sequelizeInstance,
};

class User extends Model {
  id!: number;
  firstName!: string;
  lastName!: string;
  /* some other properties*/

  verifyPassword: (password: string) => boolean;

  public readonly createdAt!: Date;
  public readonly updatedAt!: Date;
}
User.init(
  {
    id: {
      primaryKey: true,
      type: DataTypes.INTEGER,
      autoIncrement: true,
    },
    firstName: {
      type: DataTypes.STRING,
    },
    lastName: {
      type: DataTypes.STRING,
    }
  },
  config,
);

User.prototype.verifyPassword = function(password: string) {
  /* code here ... */
};

export default User;

answered Jun 25, 2019 at 11:22

Aston

3,7321 gold badge23 silver badges18 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

eGlu Over a year ago

I am using Sequelize with Feathers.js, so I need to use the sequelize.define(... approach. The example given here: docs.sequelizejs.com/manual/typescript, shows your method and works well (I assume), when you are working directly with classes.

Laiso Over a year ago

@Aston Could you give the sequelizeInstance contents?

Aston Over a year ago

@Laiso It is basically new Sequelize(url, config) but here is my complete file I use gist.github.com/eshton/03ec6cf7b14b8e74843ccea7c5ff4815

Collectives™ on Stack Overflow

Using Sequelize.Instance with Sequelize v5 & Typescript

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related