Potato.Socket

Your internet is fast as Potato?

Use (R)Potato.Socket(tm)

WTF is this?!

Potato.Socket - is a WebSocket wrapper with built-in serialization/deserialization support backed by ProtoDef

API

|Method|Description|Example| |-|-|-| | Potato.addPacket | Adds packet to parser with schema (All ProtoDef/Rust types are supported) | potato.addPacket({a:'string',b:'u8',c:'i64'}) | | Potato.finishDeclaration | Starts ProtoDef, allows to use on/emit/RPC | | | Potato.on | Attaches a event listener | | | Potato.emit | Emits a packet to server | | | Potato.* = ...| Adds a new method to RPC (Will be awaited on call) | | | Potato.*(...params) | Calls a method on RPC (Needs to be await, since a method is really on client side) ||

Usage:

Client:

import {createPotatoSocket} from 'potato.socket';

// Wrap websocket
const socket=createPotatoSocket(new WebSocket('wss://domain.with.potato/socketUrl'));

// Add all needed packets
potato.addPacket('test',{
    a:'string'     
});

// Finish packet declaration, starts ProtoDef parser
potato.finishDeclaration();

// Add your listeners (Make sure you defined packet "test"!)
potato.on('test',(a)=>{
    console.log(a);
});

// And RPC methods!
potato.testClientMethod=(data)=>{
    return ++data;
}

// Emit data to server (Make sure you defined packet "test"!)
potato.emit('test',{
    a:'123412124'
});
await potato.testServerMethod(5); // 4

Server:

import XPress from '@meteor-it/xpress';
import {addSupport as addPotatoSupport} from '@meteor-it/xpress-support-potato';

const server=new XPress('test');

server.on('POTATO /socketUrl',(req,potato)=>{
    // Add all needed packets
    potato.addPacket('test',{
        a:'string'     
    });
    
    // Finish packet declaration, starts ProtoDef parser
    potato.finishDeclaration();
    
    // Add your listeners (Make sure you defined packet "test"!)
    potato.on('test',(a)=>{
        console.log(a);
    });
    
    // And RPC methods!
    potato.testServerMethod=(data)=>{
        return --data;
    }
    
    // Emit data to client (Make sure you defined packet "test"!)
    potato.emit('test',{
        a:'123412124'
    });
    
    await potato.testClientMethod(5); // 6
});