How to add an instance method in Sequelize model

Question

I would like to add an instance method to Sequelize User model with postgres. User model is defined as below:

const Sql = require('sequelize');
const db = require("../startup/db");

const User = db.define('user', {
    id: {type: Sql.INTEGER,
         primaryKey:true,
         min: 1},
    name: {type: Sql.STRING,
           allowNull: false,
           min: 2,
           max: 50
        },
    email: {type: Sql.STRING,
            isEmail: true},       
    encrypted_password: {type: Sql.STRING,
                         min: 8},
    createdAt: Sql.DATE,
    updatedAt: Sql.DATE
});

I am looking for something like this in model User:

User.instanceMethods.create(someMethod => function() {
   //method code here
   });

The instance method can be access like this:

let user = new User();
user.someMethod();

There is Instance for model in Sequelize but it was not for the instance method. What is the right way to add instance method in Sequelize model?

Ugo Giordano · Accepted Answer · 2021-03-23 21:55:46Z

10

const User = db.define('user', {
    id: {type: Sql.INTEGER,
         primaryKey:true,
         min: 1},
    name: {type: Sql.STRING,
           allowNull: false,
           min: 2,
           max: 50
        },
    email: {type: Sql.STRING,
            isEmail: true},       
    encrypted_password: {type: Sql.STRING, min: 8},
    createdAt: Sql.DATE,
    updatedAt: Sql.DATE
});


// This is an hook function
User.beforeSave((user, options) => {
   // Do something
});

// This is a class method
User.classMethod = function (params) {
    // Do something with params
}

// This is an instance method
User.prototype.instanceMethod = function (params) {
    // Do something with params
}

edited Mar 23, 2021 at 21:55

answered Oct 23, 2018 at 12:24

Ugo Giordano

4034 silver badges12 bronze badges

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

1 Comment

Reinier Garcia Over a year ago

This should be selected as the real answer of the question. And not the link posted by the owner of the question.

user938363 · Accepted Answer · 2018-10-22 21:54:32Z

-1

Here is the answer for the question. See reply by Mariano.

Cannot access Sequelize instance methods

Here is more reading: https://codewithhugo.com/using-es6-classes-for-sequelize-4-models/

edited Oct 22, 2018 at 21:54

answered Oct 22, 2018 at 21:41

user938363

10.3k42 gold badges160 silver badges331 bronze badges

1 Comment

Reinier Garcia Over a year ago

So the user user938363 posts a question. And then he adds a simple link as an "answer". And then he decides that his link is the proper answer, despite the fact that another user (Ugo Giordano) posted an actual answer with useful working code below. Uhmm, interesting!

Collectives™ on Stack Overflow

How to add an instance method in Sequelize model

2 Answers 2

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related