<commit_before># Idify

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

[![Build Status](https://secure.travis-ci.org/thanpolas/idify.png?branch=master)](http://travis-ci.org/thanpolas/idify)

## Install

Install the module with: `npm install idify --save`

## Documentation


### Initialize Idify

```js
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
    },
});

// 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

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



## Release History

- **v0.1.0**, *20 Feb 2015*
    - Fixed bug in recurse method.
- **v0.0.1**, *09 Mar 2014*
    - Big Bang

## License<commit_msg>update changelog<commit_after># Idify

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

[![Build Status](https://secure.travis-ci.org/thanpolas/idify.png?branch=master)](http://travis-ci.org/thanpolas/idify)

## Install

Install the module with: `npm install idify --save`

## Documentation


### Initialize Idify

```js
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
    },
});

// 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

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



## Release History

- **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
{'fraction_non_alphanumeric': 0.14064602960969044, 'fraction_numerical': 0.0211978465679677, 'mean_word_length': 2.8862745098039215, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5117005', 'n_tokens_mistral': 1025, 'n_tokens_neox': 953, 'n_words': 342}