node-ws-packets/types/src/Client.d.ts

A packet-based javascript websocket communitcation.

export = Client;
/**
 * Packet Manager Class
 */
declare class Client {
    /**
     * Create a new Manager instance
     * @param {object} ws websocket client
     * @param {object} options options
     */
    constructor(ws: object, { log, keepAlive }?: object);
    /**
     * Manager Public Vars
     */
    log: any;
    ws: any;
    keepAlive: any;
    /**
     * Packets
     */
    packets: {};
    /**
     * Callbacks
     */
    callbacks: {
        onError: any[];
        onConnect: any[];
        onDisconnect: any[];
        onInvalid: any[];
    };
    __keepAliveManager: IKeepAliveManager;
    /**
     * PACKET REGISTERING
     */
    /**
     * Registers a packet
     * @param {object} packet packet
     * @returns {object} packet client
     */
    addPacket(packet: object): object;
    /**
     * Removes a packet
     * @param {object} packet packet
     * @returns {object} packet client
     */
    removePacket(packet: object): object;
    /**
     * Handle incoming packets
     * @param {object} ws websocket client
     * @param {object} received received data
     * @returns
     */
    handle(received: object): void;
    /**
     * Encoding & Decoding
     */
    /**
     * Get JSON from packet
     * @param {packet} packet packet
     * @returns packet json
     */
    encode(packet: any): any;
    /**
     * Returns packet from packet data
     * @param {object} packetData
     */
    decode(packetData: object): any;
    /**
     * Utils
     */
    /**
     * The callback type for connection handling
     * @callback onConnectCallback
     * @param {object} websocketConnection
     */
    /**
     * Add Callback to new Connection, executed on new connection
     * @param {onConnectCallback} _function callback function
     * @returns {Client} client object
     */
    onConnect(_function: (websocketConnection: object) => any): Client;
    /**
     * The callback type for disconnection handling
     * @callback onDisconnectCallback
     * @param {object} websocketConnection
     * @param {object} event
     */
    /**
     * Add Callback to connection close
     * @param {onDisconnectCallback} _function callback function
     * @returns {Client} client object
     */
    onDisconnect(_function: (websocketConnection: object, event: object) => any): Client;
    /**
     * The callback type for error handling
     * @callback onErrorCallback
     * @param {object} websocketConnection
     * @param {object} error
     */
    /**
     * Add Callback to connection error
     * @param {onErrorCallback} _function callback function
     * @returns {Client} client object
     */
    onError(_function: (websocketConnection: object, error: object) => any): Client;
    /**
     * The callback type for invalid packet handling
     * @callback onInvalidCallback
     * @param {object} websocketConnection
     * @param {object} packet
     */
    /**
     * Add Callback to invalid packet error
     * @param {onInvalidCallback} _function callback function
     * @returns {Client} client object
     */
    onInvalid(_function: (websocketConnection: object, packet: object) => any): Client;
}
import IKeepAliveManager = require("./KeepAlive/IKeepAliveManager.js");