socket.io-parser (4.2.4)

2026-02-24T14:05:13Z

Setup this registry in your project .npmrc file:

registry=

To install the package using npm, run the following command:

npm install socket.io-parser@4.2.4

or add it to the package.json file:

"socket.io-parser": "4.2.4"

For more information on the npm registry, see the documentation.

socket.io-parser

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

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_EVENT
    // 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

Dependencies

ID	Version
@socket.io/component-emitter	~3.1.0
debug	~4.3.1

Development Dependencies

ID	Version
@babel/core	~7.9.6
@babel/preset-env	~7.9.6
@babel/register	^7.18.9
@types/debug	^4.1.5
@types/node	^14.11.1
@wdio/cli	^7.26.0
@wdio/local-runner	^7.26.0
@wdio/mocha-framework	^7.26.0
@wdio/sauce-service	^7.26.0
@wdio/spec-reporter	^7.26.0
benchmark	2.1.2
expect.js	0.3.1
mocha	^10.1.0
prettier	^2.1.2
rimraf	^3.0.2
typescript	^4.0.3
wdio-geckodriver-service	^4.0.0

Details

npm

2026-02-24 14:05:13 +00:00

1

Project Site

MIT

latest

7.5 KiB

Assets (1)

socket.io-parser-4.2.4.tgz 7.5 KiB

Versions (1) View all

4.2.4

2026-02-24