Nutritious Pancake Mountain

    @skgdev/socket.io-msgpack-javascript

    1.0.1 • Public • Published

    socket.io-msgpack-parser

    An alternative to the default socket.io-parser, encoding and decoding packets with msgpack official latest javascript version msgpack-javascript

    Please note that you MUST use the parser on both sides (server & client).

    Compatibility table:

    Parser version Socket.IO server version
    1.x.x 3.x.x / 4.x.x

    Installation

    npm i @skgdev/socket.io-msgpack-javascript
    

    Usage

    const io = require('socket.io');
    const ioc = require('socket.io-client');
    const customParser = require('@skgdev/socket.io-msgpack-javascript');
    const server = io(PORT, {
      parser: customParser.build({
          encoder: ?EncoderOptions,
          decoder: ?DecoderOptions
      })
    });
    
    const socket = ioc('ws://localhost:' + PORT, {
      parser: customParser
    });
    
    socket.on('connect', () => {
      socket.emit('hello');
    });

    Format

    socket.emit('hello', 'you') will create the following packet:

    {
      "type": 2,
      "nsp": "/",
      "data": ["hello", "you"]
    }

    which will be encoded by the parser as:

    <Buffer 83 a4 74 79 70 65 02 a3 6e 73 70 a1 2f a4 64 61 74 61 92 a5 68 65 6c 6c 6f a3 79 6f 75>

    Install

    npm i @skgdev/socket.io-msgpack-javascript

    DownloadsWeekly Downloads

    208

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    6.19 kB

    Total Files

    8

    Last publish

    Collaborators

    • nmargaritis