mongoose-human-diff-plugin v0.1.0

mongoose-human-diff-plugin

See how your documents change in human readable form

Table of Contents

• Install
• Usage
• About
• Contributors
• License

Install

npm:

npm install mongoose-human-diff-plugin

yarn:

yarn add mongoose-human-diff-plugin

Usage

const MongooseHumanDiffPlugin = require('mongoose-human-diff-plugin');
const mongoose = require('mongoose');

const MySchema = new mongoose.schema({
  ...
});

const changeCallback = diff => console.log(diff.join('\n'))

const options = {}

MySchema.plugin(mongooseHumanDiffPlugin(changeCallback), options)

About

mongoose-human-diff-plugin is a wrapper around human-object-diff

All options are directly passed to the human-object-diff library.

Use it to respond to changes in your documents.

For Example, let's say you have a User Schema where the users can change personal information. You could use mongoose-human-diff-plugin to send an email to users alerting them of the changes. Simply, add the email logic in your callback, and use the human readable changes to alert them. This could be applied to changes in schemas that you need to alert any one about!

Contributors

License

MIT © Spencer Snyder