Init. Map does not function and only working on backend at the moment.
This commit is contained in:
81
node_modules/socket.io-parser/Readme.md
generated
vendored
Normal file
81
node_modules/socket.io-parser/Readme.md
generated
vendored
Normal file
@ -0,0 +1,81 @@
|
||||
|
||||
# socket.io-parser
|
||||
|
||||
[](https://github.com/socketio/socket.io-parser/actions)
|
||||
[](http://badge.fury.io/js/socket.io-parser)
|
||||
|
||||
A socket.io encoder and decoder written in JavaScript complying with version `5`
|
||||
of [socket.io-protocol](https://github.com/socketio/socket.io-protocol).
|
||||
Used by [socket.io](https://github.com/automattic/socket.io) and
|
||||
[socket.io-client](https://github.com/automattic/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](https://github.com/learnboost/socket.io-protocol).
|
||||
|
||||
## Example Usage
|
||||
|
||||
### Encoding and decoding a packet
|
||||
|
||||
```js
|
||||
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
|
||||
|
||||
```js
|
||||
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
|
Reference in New Issue
Block a user