mongoose-friendly-id
a simple mongoose plugin that populates .slug
when the given prop
is set.
installation
$ npm install mongoose-friendly-id
Usage
slug = require 'mongoose-friendly-id'schemaplugin slug'name' User = mongoosemodel 'User'schema user = user.name = 'Hello world'userslug #=> 'hello-world' userslugs #=> ['hello-world'] user.name = 'Beautiful world'userslug #=> 'beautiful-world' userslugs #=> ['hello-world', 'beautiful-world'] user2 = user2slug #=> ObjectId('54ffa7b0f7ce3ce55b6d8515') user2slugs #=> [ObjectId('54ffa7b0f7ce3ce55b6d8515')] UserfindByFriendlyId 'hello-world' userslug #=> 'hello-world' userslugs #=> ['hello-world', 'beautiful-world']
To use different slug candidates pass them as array
slug = require 'mongoose-friendly-id'schemaplugin slug'name''job' User = mongoosemodel 'User'schema user = name: 'Victor Kim'job: 'coffeescript programmer'userslug #=> 'victor-kim-coffeescript-programmer' userslugs #=> ['victor-kim-coffeescript-programmer']
To use different slug candidates pass them as function
slug = require 'mongoose-friendly-id'schemaplugin slug "--" if modelname and modeljob User = mongoosemodel 'User'schemauser = name: 'Victor Kim'job: 'coffeescript programmer'userslug #=> 'victor-kim--coffeescript-programmer' userslugs #=> ["victor-kim--coffeescript-programmer"]
License
MIT