npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

sequelize-bundler

v1.0.0

Published

Initialize and bundle all your Sequelize models into a single models object

Downloads

3

Readme

Sequelize Bundler - Models Management Made Easy

Build Status Coverage Status Maintainability License

This utility allows you to select Sequelize models through a glob, import them through the Sequelize import method, run associations after all of them are imported (so import order does not matter) and then retrieve all of them through a single variable.

Here's how you do it:

const getBundledSequelizeModels = require('get-bundled-sequelize-models')

// remember, the param is a glob so you can match more complex directory/subdirectory structures
const appModels = getBundledSequelizeModels('path/to/my/models/**/*.js')

Here's an example user model:

module.exports = (sequelize, DataTypes) => {
  const User = sequelize.define('User', {}, {
    tableName: 'Users'
  })

  // this will run after all models are imported, and you can reference any of
  // them through the models argument passed to this method
  User.associate = function (models) {
    // add your associations here, a few basic examples...
    models.User.hasMany(models.Posts)
    models.User.hasMany(models.Comments)
    models.Comments.belongsTo(models.User)
  }

  return User
}

Pro tip: model files can export multiple models, each with its own associations.

Here's an example user model file exporting multiple user types bound do the same database table (single table inheritance style):

module.exports = (sequelize, DataTypes) => {
  const ProviderUser = sequelize.define('ProviderUser', {}, {
    tableName: 'Users'
  })

  ProviderUser.associate = function (models) {
    models.ProviderUser.belongsTo(models.ProviderOrganization)
  }

  const CustomerUser = sequelize.define('CustomerUser', {}, {
    tableName: 'Users'
  })

  CustomerUser.associate = function (models) {
    models.CustomerUser.belongsTo(models.CustomerOrganization)
  }

  return [ProviderUser, CustomerUser]
}

So there you have it. appModels will now hold a reference to all the imported/initialized Sequelize models, so you can pass it through in any context you need them.

And don't worry if you end up calling getBundledSequelizeModels('path/to/my/models/**/*.js') multiple times in multiple places for some reason: if you call it with the same glob, you'll get the cached models that were already initialised.