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

v0.0.1

Published

A plugin for adding a log book / revision history / audit / paper trail to a sequelize model.

Downloads

8

Readme

Sequelize-Logbook

A plugin for adding a log book / revision history / audit / paper trail to a sequelize model.

🎛 Usage

When using the models/index.js associate pattern:

my-model.js

const trackRevisions = require('sequelize-logbook')

module.exports = function(sequelize, DataTypes) {
  let MyModel = sequelize.define('MyModel', {
    ...
    classMethods: {
      ...
      associate: function(){
        ...
        trackRevisions(MyModel)
      }
    }
  })
}

General use

const trackRevisions = require('sequelize-logbook')

let MyModel = sequelize.define('MyModel', {...})
let AnotherModel = sequelize.define('AnotherModel', {...})
trackRevisions(MyModel)
trackRevisions(AnotherModel)

🐲 whoDunnit / blame / author tracking.

SequelizeRevisions will look against the global sequelize object for a whoDunnit key. If this key is present, it will save this value as the author of the revision. Otherwise, it'll fall back to process.env.NODE_ENV

const sequelize = new Sequelize(db, user, password, config)
sequelize.whoDunnit = 'yourUserString'

⚠ Caveats

Revisions will not be automatically generated for instances created, deleted, or updated with Bulk actions If you want revisions generated for Bulk actions, pass individualHooks: true as a sequelize option.

🏗 Contributing contributions welcome

📐 Tests

npm run test

✂ Linting

npm run prettier

✨ Inspired by

Related:

This library is similar to these other packages, with the addition of:

  1. whoDunnit / blame history
  2. Unit tests! 📏

License

Sequelize-logbook is MIT licensed.