Plugin to allow Mongoose models to automatically create a short key as an alternative to using the id field

npm install mongoose-shortkey
3 downloads in the last week
12 downloads in the last month


A simple plugin to allow shorter, indexed IDs for Mongoose documents. Useful for REST APIs, generating sequential numbers, etc...


Initialise the plugin with the connection to your Mongo database

    var mongoose = require('mongoose'),
        shortid = require('mongoose-shortid'),
        db = mongoose.createConnection(...);


Then add to a model

    var schema = new mongoose.Schema({});
    schema.plugin(shortid.plugin, { category: 'MyModel' });

This will create a field called sid on each newly created document that contains it's sequential ID.


You can alter the field name, and the way the count is serialized through passing in additional options via the plugin call.

More details soon

npm loves you