Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 2.42 KB

README.md

File metadata and controls

73 lines (54 loc) · 2.42 KB
Raw

Build Status Codacy Code Climate Test Coverage

mongoose-diff-history

Stores and Manages all the differences and versions, any Mongo collection goes through it's lifecycle.

Installation

###npm

npm install mongoose-diff-history

Operation

Each update will create a history record with jsonDiff of the change. This helps in tracking all the changes happened to an object from the beginning.

Following will be the structure of the diff history being saved:

diff Collection schema:

_id : mongo id of the diff object
collectionName: Name of the collection for which diff is saved
collectionId : Mongo Id of the collection being modified
diff: diff object
user: User who modified
reason: Why the collection is modified
createdAt: When the collection is modified
_v: version

Usage

Use as you would any Mongoose plugin:

var mongoose = require('mongoose'),
    diffHistory = require('mongoose-diff-history/diffHistory'),
    schema = new mongoose.Schema({ ... });
    schema.plugin(diffHistory.plugin);

Helper Methods

You can get all the histories created for an object using following method:

var diffHistory = require('mongoose-diff-history/diffHistory');
diffHistory.getHistories(modelName, ObjectId, <expandable fields>, function (err, histories) {

}

You can get an older version of the object using following method:

var diffHistory = require('mongoose-diff-history/diffHistory');
diffHistory.getVersion(mongooseModel, ObjectId, version, function (err, oldObject) {

}

Example

I have created an example express service, demonstrating this plugin via an simple employee schema, checkout example directory in this repo.