You can not select more than 25 topics
			Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
		
		
		
		
		
			|  | 8 years ago | |
|---|---|---|
| .. | ||
| node_modules/isarray | 8 years ago | |
| History.md | 8 years ago | |
| LICENSE | 8 years ago | |
| Readme.md | 8 years ago | |
| binary.js | 8 years ago | |
| index.js | 8 years ago | |
| is-buffer.js | 8 years ago | |
| package.json | 8 years ago | |
		
			
				
				Readme.md
			
		
		
	
	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
var parser = require('socket.io-parser');
var encoder = new parser.Encoder();
var packet = {
  type: parser.EVENT,
  data: 'test-packet',
  id: 13
};
encoder.encode(packet, function(encodedPackets) {
  var decoder = new parser.Decoder();
  decoder.on('decoded', function(decodedPacket) {
    // decodedPacket.type == parser.EVENT
    // decodedPacket.data == 'test-packet'
    // decodedPacket.id == 13
  });
  for (var i = 0; i < encodedPackets.length; i++) {
    decoder.add(encodedPackets[i]);
  }
});
Encoding and decoding a packet with binary data
var parser = require('socket.io-parser');
var encoder = new parser.Encoder();
var packet = {
  type: parser.BINARY_EVENT,
  data: {i: new Buffer(1234), j: new Blob([new ArrayBuffer(2)])}
  id: 15
};
encoder.encode(packet, function(encodedPackets) {
  var decoder = new parser.Decoder();
  decoder.on('decoded', function(decodedPacket) {
    // decodedPacket.type == parser.BINARY_EVENTEVENT
    // Buffer.isBuffer(decodedPacket.data.i) == true
    // Buffer.isBuffer(decodedPacket.data.j) == true
    // decodedPacket.id == 15
  });
  for (var i = 0; i < encodedPackets.length; i++) {
    decoder.add(encodedPackets[i]);
  }
});
See the test suite for more examples of how socket.io-parser is used.
License
MIT