https://github.com/one-com/uid-ranger
A library for parsing IMAP UID ranges
https://github.com/one-com/uid-ranger
Last synced: about 2 months ago
JSON representation
A library for parsing IMAP UID ranges
- Host: GitHub
- URL: https://github.com/one-com/uid-ranger
- Owner: One-com
- Created: 2014-09-04T09:22:34.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-09-04T09:33:10.000Z (over 10 years ago)
- Last Synced: 2025-03-24T21:03:43.308Z (about 2 months ago)
- Language: JavaScript
- Size: 133 KB
- Stars: 1
- Watchers: 14
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# uidRanger
A library for parsing IMAP UID ranges.
## Usage
```js
var uidRanger = require('uid-ranger');
var range = uidRanger.parse('5694:5696,5712,5715:5717');
expect(range.toString(), 'to equal', '5694:5696,5712,5715:5717');
expect(range.toArray(), 'to equal', [5694, 5695, 5696, 5712, 5715, 5716, 5717]);
expect(range.length(), 'to equal', 7);
expect(range.get(1), 'to equal', 5694);
expect(range.get(3), '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
```
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
});
```