rpc-websocketserver/dist/lib/message-handlers/simple.d.ts

Simple rpc websocket server, wrapping the very popular 'ws' library. Register your RPCs with convenient decorators.

/// <reference types="node" />
import WebSocket from 'ws';
import { HandlerResult, MessageHandler, Method } from '../interfaces';
/**
 * Minimalist message handler
 *
 * - Incoming messages must be of type string or Buffer
 * - After reading the string or Buffer, the RPC must be an object
 * - The object must have the "method" key
 * - The value of the "method" field must be of type string
 * - The object can have the "params" key (it can also be omitted)
 * <br/>
 *
 * @implements {MessageHandler}
 *
 * @example Valid message with positional parameters
 *      {
 *          "method": "sum",
 *          "params": [1, 2]
 *      }
 * @example Valid message with named parameters
 *      {
 *          "method": "sum",
 *          "params": { "b": 1, "a": 2 }
 *      }
 * @example Valid message with named parameters omitted
 *      {
 *          "method": "sum"
 *      }
 */
declare class SimpleMessageHandler implements MessageHandler {
    /**
     * Handles an incoming message
     *
     * @param message {string | Buffer} - message to be parsed, validated and evaluated
     * @param registeredMethods {Map<string, Method>} - registered namespace methods
     * @returns {HandlerResult} - result object to be processed
     */
    handle(message: string | Buffer, registeredMethods: Map<string, Method>): HandlerResult;
    /**
     * Function to process handler result. Should call rpc and return data to be sent to clients
     *
     * @param context {any} - context of the calling class to properly handle 'this' in the function call
     * @param handlerResult {HandlerResult} - handler result from same message handler
     * @returns {Promise<WebSocket.Data | undefined>}
     */
    process(context: any, handlerResult: HandlerResult): Promise<WebSocket.Data | undefined>;
}
export default SimpleMessageHandler;