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-helpers

v0.0.3

Published

Load sequelize models from directory and easily define model relations

Downloads

3

Readme

Sequelize helpers

Set of utilities which simplify some Sequelize tasks such model loading and setting up relations between models.

Install

npm install sequelize-helpers

Usage

var sequelizeHelpers = require('sequelize-helpers')
var Sequelize = require('sequelize')


var sequelize = new Sequelize()

sequelizeHelpers.loadModels(sequelize, __dirname + '/models/*')
sequelizeHelpers.setRelations(sequelize,
  {
    User: {
      hasMany: {
        posts: { model: 'Post', /* ... */ }
      }
    },
    Post: {
      belongsTo: {
        author: { model: 'User', /* ... */  }
      }
    }
  }
)

API

#loadModels(sequelize, path)

Loads models from given paths(s) supporting node-glob patterns. You can also pass array of paths to load from more than one directory. It uses Sequelize.import(...) internally.

| param | type | description |-----------|---------------------|------------- | sequelize | {Sequelize} | Sequelize instance | path | {String|Array} | path or array of paths from where to load models (model file structure is described here)

Examples:

sequelizeHelpers.loadModels(sequelize, __dirname + '/models/*')
sequelizeHelpers.loadModels(sequelize,
  [
    __dirname + '/path1/*',
    __dirname + '/path2/*',
    __dirname + '/path3/model1.coffee',
    __dirname + '/path4/model1.js',
    __dirname + '/path5/model1.*'
  ]
)

#setRelations(sequelize, relations)

Sets up relations between models in more handy way than it is done using pure Sequelize. Structure of object describing relations is described here.

| param | type | description |-----------|-------------|------------- | sequelize | {Sequelize} | Sequelize instance | relations | {Object} | relations object (described here)

Examples:

sequelizeHelpers.loadModels(sequelize,{
  Post: {
    hasMany: {
      comments: { model: 'Comment' }
    },
    belongsTo: {
      author: { model: 'User', foreignKey: 'AuthorId' }
    },
    belongsToMany: {
      'tags': { model: 'Tag', through: 'PostTags' }
    }
  }
})

Model files

Model files must look as follows (official Sequelize example from here):

module.exports = function(sequelize, DataTypes) {
  return sequelize.define("Task", {
    name: DataTypes.STRING,
    deadline: DataTypes.DATE,
    importance: DataTypes.INTEGER
  })
}

Relations object

Relations object structure must look as follows:

{
  $model1: {
    $relationType: {
      $as: { model: $model2, /*...*/ }
    }
  }
}
/*
  sequelize.model($model1).$relationType(
    sequelize.model($model2),
    { as: $as, ... }
  )
*/
  • $model1 - name of model1
  • $relationType - type of relation (hasMany|belongsTo|hasOne|belongsToMany)
  • $as - relation alias passed in relation options
  • $model2 - name of model2 (if skipped then $as will be used as model2 name)

If for some reason you don't want to pass/use as param just leave model attribute empty:

{
  Post: {
    hasMany: {
      Comment: {} // skipping `model` attribute
    }
  }
}
/*
  sequelize.model('Post').hasMany(
    sequelize.model('Comment'),
    {}
  )
*/

Of course you can pass any additional relation options:

{
  Post: {
    hasMany: {
      comments: { model: 'Comment', foreignKey: 'PostId' }
    }
  }
}
/*
  sequelize.model('Post').hasMany(
    sequelize.model('Comment'),
    { as: 'comments', foreignKey: 'PostId' }
  )
*/