socket.io-parser

A socket.io encoder and decoder written in JavaScript complying with version 3 of socket.io-protocol. Used by socket.io and socket.io-client.

Parser API

socket.io-parser is the reference implementation of socket.io-protocol. Read the full API here: socket.io-protocol.

Example Usage

Encoding and decoding a packet

1var parser = require('socket.io-parser');
2var encoder = new parser.Encoder();
3var packet = {
4  type: parser.EVENT,
5  data: 'test-packet',
6  id: 13
7};
8encoder.encode(packet, function(encodedPackets) {
9  var decoder = new parser.Decoder();
10  decoder.on('decoded', function(decodedPacket) {
11    // decodedPacket.type == parser.EVENT
12    // decodedPacket.data == 'test-packet'
13    // decodedPacket.id == 13
14  });
15
16  for (var i = 0; i < encodedPackets.length; i++) {
17    decoder.add(encodedPackets[i]);
18  }
19});

Encoding and decoding a packet with binary data

1var parser = require('socket.io-parser');
2var encoder = new parser.Encoder();
3var packet = {
4  type: parser.BINARY_EVENT,
5  data: {i: new Buffer(1234), j: new Blob([new ArrayBuffer(2)])}
6  id: 15
7};
8encoder.encode(packet, function(encodedPackets) {
9  var decoder = new parser.Decoder();
10  decoder.on('decoded', function(decodedPacket) {
11    // decodedPacket.type == parser.BINARY_EVENT
12    // Buffer.isBuffer(decodedPacket.data.i) == true
13    // Buffer.isBuffer(decodedPacket.data.j) == true
14    // decodedPacket.id == 15
15  });
16
17  for (var i = 0; i < encodedPackets.length; i++) {
18    decoder.add(encodedPackets[i]);
19  }
20});

See the test suite for more examples of how socket.io-parser is used.

License

MIT