mongoose-id

Mongoose plugin that replaces document _id with id

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
mongoose-id
400.1.37 years ago7 years agoMinified + gzip package size for mongoose-id in KB

Readme

Mongoose id Plugin
Simple plugin for Mongoose which replaces document attribute id with id.

Installation

npm install mongoose-id

Usage

var mongoose = require('mongoose');
var idPlugin = require('mongoose-id');
var UserSchema = new mongoose.Schema({
    username: String
});
UserSchema.plugin(idPlugin);
mongoose.model('User', UserSchema);

By default, it will transform the document for both toJSON and toObject methods. You can disable any one by setting its option to false:
mongoose.plugin(idPlugin, {
  toJSON: false
});
Don't transform document for toJSON() of all schemas.
Setting options.remove to true will remove the id attribute:
UserSchema.plugin(idPlugin, {
  remove: true
});

License

The MIT License