package
socket.io protocol parser
npm install socket.io-parserGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 4 packages.
131.7 kB
Includes dependencies.
darrachequesne
damien.arrachequesne@gmail.com
~3.1.0
3.1.2
A socket.io encoder and decoder written in JavaScript complying with version 5
of socket.io-protocol.
Used by socket.io and
socket.io-client.
Compatibility table:
| Parser version | Socket.IO server version | Protocol revision |
|---|---|---|
| 3.x | 1.x / 2.x | 4 |
| 4.x | 3.x | 5 |
socket.io-parser is the reference implementation of socket.io-protocol. Read the full API here: socket.io-protocol.
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 =
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_EVENT
// Buffer.isBuffer(decodedPacket.data.i) == true
See the test suite for more examples of how socket.io-parser is used.
MIT