Awesome

Idify

Get any unique Id format guaranteed, power by the powerfull Redis Set Data Store.

Install

Install the module with: npm install idify --save

Documentation

Initialize Idify

var idify = require('idify');

// you can configure idify inline or afterwards.
var userid = idify({
    // The prefix to use for stored keys in redis.
    prefix: 'awesomeapp',

    // The name of the id (i.e. for the user table)
    name: 'user',

    // how long do you want the id to be
    idLength: 5,

    // Safety net, idify uses recursion until a unique id is secured.
    maxLoops: 100,

    // Redis configuration
    redis: {
      port: 6379,
      host: 'localhost',
      pass: null,
      redisOptions: null, // special redis options, pass as object
      uri: 'redis://user:pass@example.com:6379', // optional URI string
    },
});

// you can setup idify after instantiation
userid.setup({/* opts */});

// a connection to redis is required before you perform any operation
userid.connect().then(function() {
    // ready to get going
}).catch(function(err) {
    // an error occured
});

Get a Unique Id

userid.get().then(function(id) {
    console.log('A 5 char Unique id guaranteed:', id);
});

Release History

• v1.0.0, 29 Jun 2016
  • Fixed issue after upgrading to redis client which had breaking changed.
  • Honorary release.
• v0.1.3, 29 Jun 2016
  • Upgraded all packages to latest.
• v0.1.2, 28 Jun 2016
  • Add support for redis URI.
• v0.1.1, 08 Apr 2015
  • Fix redis version check.
• v0.1.0, 20 Feb 2015
  • Fixed bug in recurse method.
• v0.0.1, 09 Mar 2014
  • Big Bang

License

Copyright ©Thanasis Polychronakis. Licensed under the MIT license.