compact2string/README.md

Convert BitTorrent compact hostname & port buffer to a string 'hostname:port'

# compact2string

Convert bittorrent's [compact](http://wiki.theory.org/BitTorrent_Tracker_Protocol#Peer_Dictionary_Format) ip/host binary returned by Trackers to 'hostname:port' string.

[![Build Status](https://travis-ci.org/bencevans/node-compact2string.png?branch=master)](https://travis-ci.org/bencevans/node-compact2string)
[![Coverage Status](https://coveralls.io/repos/bencevans/node-compact2string/badge.png?branch=master)](https://coveralls.io/r/bencevans/node-compact2string?branch=master)
[![Dependency Status](https://david-dm.org/bencevans/node-compact2string.png)](https://david-dm.org/bencevans/node-compact2string)

[![browser support](https://ci.testling.com/bencevans/node-compact2string.png)
](https://ci.testling.com/bencevans/node-compact2string)

Need the reverse of this? Checkout https://github.com/feross/string2compact

## Installation

```npm install compact2string```

## Usage

### Single compact2string	

```javascript
var compact2string = require("compact2string");
var Buffer = require("buffer").Buffer;
var ipport = compact2string(new Buffer("0A0A0A05FF80", "hex"));
console.log(ipport);
```

=> ```"10.10.10.5:65408" ```

```javascript
ipport = compact2string(new Buffer("2a03288021109f07faceb00c000000010050", "hex"));
console.log(ipport);
```

=> ```"[2a03:2880:2110:9f07:face:b00c::1]:80" ```

### Multiple in same buffer
	
```javascript
var hostports = compact2string.multi(new Buffer("0A0A0A05008064383a636f6d", "hex"));
console.log(hostports);
```

=> ```[ '10.10.10.5:128', '100.56.58.99:28525' ]```

IPv6 version: `compact2string.multi6()`

## Licence

(MIT Licence)