uid-ranger/README.md

Parsing IMAP UID ranges

# uidRanger

A library for parsing IMAP UID ranges.

## Usage

```js
var uidRanger = require('uid-ranger');
var uidRange = uidRanger.parse('5694:5696,5704,5712,5715:5717');

expect(uidRange.toString(), 'to equal', '5694:5696,5704,5712,5715:5717');
expect(uidRange.toArray(), 'to equal', [5694, 5695, 5696, 5704, 5712, 5715, 5716, 5717]);
expect(uidRange.length(), 'to equal', 8);
expect(uidRange.get(1), 'to equal', 5694);
expect(uidRange.get(4), 'to equal', 5712);
```

### Node

Install it with NPM or add it to your `package.json`:

```
$ npm install uidRanger
```

Then:

```js
var uidRanger = require('uid-ranger');
```

### Browser

Include `uidRanger.js`.

```html
<script src="uidRanger.js"></script>
```

this will expose the expect function under the following namespace:

```js
var uidRanger = one.uidRanger;
```

### RequireJS

Include the library with RequireJS the following way:

```js
require.config({
    paths: {
        uidRanger: 'path/to/uidRanger'
    }
});

define(['uidRanger'], function (uidRanger) {
   // Your code
});
```